types.nope.IClassDescription - ZeMA-gGmbH/NoPE-JS GitHub Wiki
Interface: IClassDescription
Properties
description
description: IClassDescriptor<INopeModule>
Descriptor of the class
settings
settings: Object
Settings used for the creator.
Type declaration
| Name | Type | Description |
|---|---|---|
allowInstanceGeneration? |
boolean |
You can prevent creating instances. Defaults to true |
maxAmountOfInstance? |
number |
Max amount, of instances, that are allowed to be created by the local dispatcher. (This is only used for hosting.) |
ui
Optional ui: Object
UI Related Methods.
Type declaration
| Name | Type | Description |
|---|---|---|
config? |
TRenderInstancePage<INopeModule, {}> |
Specialized config view. |
creator? |
TInstanceManagerPage<INopeModule, {}> |
Creates a a custom function used for rendering the creator function. This wont be used if a creatorSchema is provided. |
creatorSchema? |
{ order: (item: { [index: string]: any; }) => any[] ; schema: IJsonSchema } |
Helper to simply creation of a creator interface. Uses the the schema to create the ui. |
creatorSchema.order |
(item: { [index: string]: any; }) => any[] |
Function used sort the inputs given by the schema. |
creatorSchema.schema |
IJsonSchema |
Schema for the init method. |
icon? |
string |
Helper to get the Icon, it must be available under 'assets/icons/{icon}.png'. Just enter the name |