Interface BaseBinderBuilder

The base interface for building bindings (what we call in Interacto a binder).

interface BaseBinderBuilder {
    catch(fn): BaseBinderBuilder;
    configureRules(ruleName, severity): BaseBinderBuilder;
    end(fn): BaseBinderBuilder;
    log(...level): BaseBinderBuilder;
    name(name): BaseBinderBuilder;
    on<W>(widget, ...widgets): BaseBinderBuilder;
    onDynamic(node): BaseBinderBuilder;
    preventDefault(): BaseBinderBuilder;
    stopImmediatePropagation(): BaseBinderBuilder;
    when(fn, mode?): BaseBinderBuilder;
}

Hierarchy

Methods

catch configureRules end log name on onDynamic preventDefault stopImmediatePropagation when

Methods

catch

  • catch(fn): BaseBinderBuilder

  • Allows the processing of errors during the execution of the binding. Errors reported here are errors thrown in arrow functions provided to the the different routines of the binder and errors triggered by the command. A binder can have several cummulative 'catch' routines.

    Parameters

    • fn: ((ex) => void)

      The function to process the error caught by the binding during its execution

        • (ex): void

        • Parameters

          • ex: unknown

          Returns void

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

configureRules

end

  • end(fn): BaseBinderBuilder

  • Defines actions to perform when a binding ends. A binder can have several cummulative 'end' routines.

    Parameters

    • fn: (() => void)

      The command to execute on each binding end.

        • (): void

        • Returns void

    Returns BaseBinderBuilder

    A clone of the current builder to chain the building configuration.

log

  • log(...level): BaseBinderBuilder

  • Specifies the logging level to use. A binder can have several cummulative 'log' routines, eg: log(LogLevel.INTERACTION).log(LogLevel.COMMAND)

    Parameters

    • Rest ...level: readonly LogLevel[]

      The logging level to use.

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

name

  • name(name): BaseBinderBuilder

  • Specifies the name of the Interacto binding. This name will be used in the logging system. It should be unique, but no mechanism will check that.

    Parameters

    • name: string

      The name of the binding

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

on

  • on<W>(widget, ...widgets): BaseBinderBuilder

  • Specifies the widgets on which the binding will operate. When a widget is added to this list, this widget is binded to this binding. When widget is removed from this list, this widget is unbinded from this binding.

    Type Parameters

    • W

    Parameters

    • widget: Widget<W> | readonly Widget<W>[]

      The mandatory first widget

    • Rest ...widgets: readonly Widget<W>[]

      The list of the widgets involved in the bindings.

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

onDynamic

  • onDynamic(node): BaseBinderBuilder

  • Specifies the node the binding will observe its children. The binding observes its children list, so that additions and removals from it are managed by the binding.

    Parameters

    • node: Widget<Node>

      The binding will observe the children of this node.

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

preventDefault

stopImmediatePropagation

when

  • when(fn, mode?): BaseBinderBuilder

  • Specifies the conditions to fulfill to initialise, update, or execute the command while the interaction is running. A binder can have several cummulative 'when' routines.

    Parameters

    • fn: (() => boolean)

      The predicate that checks whether the command can be initialised, updated, or executed.

        • (): boolean

        • Returns boolean

    • Optional mode: WhenType

      The execution mode of the 'when' predicate. If not defined, the non-strict mode will be used.

    Returns BaseBinderBuilder

    A clone of the current binder to chain the building configuration.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc