Interface IClassDescription

Hierarchy

  • IClassDescription

Properties

description settings ui?

Properties

description

description: IClassDescriptor<INopeModule>

Descriptor of the class

settings

settings: {
    allowInstanceGeneration?: boolean;
    maxAmountOfInstance?: number;
}

Settings used for the creator.

Type declaration

  • Optional allowInstanceGeneration?: boolean

    You can prevent creating instances. Defaults to true

  • Optional maxAmountOfInstance?: number

    Max amount, of instances, that are allowed to be created by the local dispatcher. (This is only used for hosting.)

Optional ui

ui?: {
    config?: TRenderInstancePage<INopeModule, {}>;
    creator?: TInstanceManagerPage<INopeModule, {}>;
    creatorSchema?: {
        order: ((item) => any[]);
        schema: IJsonSchema;
    };
    icon?: string;
}

UI Related Methods.

Type declaration

  • Optional config?: TRenderInstancePage<INopeModule, {}>

    Specialized config view.

  • Optional creator?: TInstanceManagerPage<INopeModule, {}>

    Creates a a custom function used for rendering the creator function. This wont be used if a creatorSchema is provided.

  • Optional creatorSchema?: {
        order: ((item) => any[]);
        schema: IJsonSchema;
    }

    Helper to simply creation of a creator interface. Uses the the schema to create the ui.

    • order: ((item) => any[])
        • (item): any[]

        • Function used sort the inputs given by the schema.

          Returns

          Parameters

          • item: {
                [index: string]: any;
            }
            • [index: string]: any

          Returns any[]

    • schema: IJsonSchema

      Schema for the init method.

  • Optional icon?: string

    Helper to get the Icon, it must be available under 'assets/icons/{icon}.png'. Just enter the name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc