mobx-keystone/dist/types/action/context.d.ts

A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more

/**
 * Low level action context.
 */
export interface ActionContext {
    /**
     * Action name
     */
    readonly actionName: string;
    /**
     * Action type, sync or async.
     */
    readonly type: ActionContextActionType;
    /**
     * Action target object.
     */
    readonly target: object;
    /**
     * Array of action arguments.
     */
    readonly args: ReadonlyArray<any>;
    /**
     * Parent action context, if any.
     */
    readonly parentContext?: ActionContext;
    /**
     * Root action context, or itself if the root.
     */
    readonly rootContext: ActionContext;
    /**
     * Previous async step context, undefined for sync actions or the first action of a flow.
     */
    readonly previousAsyncStepContext?: ActionContext;
    /**
     * Spawn async step context, undefined for sync actions.
     */
    readonly spawnAsyncStepContext?: ActionContext;
    /**
     * Async step type, or undefined for sync actions.
     */
    readonly asyncStepType?: ActionContextAsyncStepType;
    /**
     * Custom data for the action context to be set by middlewares, an object.
     * Symbols must be used as keys to avoid name clashing between middlewares.
     */
    readonly data: Record<symbol, any>;
}
/**
 * Action type, sync or async.
 */
export declare enum ActionContextActionType {
    Sync = "sync",
    Async = "async"
}
/**
 * An async step type.
 */
export declare enum ActionContextAsyncStepType {
    /**
     * The flow is about to start.
     */
    Spawn = "spawn",
    /**
     * The flow is about to return (finish).
     */
    Return = "return",
    /**
     * The flow is about to continue.
     */
    Resume = "resume",
    /**
     * The flow yield just threw, which might be recovered (caught) or not.
     */
    ResumeError = "resumeError",
    /**
     * The flow is about to throw an error to the flow caller.
     */
    Throw = "throw"
}
/**
 * Gets the currently running action context, or undefined if none.
 *
 * @returns
 */
export declare function getCurrentActionContext(): ActionContext | undefined;