Skip to main content
Version: 4.5

Class: CLIHelper#

cli.CLIHelper

Constructors#

constructor#

+ new CLIHelper(): CLIHelper

Returns: CLIHelper

Methods#

dump#

Staticdump(text: string, config?: Configuration<IDatabaseDriver<Connection>>): void

Parameters:#

NameType
textstring
config?Configuration<IDatabaseDriver<Connection>>

Returns: void

Defined in: packages/cli/src/CLIHelper.ts:42


dumpDependencies#

StaticdumpDependencies(): Promise<void>

Returns: Promise<void>

Defined in: packages/cli/src/CLIHelper.ts:55


dumpTable#

StaticdumpTable(options: { columns: string[] ; empty: string ; rows: string[][] }): void

Parameters:#

NameType
optionsobject
options.columnsstring[]
options.emptystring
options.rowsstring[][]

Returns: void

Defined in: packages/cli/src/CLIHelper.ts:83


getConfigPaths#

StaticgetConfigPaths(): Promise<string[]>

Returns: Promise<string[]>

Defined in: packages/cli/src/CLIHelper.ts:51


getConfiguration#

StaticgetConfiguration<D>(validate?: boolean, options?: Partial<Options<IDatabaseDriver<Connection>>>): Promise<Configuration<D>>

Type parameters:#

NameTypeDefault
DIDatabaseDriver<Connection, D>IDatabaseDriver<Connection>

Parameters:#

NameTypeDefault value
validatebooleantrue
optionsPartial<Options<IDatabaseDriver<Connection>>>-

Returns: Promise<Configuration<D>>

Defined in: packages/cli/src/CLIHelper.ts:9


getDriverDependencies#

StaticgetDriverDependencies(): Promise<string[]>

Returns: Promise<string[]>

Defined in: packages/cli/src/CLIHelper.ts:33


getModuleVersion#

StaticgetModuleVersion(name: string): Promise<string>

Parameters:#

NameType
namestring

Returns: Promise<string>

Defined in: packages/cli/src/CLIHelper.ts:74


getNodeVersion#

StaticgetNodeVersion(): string

Returns: string

Defined in: packages/cli/src/CLIHelper.ts:29


getORM#

StaticgetORM(warnWhenNoEntities?: boolean, opts?: Partial<Options<IDatabaseDriver<Connection>>>): Promise<MikroORM<IDatabaseDriver<Connection>>>

Parameters:#

NameType
warnWhenNoEntities?boolean
optsPartial<Options<IDatabaseDriver<Connection>>>

Returns: Promise<MikroORM<IDatabaseDriver<Connection>>>

Defined in: packages/cli/src/CLIHelper.ts:13

Last updated on by Renovate Bot