Skip to content

config

FieldValue
Prefixconfig
Namespace constantConfigNamespace
Subjects constantConfigSubjects
Kindbus
Schema recordConfigSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/config/config-namespace.ts
KeyWireTypeSchema
getconfig.getrpcconfig-subjects.ts
updateconfig.updaterpcconfig-subjects.ts

Get current config request. Empty request payload, returns full config.

Subject: config.get Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
config{ $schema: "makaio/config/v1"; mode: "local" | "remote" | "hybrid"; role: "server" | "main-dev-machine"; bus?: { remote?: { url?: string | undefined; secret?: string | undefined; } | undefined; } | undefined; relay?: { autoReconnect: boolean; maxReconnectAttempts: number; heartbeatInterval: number; url?: string | undefined; token?: string | undefined; } | undefined; features?: { voiceBridge: boolean; } | undefined; fileWatcher?: { backend: "auto" | "watchman" | "parcel" | "chokidar"; } | undefined; }yes

Update config request. Accepts full config object, validates and saves it.

Subject: config.update Type: Request (RPC)

Request:

FieldTypeRequired
config{ $schema: "makaio/config/v1"; mode: "local" | "remote" | "hybrid"; role: "server" | "main-dev-machine"; bus?: { remote?: { url?: string | undefined; secret?: string | undefined; } | undefined; } | undefined; relay?: { autoReconnect: boolean; maxReconnectAttempts: number; heartbeatInterval: number; url?: string | undefined; token?: string | undefined; } | undefined; features?: { voiceBridge: boolean; } | undefined; fileWatcher?: { backend: "auto" | "watchman" | "parcel" | "chokidar"; } | undefined; }yes

Response:

FieldTypeRequired
successbooleanyes

Auto-generated by yarn docs:bus. Do not edit manually.