mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-08-18 02:21:51 +08:00
DarkSky
0c7b20dc18
#### PR Dependency Tree * **PR #15464** 👈 This tree was auto-generated by [Charcoal](https://github.com/danerwilliams/charcoal) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Chores** * Replaced the project’s formatting and linting workflow with Oxfmt and Oxlint. * Added shared formatting and linting configuration, editor integration, and updated automated checks. * Updated generated files, scripts, and lint guidance to use the new tooling. * **Style** * Reformatted templates, source code, examples, and configuration files for consistent readability. * No user-facing functionality or rendering behavior changed. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
81 lines
2.0 KiB
Markdown
81 lines
2.0 KiB
Markdown
# Space Storage
|
|
|
|
## Usage
|
|
|
|
### Independent Storage usage
|
|
|
|
```ts
|
|
import type { ConnectionStatus } from '@affine/nbstore';
|
|
import { IndexedDBDocStorage } from '@affine/nbstore/idb';
|
|
|
|
const storage = new IndexedDBDocStorage({
|
|
peer: 'local'
|
|
spaceId: 'my-new-workspace',
|
|
});
|
|
|
|
await storage.connect();
|
|
storage.connection.onStatusChange((status: ConnectionStatus, error?: Error) => {
|
|
ui.show(status, error);
|
|
});
|
|
|
|
// { docId: string, bin: Uint8Array, timestamp: Date, editor?: string } | null
|
|
const doc = await storage.getDoc('my-first-doc');
|
|
```
|
|
|
|
### Use All storages together
|
|
|
|
```ts
|
|
import { SpaceStorage } from '@affine/nbstore';
|
|
import type { ConnectionStatus } from '@affine/nbstore';
|
|
import { IndexedDBDocStorage } from '@affine/nbstore/idb';
|
|
import { SqliteBlobStorage } from '@affine/nbstore/sqlite';
|
|
|
|
const storage = new SpaceStorage([
|
|
new IndexedDBDocStorage({}),
|
|
new SqliteBlobStorage({}),
|
|
]);
|
|
|
|
await storage.connect();
|
|
storage.on('connection', ({ storage, status, error }) => {
|
|
ui.show(storage, status, error);
|
|
});
|
|
|
|
await storage.get('doc').pushDocUpdate({
|
|
docId: 'my-first-doc',
|
|
bin: new Uint8Array(),
|
|
editor: 'me',
|
|
});
|
|
await storage.tryGet('blob')?.get('img');
|
|
```
|
|
|
|
### Put Storage behind Worker
|
|
|
|
```ts
|
|
import { SpaceStorageWorkerClient } from '@affine/nbstore/op';
|
|
import type { ConnectionStatus } from '@affine/nbstore';
|
|
import { IndexedDBDocStorage } from '@affine/nbstore/idb';
|
|
|
|
const client = new SpaceStorageWorkerClient();
|
|
client.addStorage(IndexedDBDocStorage, {
|
|
// options can only be structure-cloneable type
|
|
peer: 'local',
|
|
spaceType: 'workspace',
|
|
spaceId: 'my-new-workspace',
|
|
});
|
|
|
|
await client.connect();
|
|
client.ob$('connection', ({ storage, status, error }) => {
|
|
ui.show(storage, status, error);
|
|
});
|
|
|
|
await client.call('pushDocUpdate', {
|
|
docId: 'my-first-doc',
|
|
bin: new Uint8Array(),
|
|
editor: 'me',
|
|
});
|
|
|
|
// call unregistered op will leads to Error
|
|
// Error { message: 'Handler for operation [listHistory] is not registered.' }
|
|
await client.call('listHistories', { docId: 'my-first-doc' });
|
|
```
|