Class XUtil

Index

Constructors

Methods

camelToSnakeCase createFolderBulk createFolderIfNotExist downloadFile entityRelation entityRelationColumn exec getEntityNames getTimeStamp numPrint removeFolderIfExist setupEnvironment sleep workerFactoryFromArray workerFactoryWithProducer workerFc

Constructors

constructor

new XUtil(): XUtil
Returns XUtil

Methods

`Static`camelToSnakeCase

camelToSnakeCase(str: string): string
Convert Camel case string to snake case
Parameters
- str: string
Returns string
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:32

`Static`createFolderBulk

createFolderBulk(...path: string[]): boolean
Parameters
- ...path: string[]
Returns boolean
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:26

`Static`createFolderIfNotExist

createFolderIfNotExist(path: string): boolean
Parameters
- path: string
Returns boolean
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:27

`Static`downloadFile

downloadFile(
    url: string,
    path: string,
    extMap?: Map<string, string>,
): Promise<null | { name: string; size: number; type: string }>
Parameters
- url: string
- path: string
- OptionalextMap: Map<string, string>
Returns Promise<null | { name: string; size: number; type: string }>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:46

`Static`entityRelation

entityRelation<T extends CoreEntity>(
entity: T,
schema?: string,
): { key: string; relation: string; schema: undefined | string }
Type Parameters
- T extends CoreEntity
Parameters
- entity: T
- Optionalschema: string
Returns { key: string; relation: string; schema: undefined | string }
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:33

`Static`entityRelationColumn

entityRelationColumn<T extends CoreEntity>(
entity: T,
schema?: string,
): ColumnProps
Type Parameters
- T extends CoreEntity
Parameters
- entity: T
- Optionalschema: string
Returns ColumnProps
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:38

`Static`exec

exec(
    cmd: string,
    args?: string[],
    options?: ExecutableOptions,
): Promise<XExecResult>
Parameters
- cmd: string
- Optionalargs: string[]
- Optionaloptions: ExecutableOptions
Returns Promise<XExecResult>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:45

`Static`getEntityNames

getEntityNames(entity: IEntity): ClassNameInterface
getTableName by entity
Parameters
- entity: IEntity
Returns ClassNameInterface
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:43

`Static`getTimeStamp

getTimeStamp(): string
Returns string
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:22

`Static`numPrint

numPrint(num: number): string
Parameters
- num: number
Returns string
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:21

`Static`removeFolderIfExist

removeFolderIfExist(path: string): boolean
Parameters
- path: string
Returns boolean
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:28

`Static`setupEnvironment

setupEnvironment(
    basePath: string[],
    config: string[],
    other?: string[],
): string[]
Parameters
- basePath: string[]
- config: string[]
- Optionalother: string[]
Returns string[]
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:44

`Static`sleep

sleep(ms: number): Promise<unknown>
Parameters
- ms: number
Returns Promise<unknown>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:20

`Static`workerFactoryFromArray

workerFactoryFromArray<X, F>(
    count: number,
    arr: X[],
    mapper: (arg: WDat<X>) => Promise<WDat<F>>,
): Promise<F[]>
Type Parameters
- X
- F
Parameters
- count: number
- arr: X[]
- mapper: (arg: WDat<X>) => Promise<WDat<F>>
Returns Promise<F[]>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:25

`Static`workerFactoryWithProducer

workerFactoryWithProducer<T, F>(
    count: number,
    producer: () => Promise<null | WDat<T>>,
    consumer: (arg: WDat<T>) => Promise<WDat<F>>,
): Promise<F[]>
Type Parameters
- T
- F
Parameters
- count: number
- producer: () => Promise<null | WDat<T>>
- consumer: (arg: WDat<T>) => Promise<WDat<F>>
Returns Promise<F[]>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:24

`Static`workerFc

workerFc<T, F>(
    producer: () => Promise<null | WDat<T>>,
    consumer: (arg: WDat<T>) => Promise<WDat<F>>,
    oMap: Map<number, F>,
): Promise<void>
Type Parameters
- T
- F
Parameters
- producer: () => Promise<null | WDat<T>>
- consumer: (arg: WDat<T>) => Promise<WDat<F>>
- oMap: Map<number, F>
Returns Promise<void>
- Defined in node_modules/@grandlinex/core/dist/mjs/utils/XUtil.d.ts:23