ui - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Namespace: ui

Interfaces

Variables

DEFAULT_SETTINGS

Const DEFAULT_SETTINGS: UploadArgs

Functions

convertInstanceRenderPage

convertInstanceRenderPage<I>(callback): string

Converts the convertInstanceRenderPage to a string, which could be store or something similar.

Export

Type parameters

Name Type Description
I extends INopeModule The Instance Type

Parameters

Name Type Description
callback TRenderInstancePage<I & IGenericNopeModule, {}> The callback to stringify.

Returns

string

The parsed String.


main

main(additionalArguments?, forcedArgs?): Promise<void>

Main Function.

Export

Parameters

Name Type Default value
additionalArguments { defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] []
forcedArgs Partial<UploadArgs> {}

Returns

Promise<void>


readInArgs

readInArgs(additionalArguments?, forcedArgs?): Promise<UploadArgs>

Helper Function to Read-In the Arguments used by the cli-tool

Parameters

Name Type Default value
additionalArguments { defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] []
forcedArgs Partial<UploadArgs> {}

Returns

Promise<UploadArgs>


readInWriteUiFileArgs

readInWriteUiFileArgs(additionalArguments?): Object

Helper to extract the Arguments for the writeUiFile function

See

writeUiFile

Author

M.Karkowski

Export

Parameters

Name Type Default value Description
additionalArguments { defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] [] Arguments added by the nope.cli

Returns

Object

The Arguments

Name Type
dir string
filename string

uploadUi

uploadUi(args): Promise<void>

Parameters

Name Type
args Partial<UploadArgs>

Returns

Promise<void>


writeUiFile

writeUiFile(options?): Promise<void>

Helper Function to write a default configuration.

Parameters

Name Type
options Object
options.dir string
options.filename string

Returns

Promise<void>

⚠️ **GitHub.com Fallback** ⚠️