@bluelibs/runner - v5.5.0
    Preparing search index...

    Interface IRuntime<V>

    Common interface for the Runner runtime instance. Provides access to tasks, events, resources, and lifecycle management.

    interface IRuntime<V = unknown> {
        dispose(): Promise<void>;
        emitEvent<P>(
            event: string | IEvent<P>,
            payload?: P extends void | undefined ? undefined : P,
            options?: IEventEmitOptions,
        ): Promise<void | IEventEmitReport>;
        getLazyResourceValue<Output extends Promise<any>>(
            resource:
                | string
                | IResource<
                    any,
                    Output,
                    any,
                    any,
                    any,
                    TagType[],
                    ResourceMiddlewareAttachmentType[],
                >,
        ): Promise<Output extends Promise<U> ? U : Output>;
        getResourceConfig<Config>(
            resource:
                | string
                | IResource<
                    Config,
                    any,
                    any,
                    any,
                    any,
                    TagType[],
                    ResourceMiddlewareAttachmentType[],
                >,
        ): Config;
        getResourceValue<Output extends Promise<any>>(
            resource:
                | string
                | IResource<
                    any,
                    Output,
                    any,
                    any,
                    any,
                    TagType[],
                    ResourceMiddlewareAttachmentType[],
                >,
        ): Output extends Promise<U> ? U : Output;
        getRootConfig<Config = unknown>(): Config;
        getRootId(): string;
        getRootValue<Value = V>(): Value;
        runTask<
            TTask extends
                | string
                | ITask<
                    any,
                    Promise<any>,
                    any,
                    any,
                    TagType[],
                    TaskMiddlewareAttachmentType[],
                >,
        >(
            task: TTask,
            ...args: TTask extends ITask<
                I,
                any,
                any,
                any,
                TagType[],
                TaskMiddlewareAttachmentType[],
            >
                ? I extends void
                | undefined
                    ? [input?: I, options?: TaskCallOptions]
                    : [input: I, options?: TaskCallOptions]
                : [input?: unknown, options?: TaskCallOptions],
        ): TTask extends ITask<
            any,
            O,
            any,
            any,
            TagType[],
            TaskMiddlewareAttachmentType[],
        >
            ? O
            : Promise<any>;
    }

    Type Parameters

    • V = unknown

    Implemented by

    Index

    Methods

    • Disposes the runtime and all resources.

      Returns Promise<void>

    • Initializes and returns a resource value on-demand (lazy mode only).

      Type Parameters

      • Output extends Promise<any>

      Parameters

      Returns Promise<Output extends Promise<U> ? U : Output>

    • Synchronously retrieves an initialized resource value.

      Type Parameters

      • Output extends Promise<any>

      Parameters

      Returns Output extends Promise<U> ? U : Output