Interface IStepContext<S>

interface IStepContext<S> {
    $groupId?: number;
    api: API;
    payload: object;
    scene: SceneContext<S> & {
        step: StepSceneContext<S>;
    };
    state: ContextDefaultState;
    subTypes: string[];
    type: string;
    upload: Upload;
    get [toStringTag](): string;
    [kSerializeData](): object;
    is(rawTypes): boolean;
    toJSON(): object;
}

Type Parameters

  • S extends Record<string, unknown>

Hierarchy (view full)

Properties

$groupId? api payload scene state subTypes type upload

Accessors

[toStringTag]

Methods

[kSerializeData] is toJSON

Properties

Optional $groupId

$groupId?: number

Protected api

api: API

Protected payload

payload: object

scene

scene: SceneContext<S> & {
    step: StepSceneContext<S>;
}

Scene control context

Type declaration

state

state: ContextDefaultState

subTypes

subTypes: string[]

type

type: string

Protected upload

upload: Upload

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns custom tag

    Returns string

Methods

[kSerializeData]

  • [kSerializeData](): object

  • Returns the custom data

    Returns object

is

  • is(rawTypes): boolean

  • Checks whether the context of some of these types

    Parameters

    • rawTypes: string[]

    Returns boolean

toJSON

  • toJSON(): object

  • Returns data for JSON

    Returns object

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc