Interface IComputeSchema<T>

IComputeSchema

interface IComputeSchema<T extends IComputeData = IComputeData> {
    callbacks?: Partial<IComputeCallbacks<T>>;
    computeName: string;
    dependsOn?: string[];
    docDescription?: string;
    getComputeData: (clientId: string, computeName: string) => T | Promise<T>;
    middlewares?: IComputeMiddleware<T>[];
    shared?: boolean;
    ttl?: number;
}

Type Parameters

  • T extends IComputeData = IComputeData

    Type extending IComputeData. Defines the schema for a compute, including its configuration and dependencies.

Properties

callbacks? computeName dependsOn? docDescription? getComputeData middlewares? shared? ttl?

Properties

Optionalcallbacks

callbacks?: Partial<IComputeCallbacks<T>>

Optional callbacks for compute lifecycle events. Provides hooks for handling compute updates, data changes, and other lifecycle events.

computeName

computeName: string

OptionaldependsOn

dependsOn?: string[]

OptionaldocDescription

docDescription?: string

getComputeData

getComputeData: (clientId: string, computeName: string) => T | Promise<T>

Optionalmiddlewares

middlewares?: IComputeMiddleware<T>[]

Optionalshared

shared?: boolean

Optionalttl

ttl?: number

Settings

Member Visibility

On This Page

Properties