diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index fa9699b..0000000 --- a/.prettierrc +++ /dev/null @@ -1,7 +0,0 @@ -{ - "semi": true, - "trailingComma": "all", - "singleQuote": true, - "printWidth": 80, - "tabWidth": 2 -} diff --git a/README.md b/README.md index 38b7a84..47ba1ea 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # js-db -DB is library managing key value state for MatrixAI's JavaScript/TypeScript applications. +DB is library managing key value state for MatrixAI's JavaScript/TypeScript +applications. -This forks classic-level's C++ binding code around LevelDB 1.20. Differences from classic-level: +This forks classic-level's C++ binding code around LevelDB 1.20. Differences +from classic-level: - Uses TypeScript from ground-up - Supports Snapshot-Isolation based transactions via `DBTransaction` -- API supports "key paths" which can be used to manipulate "levels" of nested keys -- Value encryption (key-encryption is not supported yet) - requires additional work with block-encryption +- API supports "key paths" which can be used to manipulate "levels" of nested + keys +- Value encryption (key-encryption is not supported yet) - requires additional + work with block-encryption - Uses RocksDB ## Installation @@ -71,11 +75,13 @@ async function main() { main(); ``` -If you created the `DB` with a `crypto` object, then upon restarting the `DB`, you must pass in the same `crypto` object. +If you created the `DB` with a `crypto` object, then upon restarting the `DB`, +you must pass in the same `crypto` object. ## Development -This project uses Git submodules to bring in rocksdb. **Make sure to clone recursively.** +This project uses Git submodules to bring in rocksdb. **Make sure to clone +recursively.** If you already cloned, run this: @@ -106,7 +112,9 @@ npm run lintfix npm run bench ``` -View benchmarks here: https://github.com/MatrixAI/js-db/blob/master/benches/results with https://raw.githack.com/ +View benchmarks here: +https://github.com/MatrixAI/js-db/blob/master/benches/results with +https://raw.githack.com/ ### Docs Generation diff --git a/package-lock.json b/package-lock.json index 01ce5a4..76f7c3a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,7 +19,7 @@ "node-gyp-build": "4.4.0" }, "devDependencies": { - "@matrixai/lint": "^0.2.6", + "@matrixai/lint": "^0.2.11", "@swc/core": "1.3.82", "@swc/jest": "^0.2.29", "@types/jest": "^29.5.2", @@ -1799,9 +1799,9 @@ "integrity": "sha512-75hH7ZTmhM/VXeICXCPiVr/ZxQSoBwXh2HOI3AhD8AGYDDsEJsm4tnDSr/6vT3vS0ryZb3kb9mpAmCeibdrF3w==" }, "node_modules/@matrixai/lint": { - "version": "0.2.6", - "resolved": "https://registry.npmjs.org/@matrixai/lint/-/lint-0.2.6.tgz", - "integrity": "sha512-Cbx6SCTAqSt7lTKkaXL7wB+KbkiXYpQ0LdV5fPcnzEfG0sCuG8dbJcwzgHT5Qn7ubG71BBLUVFjHY1EGADzT8g==", + "version": "0.2.11", + "resolved": "https://registry.npmjs.org/@matrixai/lint/-/lint-0.2.11.tgz", + "integrity": "sha512-Q/atLaVExgQbd7b/sXCvTAIus0M+egxr6fjHFNzpUZGY3Gu+UkYQrel/440JnvZ+fK8fq9GTHewpa14H08AcRw==", "dev": true, "dependencies": { "@eslint/compat": "^1.2.5", diff --git a/package.json b/package.json index dc637ba..f961cbd 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "node-gyp-build": "4.4.0" }, "devDependencies": { - "@matrixai/lint": "^0.2.6", + "@matrixai/lint": "^0.2.11", "@swc/core": "1.3.82", "@swc/jest": "^0.2.29", "@types/jest": "^29.5.2",