mirror of
https://github.com/toeverything/AFFiNE.git
synced 2024-12-22 16:31:43 +03:00
4125038ff8
TODO - [x] basic - [x] storages - [x] producer/consumer - [x] operation pattern - [x] events - [x] worker - [x] readme - [x] peer dependencies
70 lines
2.0 KiB
Markdown
70 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' });
|
|
```
|