Skip to content

ci: merge staging to master #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 29, 2025
Merged

ci: merge staging to master #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .prettierrc
View file
Open in desktop

This file was deleted.

22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading