AIRI Server API - v0.10.2
    Preparing search index...

    Interface ModuleConfigEnvelope<C>

    Config payload envelope for plan/apply/validate/commit.

    Example: { configId: "stage-ui-live2d", revision: 12, schemaVersion: 2, full: { model: "Hiyori", driver: { type: "live2d" } }, }

    interface ModuleConfigEnvelope<C = Record<string, unknown>> {
        configId: string;
        revision: number;
        schemaVersion: number;
        source?: ModuleIdentity;
        full?: C;
        patch?: Partial<C>;
        baseRevision?: number;
    }

    Type Parameters

    • C = Record<string, unknown>
    Index

    Properties

    configId revision schemaVersion source? full? patch? baseRevision?

    Properties

    configId: string
    revision: number

    Monotonic revision number for this configId.

    schemaVersion: number

    Schema version this config targets.

    source?: ModuleIdentity

    Optional source identity (who produced this config).

    full?: C

    Full config payload (use when first applying or rehydrating).

    patch?: Partial<C>

    Partial patch payload (use when updating or filling missing fields).

    baseRevision?: number

    If patch is used, baseRevision should be set for optimistic concurrency.

    Settings

    Member Visibility

    On This Page

    Properties