Interface InputBindingPlugin<In, Ex, P>

An input binding plugin interface.

Type Parameters

  • In

    The type of the internal value.

  • Ex

    The type of the external value. It will be provided by users.

  • P extends BaseInputParams

    The type of the parameters.

Hierarchy

Properties

accept api? binding controller core? id type

Properties

accept

accept: ((exValue: unknown, params: Record<string, unknown>) => null | Acceptance<Ex, P>)

Type declaration

    • (exValue: unknown, params: Record<string, unknown>): null | Acceptance<Ex, P>

    • Decides whether the plugin accepts the provided value and the parameters.

      Parameters

      • exValue: unknown
      • params: Record<string, unknown>

      Returns null | Acceptance<Ex, P>

Optional api

api?: ((args: ApiArguments) => null | InputBindingApi<In, Ex>)

Type declaration

binding

binding: {
    constraint?: ((args: BindingArguments<Ex, P>) => Constraint<In>);
    equals?: ((v1: In, v2: In) => boolean);
    reader: ((args: BindingArguments<Ex, P>) => BindingReader<In>);
    writer: ((args: BindingArguments<Ex, P>) => BindingWriter<In>);
}

Configurations of the binding.

Type declaration

controller

controller: ((args: ControllerArguments<In, Ex, P>) => ValueController<In, View, Value<In>>)

Type declaration

Optional core

core?: Semver

The version of the core used for this plugin.

id

id: string

The identifier of the plugin.

type

type: "input"

The type of the plugin.

Settings

Member Visibility

Theme

Generated using TypeDoc