From 06d5ecd59752511b971f976cf045addb4ffc44c6 Mon Sep 17 00:00:00 2001 From: Alex Yang Date: Thu, 31 Aug 2023 17:16:27 -0500 Subject: [PATCH] docs: update indexeddb document (#4084) --- packages/y-indexeddb/README.md | 4 ++++ packages/y-indexeddb/package.json | 3 ++- packages/y-indexeddb/src/index.ts | 4 ---- packages/y-indexeddb/src/provider.ts | 3 +++ yarn.lock | 2 +- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/packages/y-indexeddb/README.md b/packages/y-indexeddb/README.md index 70ee0fa8d..d3f56096b 100644 --- a/packages/y-indexeddb/README.md +++ b/packages/y-indexeddb/README.md @@ -32,3 +32,7 @@ downloadBinary(yDoc.guid).then(blob => { } }); ``` + +## LICENSE + +[MPL-2.0](https://github.com/toeverything/AFFiNE/blob/master/LICENSE-MPL2.0) diff --git a/packages/y-indexeddb/package.json b/packages/y-indexeddb/package.json index f60e9f9ff..1e7b54df4 100644 --- a/packages/y-indexeddb/package.json +++ b/packages/y-indexeddb/package.json @@ -5,6 +5,7 @@ "description": "IndexedDB database adapter for Yjs", "repository": "toeverything/AFFiNE", "author": "toeverything", + "license": "MPL-2.0", "keywords": [ "indexeddb", "yjs", @@ -44,6 +45,6 @@ "y-indexeddb": "^9.0.11" }, "peerDependencies": { - "yjs": "^13.5.51" + "yjs": "^13" } } diff --git a/packages/y-indexeddb/src/index.ts b/packages/y-indexeddb/src/index.ts index b30169f12..396cf8dcb 100644 --- a/packages/y-indexeddb/src/index.ts +++ b/packages/y-indexeddb/src/index.ts @@ -129,10 +129,6 @@ export const getMilestones = async ( return milestone.milestone; }; -/** - * We use `doc.guid` as the unique key, please make sure it not changes. - */ - export * from './provider'; export * from './shared'; export * from './utils'; diff --git a/packages/y-indexeddb/src/provider.ts b/packages/y-indexeddb/src/provider.ts index d0ca4640f..1c7fd9e62 100644 --- a/packages/y-indexeddb/src/provider.ts +++ b/packages/y-indexeddb/src/provider.ts @@ -105,6 +105,9 @@ export const createIndexedDBDatasource = ({ }; }; +/** + * We use `doc.guid` as the unique key, please make sure it not changes. + */ export const createIndexedDBProvider = ( doc: Doc, dbName: string = DEFAULT_DB_NAME diff --git a/yarn.lock b/yarn.lock index af3411783..930477efd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -12769,7 +12769,7 @@ __metadata: vite-plugin-dts: 3.5.2 y-indexeddb: ^9.0.11 peerDependencies: - yjs: ^13.5.51 + yjs: ^13 languageName: unknown linkType: soft