Interface MonitorBindingPlugin<T, P>

A monitor binding plugin interface.

Type Parameters

T

The type of the value.
P extends BaseMonitorParams

The type of the parameters.

Hierarchy

BasePlugin
- MonitorBindingPlugin

Index

Properties

accept api? binding controller core? id type

Properties

accept

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

Type declaration

- (exValue: unknown, params: Record<string, unknown>): null | Acceptance<T, P>
- Returns
  A typed value if the plugin accepts the input, or null if the plugin sees them off and pass them to the next plugin.
  Parameters
  - exValue: unknown
    
    The value input by users.
  - params: Record<string, unknown>
    
    The additional parameters specified by users.
  Returns null | Acceptance<T, P>

`Optional` api

api?: ((args: ApiArguments) => null | MonitorBindingApi<T>)

Type declaration

- (args: ApiArguments): null | MonitorBindingApi<T>
- Creates a custom API for the plugin if available.
  Parameters
  - args: ApiArguments
  Returns null | MonitorBindingApi<T>

binding

binding: {
defaultBufferSize?: ((params: P) => number);
reader: ((args: BindingArguments<T, P>) => BindingReader<T>);
}

Configurations of the binding.

Type declaration

Optional defaultBufferSize?: ((params: P) => number)
- - (params: P): number
  - Determinates the default buffer size of the plugin.
    Parameters
    - params: P
    Returns number
reader: ((args: BindingArguments<T, P>) => BindingReader<T>)
- - (args: BindingArguments<T, P>): BindingReader<T>
  - Creates a value reader from the user input.
    Parameters
    - args: BindingArguments<T, P>
    Returns BindingReader<T>

controller

controller: ((args: ControllerArguments<T, P>) => BufferedValueController<T>)

Type declaration

- (args: ControllerArguments<T, P>): BufferedValueController<T>
- Creates a custom controller for the plugin.
  Parameters
  - args: ControllerArguments<T, P>
  Returns BufferedValueController<T>

`Optional` core

core?: Semver

The version of the core used for this plugin.

id

id: string

The identifier of the plugin.

type

type: "monitor"

The type of the plugin.

Generated using TypeDoc