Documentation
    Preparing search index...

    Type Alias InstancingOptions

    type InstancingOptions = {
        onConfigError?: (name: string, error: unknown) => never | void;
        onInstancingError?: (name: string, error: unknown) => never | void;
    }
    Index

    Properties

    onConfigError? onInstancingError?

    Properties

    onConfigError?: (name: string, error: unknown) => never | void

    What to do when the options could not be validated against the schema. You can either throw an error to stop the instancing process, or return void to skip the plugin.

    Type declaration

      • (name: string, error: unknown): never | void

      • Parameters

        • name: string

          The name of the plugin that failed to validate.

        • error: unknown

          The error that was thrown during validation.

        Returns never | void

        void to skip the plugin, or throw an error to stop the instancing process.

    onInstancingError?: (name: string, error: unknown) => never | void

    What to do when the plugin throws an error during instancing. You can either throw an error to stop the instancing process, or return void to skip the plugin.

    Type declaration

      • (name: string, error: unknown): never | void

      • Parameters

        • name: string

          The name of the plugin that failed to instantiate.

        • error: unknown

          The error that was thrown during instancing.

        Returns never | void

        void to skip the plugin, or throw an error to stop the instancing process.

    Settings

    Member Visibility

    On This Page

    Properties