Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
CollabKit is currently in Beta. APIs and features may change.
Exported functions from @collab-kit/utils.
import { defineStores, codes } from '@collab-kit/utils';
function defineStores<T extends StoresConfig>(config: T): T;
import { defineStores } from '@collab-kit/utils';
const stores = defineStores({
tasks: {
title: { type: 'string', required: true },
completed: { type: 'boolean', default: false },
assignee: { type: 'string' },
},
settings: {
theme: { type: 'string', required: true, default: 'light' },
fontSize: { type: 'number', required: true, default: 14 },
},
});
client.stores.<name>.set(), get(), etc.
Pass the result to the CollabKitClient constructor:
const client = new CollabKitClient({
serverUrl: 'https://api.collab-kit.com',
authToken: '<jwt>',
stores,
});
// Fully typed: value is { title: string; completed?: boolean; assignee?: string }
await client.stores.tasks.set({
key: 'task-1',
value: { title: 'Ship v1' },
});
ResponseCode enum values to their HTTP status codes, descriptions, and messages. Useful for interpreting error responses.
const codes: Record<ResponseCode, {
description: string;
code: number;
message: string;
}>;
import { codes, ResponseCode } from '@collab-kit/utils';
const info = codes[ResponseCode.NOT_FOUND];
// { description: 'NOT_FOUND', code: 404, message: 'Not found' }