Interface IEditorExtensionFactory<T>

Editor extension factory interface.

interface IEditorExtensionFactory<T = undefined> {
    default?: T;
    factory: (
        options: IEditorExtensionFactory.IOptions,
    ) => null | IConfigurableExtension<T>;
    name: string;
    schema?: ReadonlyJSONObject;
}

Type Parameters

  • T = undefined

    Extension parameter type.

Properties

default? factory name schema?

Properties

Optional Readonlydefault

default?: T

Extension default value

Notes

If undefined but has a schema, the default value will be null to be JSON serializable.

Readonlyfactory

factory: (
    options: IEditorExtensionFactory.IOptions,
) => null | IConfigurableExtension<T>

Extension factory.

Type declaration

Readonlyname

name: string

Editor extension unique identifier.

Optional Readonlyschema

schema?: ReadonlyJSONObject

JSON schema defining the configurable option through user settings.

If this is defined, every time the setting changes, IConfigurableExtension.reconfigure will be called with the new setting value.

Notes

If no default value is provided, IEditorExtensionFactory.default will be used. If the extension is to be handled by the code only, this should not be defined.

Settings

Member Visibility

On This Page

Properties