Variable ComponentDef

Type declaration

• define:function

  • define<TClass>(this: void, componentType: TClass, ...defs: (QualifiedName | ComponentDef<InstanceType<TClass>>)[]): TClass

  • Defines a component.

    Either assigns new or extends existing component definition and stores it under ComponentDef__symbol key.

    Each component can be passed directly to bootstrapComponents function or added as a requirement of another feature.

    Returns

    The type instance.

    Type Parameters

    • TClass extends ComponentClass<any, TClass>

      A type of component class.

    Parameters

    • this: void

    • componentType: TClass

      Component class constructor.

    • Rest ...defs: (QualifiedName | ComponentDef<InstanceType<TClass>>)[]

      Component definitions.

    Returns TClass

• merge:function

  • merge<T>(this: void, ...defs: (QualifiedName | ComponentDef<T>)[]): ComponentDef<T>

  • Merges multiple component definition options.

    Returns

    Merged component definition options.

    Type Parameters

    • T extends object

      A type of component.

    Parameters

    • this: void

    • Rest ...defs: (QualifiedName | ComponentDef<T>)[]

      Component definition options to merge.

    Returns ComponentDef<T>

• of:function

  • of<T>(this: void, componentType: ComponentClass<T>): ComponentDef<T>

  • Extracts component definition options from its type.

    Returns

    Component definition options. May be empty if there is not definition attached to component type.

    Type Parameters

    • T extends object

      A type of component.

    Parameters

    • this: void

    • componentType: ComponentClass<T>

      Target component class constructor.

    Returns ComponentDef<T>