API Documentation
    Preparing search index...

    Interface ComponentInstance<InstanceType>

    Components are instances of JavaScript objects that are created and managed by the app runtime as needed.

    interface ComponentInstance<InstanceType extends ServiceInstance> {
        dispose(): void;
        getInstance(): InstanceType | undefined;
    }

    Type Parameters

    Index

    Methods

    • Dispose of the component configuration for this component instance. The component configuration will be deactivated. If the component configuration has already been deactivated, this method does nothing.

      Returns void

    • Returns the component instance of the activated component configuration.

      Returns InstanceType | undefined

      The component instance or undefined if the component configuration has been deactivated.