turbodombuilder - v0.9.48
    Preparing search index...

    Type Alias SubstrateCallbackProperties

    Type representing objects passed as context for resolving substrates. Given as first parameter to solvers when executing them via solveSubstrate.

    type SubstrateCallbackProperties = {
        substrate?: string;
        substrateHost?: object;
        target?: object;
        event?: Event;
        eventType?: string;
        eventTarget?: Node;
        toolName?: string;
        eventOptions?: ListenerOptions;
        manager?: TurboEventManager;
    }
    Index

    Properties

    substrate?: string

    The targeted substrate. Defaults to currentSubstrate.

    substrateHost?: object

    The object to which the target substrate is attached.

    target?: object

    The current object being processed by the solver. Property set by solveSubstrate when processing every object in the substrate's list.

    event?: Event

    The event (if any) that fired the resolving of the substrate.

    eventType?: string

    The type of the event.

    eventTarget?: Node

    The target of the event.

    toolName?: string

    The name of the active tool when the event was fired.

    eventOptions?: ListenerOptions

    The options of the event.

    The event manager that captured the event. Defaults to the first instantiated event manager.