ProjectClient

@tsed/cli

Usage

import { ProjectClient } from "@tsed/cli";

See /packages/cli/src/services/ProjectClient.ts.

Overview

class ProjectClient extends Project {
    readonly pkg: ProjectPackageJson;
    readonly fs: CliFs;
    readonly dockerCompose: CliDockerComposeYaml;
    rootDir: string;
    constructor({ rootDir, ...options }: ProjectOptions & {
        rootDir: string;
    });
    get srcDir(): string;
    get serverSourceFile(): SourceFile | undefined;
    get configSourceFile(): SourceFile | undefined;
    get indexSourceFile(): SourceFile | undefined;
    get binSourceFile(): SourceFile | undefined;
    get serverName(): string;
    getSource(path: string): SourceFile | undefined;
    createSource(path: string, sourceFileText?: string | OptionalKind<SourceFileStructure> | WriterFunction, options?: SourceFileCreateOptions): Promise<SourceFile | undefined>;
    findClassDecorator(sourceFile: SourceFile, name: string): import("ts-morph").Decorator | undefined;
    addMountPath(path: string, specifier: string): void;
    addNamespaceImport(sourceFile: SourceFile, moduleSpecifier: string, name: string): import("ts-morph").Identifier | undefined;
    findConfiguration(kind: "server" | "config" | "bin"): ObjectLiteralExpression | undefined;
    getPropertyAssignment<TKind extends SyntaxKind>(input: ObjectLiteralExpression, { name, initializer, kind }: {
        name: string;
        initializer: string | WriterFunction;
        kind: TKind;
    }): KindToNodeMappings[TKind];
    getPropertyAssignment<TKind extends SyntaxKind>(input: ObjectLiteralExpression, { name, initializer, kind }: {
        name: string;
        initializer?: string | WriterFunction;
        kind: TKind;
    }): KindToNodeMappings[TKind] | undefined;
    addConfigSource(name: string, { content, moduleSpecifier }: {
        content?: string;
        moduleSpecifier: string;
    }): void;
    protected findConfigurationDecorationOptions(): ObjectLiteralExpression | undefined;
    protected findConfigConfiguration(): ObjectLiteralExpression | undefined;
    protected findBinConfiguration(): ObjectLiteralExpression | undefined;
}

readonly pkg

readonly pkg: ProjectPackageJson;

readonly fs

readonly fs: CliFs;

readonly dockerCompose

readonly dockerCompose: CliDockerComposeYaml;

rootDir

rootDir: string;

get srcDir

get srcDir(): string;

get serverSourceFile

get serverSourceFile(): SourceFile | undefined;

get configSourceFile

get configSourceFile(): SourceFile | undefined;

get indexSourceFile

get indexSourceFile(): SourceFile | undefined;

get binSourceFile

get binSourceFile(): SourceFile | undefined;

get serverName

get serverName(): string;

getSource

getSource(path: string): SourceFile | undefined;

createSource

createSource(path: string, sourceFileText?: string | OptionalKind<SourceFileStructure> | WriterFunction, options?: SourceFileCreateOptions): Promise<SourceFile | undefined>;

findClassDecorator

findClassDecorator(sourceFile: SourceFile, name: string): import("ts-morph").Decorator | undefined;

addMountPath

addMountPath(path: string, specifier: string): void;

addNamespaceImport

addNamespaceImport(sourceFile: SourceFile, moduleSpecifier: string, name: string): import("ts-morph").Identifier | undefined;

findConfiguration

findConfiguration(kind: "server" | "config" | "bin"): ObjectLiteralExpression | undefined;

getPropertyAssignment

getPropertyAssignment<TKind extends SyntaxKind>(input: ObjectLiteralExpression, { name, initializer, kind }: {
     name: string;
     initializer: string | WriterFunction;
     kind: TKind;
 }): KindToNodeMappings[TKind];

getPropertyAssignment

getPropertyAssignment<TKind extends SyntaxKind>(input: ObjectLiteralExpression, { name, initializer, kind }: {
     name: string;
     initializer?: string | WriterFunction;
     kind: TKind;
 }): KindToNodeMappings[TKind] | undefined;

addConfigSource

addConfigSource(name: string, { content, moduleSpecifier }: {
     content?: string;
     moduleSpecifier: string;
 }): void;

protected findConfigurationDecorationOptions

protected findConfigurationDecorationOptions(): ObjectLiteralExpression | undefined;

protected findConfigConfiguration

protected findConfigConfiguration(): ObjectLiteralExpression | undefined;

protected findBinConfiguration

protected findBinConfiguration(): ObjectLiteralExpression | undefined;