Member Junction
    Preparing search index...

    Interface ComponentTypeProperty

    Defines a single property within a ComponentTypeDefinition

    interface ComponentTypeProperty {
        allowedValues?: (string | number | boolean)[];
        constraints?: PropertyConstraint[];
        defaultValue?: any;
        description?: string;
        required: boolean;
        signature?: string;
        type: string;
    }
    Index

    Properties

    allowedValues? constraints? defaultValue? description? required signature? type

    Properties

    allowedValues?: (string | number | boolean)[]

    For enum-like properties, the allowed values

    constraints?: PropertyConstraint[]

    Additional constraints on this property value (applied when validating object literals)

    defaultValue?: any

    Default value if the property is omitted

    description?: string

    Human-readable description of this property

    required: boolean

    Whether this property is required (linter reports error if missing from object literal)

    signature?: string

    For function types, the signature string (currently documentation-only, not validated)

    type: string

    Property type (primitives, objects, arrays, unions, functions, or custom type names)

    Settings

    Member Visibility

    On This Page

    Properties