@vk-io/scenes
    Preparing search index...

    Interface IContext<S>

    interface IContext<S extends Record<string, unknown> = Record<string, any>> {
        $groupId?: number;
        api: API;
        payload: object;
        scene: SceneContext<S>;
        state: S;
        subTypes: string[];
        type: string;
        upload: Upload;
        get "[toStringTag]"(): string;
        "[kSerializeData]"(): object;
        is(rawTypes: string[]): boolean;
        toJSON(): object;
        [key: string]: any;
    }

    Type Parameters

    • S extends Record<string, unknown> = Record<string, any>

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    $groupId? api payload scene state subTypes type upload

    Accessors

    [toStringTag]

    Methods

    [kSerializeData] is toJSON

    Properties

    $groupId?: number
    api: API
    payload: object
    scene: SceneContext<S>

    Scene control context

    state: S
    subTypes: string[]
    type: string
    upload: Upload

    Accessors

    • get "[toStringTag]"(): string

      Returns custom tag

      Returns string

    Methods

    • Returns the custom data

      Returns object

    • Checks whether the context of some of these types

      Parameters

      • rawTypes: string[]

      Returns boolean

    • Returns data for JSON

      Returns object

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods