ui - ZeMA-gGmbH/NoPE-JS GitHub Wiki
Const DEFAULT_SETTINGS: UploadArgs
convertInstanceRenderPage<I>(callback): string
Converts the convertInstanceRenderPage to a string, which could be store or something similar.
Export
| Name | Type | Description |
|---|---|---|
I |
extends INopeModule
|
The Instance Type |
| Name | Type | Description |
|---|---|---|
callback |
TRenderInstancePage<I & IGenericNopeModule, {}> |
The callback to stringify. |
string
The parsed String.
main(additionalArguments?, forcedArgs?): Promise<void>
Main Function.
Export
| Name | Type | Default value |
|---|---|---|
additionalArguments |
{ defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] |
[] |
forcedArgs |
Partial<UploadArgs> |
{} |
Promise<void>
readInArgs(additionalArguments?, forcedArgs?): Promise<UploadArgs>
Helper Function to Read-In the Arguments used by the cli-tool
| Name | Type | Default value |
|---|---|---|
additionalArguments |
{ defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] |
[] |
forcedArgs |
Partial<UploadArgs> |
{} |
Promise<UploadArgs>
readInWriteUiFileArgs(additionalArguments?): Object
Helper to extract the Arguments for the writeUiFile function
See
writeUiFile
Author
M.Karkowski
Export
| Name | Type | Default value | Description |
|---|---|---|---|
additionalArguments |
{ defaultValue?: any ; help: string ; name: string ; type: "string" | "number" }[] |
[] |
Arguments added by the nope.cli |
Object
The Arguments
| Name | Type |
|---|---|
dir |
string |
filename |
string |
uploadUi(args): Promise<void>
| Name | Type |
|---|---|
args |
Partial<UploadArgs> |
Promise<void>
writeUiFile(options?): Promise<void>
Helper Function to write a default configuration.
| Name | Type |
|---|---|
options |
Object |
options.dir |
string |
options.filename |
string |
Promise<void>