Interface IComputeSchema<T>

IComputeSchema

Description

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

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.

Properties

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

Properties

Optionalcallbacks

callbacks?: Partial<IComputeCallbacks<T>>

Description

Optional callbacks for compute lifecycle events.

computeName

computeName: string

Description

The name of the compute.

OptionaldependsOn

dependsOn?: string[]

Description

Array of state names the compute depends on.

OptionaldocDescription

docDescription?: string

Description

Optional description for documentation purposes.

getComputeData

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

Type declaration

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

    • Parameters

      • clientId: string

        The client identifier.

      • computeName: string

        The name of the compute.

      Returns T | Promise<T>

      The computed data or a promise resolving to it.

Description

Function to retrieve or compute the data.

Optionalmiddlewares

middlewares?: IComputeMiddleware<T>[]

Description

Array of middleware functions to process compute data.

Optionalshared

shared?: boolean

Description

Indicates if the compute is shared across clients.

Optionalttl

ttl?: number

Description

Time-to-live for the compute data, in milliseconds.

Settings

Member Visibility

On This Page

Properties