Interface ExtensionExecutorOptions

Options for an object that performs extensions of the specified type IExtensionExecutor.

interface ExtensionExecutorOptions {
    extensionsFilter?:
        | null
        | <E extends Extension<ExtensionContext>>(
            extensions: readonly IExtensionInstance<E>[],
        ) => IExtensionInstance<E>[];
    extensionsSort?:
        | null
        | <E extends Extension<ExtensionContext>>(
            instances: IExtensionInstance<E>[],
        ) => void;
    processError?: (result: ValidationResult) => Promise<void>;
    throwIfAsyncMethodCalledSynchronously?: boolean;
    trace?: boolean;
    traceFilterExtensionTypes?: null | string[];
    useCancellationContext?: boolean;
}

Properties

extensionsFilter? extensionsSort? processError? throwIfAsyncMethodCalledSynchronously? trace? traceFilterExtensionTypes? useCancellationContext?

Properties

OptionalextensionsFilter

extensionsFilter?:
    | null
    | <E extends Extension<ExtensionContext>>(
        extensions: readonly IExtensionInstance<E>[],
    ) => IExtensionInstance<E>[]

Filters the final list of extensions when resolving.

OptionalextensionsSort

extensionsSort?:
    | null
    | <E extends Extension<ExtensionContext>>(
        instances: IExtensionInstance<E>[],
    ) => void

Sorts the final list of extensions when resolving.

OptionalprocessError

processError?: (result: ValidationResult) => Promise<void>

An error handler that occurs when executing extension chains.

OptionalthrowIfAsyncMethodCalledSynchronously

throwIfAsyncMethodCalledSynchronously?: boolean

If the flag is set, then an exception will be thrown if the asynchronous extension method is called synchronously.

Optionaltrace

trace?: boolean

Enables extension execution tracing.

OptionaltraceFilterExtensionTypes

traceFilterExtensionTypes?: null | string[]

Types of extensions that should be included in the trace.

OptionaluseCancellationContext

useCancellationContext?: boolean

Indicates the need to use cancellation context to track cancellations.

Settings

Member Visibility

On This Page

Properties