{"_id":"@brine-db/brine","_rev":"4-e01656e79a75ef97be744478c11cc5a0","name":"@brine-db/brine","dist-tags":{"next":"2.0.2-next","latest":"2.0.1"},"versions":{"2.0.0-next":{"name":"@brine-db/brine","version":"2.0.0-next","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","scripts":{"artifacts":"napi artifacts","build":"yarn build:rs && yarn build:ts","build:ts":"tsup","build:rs":"napi build --platform --release native","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm --skip-gh-release","test":"vitest run","universal":"napi universal","version":"napi version","lint":"biome check src/**/*.ts","docs":"typedoc --plugin typedoc-plugin-markdown --out docs --excludeExternals --exclude benchmark/ --externalPattern '**/node_modules/**' src/index.ts"},"napi":{"name":"brine","triples":{}},"workspaces":["benchmark"],"license":"MIT","devDependencies":{"@biomejs/biome":"^1.6.4","@napi-rs/cli":"^2.18.0","@sapphire/ts-config":"^5.0.1","@vitest/coverage-v8":"^1.4.0","tslib":"^2.6.2","tsup":"^8.0.2","typedoc":"^0.25.13","typedoc-plugin-markdown":"^3.17.1","typescript":"^5.4.4","vitest":"^1.4.0"},"packageManager":"yarn@4.1.1","optionalDependencies":{"@brine-db/brine-win32-x64-msvc":"2.0.0-next","@brine-db/brine-darwin-x64":"2.0.0-next","@brine-db/brine-linux-x64-gnu":"2.0.0-next"},"_id":"@brine-db/brine@2.0.0-next","gitHead":"9e85bc295518cdfbbd72d4f82c1f9cadd2275e93","_nodeVersion":"20.12.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-zUp2fw1LnRwXsP2XGlxPaqJdOfWl8gxOP1qTkyRlFRxsnQ99KpAOd8n3PDY8Ra404bi+J0djbzpte73UuWMY9w==","shasum":"32060923e58047f0f84207ddd510ae9e05e68342","tarball":"https://registry.npmjs.org/@brine-db/brine/-/brine-2.0.0-next.tgz","fileCount":28,"unpackedSize":46821,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDl1DPshzjyR1qpLMNxKaqC8WS5sWGmr/MyiGgpvzl1sAiBO6VBHKRxIKXQFXo/gvw6UG1GzSzrrDK+F93icHPODzQ=="}]},"_npmUser":{"name":"dan-online","email":"dan@dancodes.online"},"directories":{},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/brine_2.0.0-next_1712763775362_0.6439420566608967"},"_hasShrinkwrap":false},"2.0.1-next":{"name":"@brine-db/brine","version":"2.0.1-next","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","scripts":{"artifacts":"napi artifacts","build":"yarn build:rs && yarn build:ts","build:ts":"tsup","build:rs":"napi build --platform --release native","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm --skip-gh-release","test":"vitest run","universal":"napi universal","version":"napi version","lint":"biome check src/**/*.ts","docs":"typedoc --plugin typedoc-plugin-markdown --out docs --excludeExternals --exclude benchmark/ --externalPattern '**/node_modules/**' src/index.ts"},"napi":{"name":"brine","triples":{}},"workspaces":["benchmark"],"license":"MIT","devDependencies":{"@biomejs/biome":"^1.6.4","@napi-rs/cli":"^2.18.0","@sapphire/ts-config":"^5.0.1","@vitest/coverage-v8":"^1.4.0","tslib":"^2.6.2","tsup":"^8.0.2","typedoc":"^0.25.13","typedoc-plugin-markdown":"^3.17.1","typescript":"^5.4.4","vitest":"^1.4.0"},"packageManager":"yarn@4.1.1","optionalDependencies":{"@brine-db/brine-win32-x64-msvc":"2.0.1-next","@brine-db/brine-darwin-x64":"2.0.1-next","@brine-db/brine-linux-x64-gnu":"2.0.1-next"},"_id":"@brine-db/brine@2.0.1-next","readme":"![npm version](https://img.shields.io/npm/v/brinedb)\n\n# BrineDB\n\n[SeaORM](https://www.sea-ql.org/SeaORM/) wrapper for NodeJS, providing basic key/value storage in SQLite/Postgres/MySQL/MariaDB.\n\n## Table of contents\n\n- [BrineDB](#brinedb)\n  - [Table of contents](#table-of-contents)\n  - [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Quick Start](#quick-start)\n  - [Typescript](#typescript)\n  - [Development](#development)\n    - [Prerequisites](#prerequisites)\n    - [Building the entire package](#building-the-entire-package)\n  - [Contributing](#contributing)\n  - [Built With](#built-with)\n  - [Versioning](#versioning)\n  - [Authors](#authors)\n  - [License](#license)\n\n## Getting Started\n\n## Installation\n\nTo install and set up the library, run:\n\n```sh\n$ yarn add brinedb\n```\n\nOr if you prefer npm:\n\n```sh\n$ npm i brinedb\n```\n\n## Quick Start\n\n```js\nconst { Brine } = require('brinedb');\n\n// SQLite\nconst brinedb = new Brine('sqlite::memory:');\nconst brinedb = new Brine('sqlite:/path/to/database.sqlite');\n\n// Postgres\nconst brinedb = new Brine('postgres://user:pass@localhost:5432/dbname');\n\n// MariaDB\nconst brinedb = new Brine('mariadb://user:pass@localhost:3306/dbname');\n\n// MySQL\nconst brinedb = new Brine('mysql://user:pass@localhost:3306/dbname');\n\n// Initialize the database (also runs migrations)\nawait brinedb.init();\n\n// Set a value\nawait brinedb.set('key', { hello: 'world' });\n\n// Get a value\nconst value = await brinedb.get('key');\n```\n\n## Typescript\n\nThis library is written in Typescript and includes type definitions. Here is an example that will be typed correctly:\n\n```ts\nimport { Brine } from 'brinedb';\n\ntype Value = { hello: string }\n\nconst brinedb = new Brine<Value>('sqlite::memory:');\n\nawait brinedb.set('key', { hello: 'world' });\n\nconst decoded = brinedb.get('key'); // Correctly typed\n```\n\n## Development\n\n### Prerequisites\n\nThis project requires NodeJS (version 20 or later) and yarn.\n[Node](http://nodejs.org) and [Yarn](https://yarnpkg.com/) are really easy to install.\nTo make sure you have them available on your machine,\ntry running the following command.\n\n```sh\n$ yarn -v && node -v && rustc --version # Example output\n3.6.3\nv20.11.1\nrustc 1.78.0-nightly (4a0cc881d 2024-03-11)\n```\n\n### Building the entire package\n\n_Requirement: Rust is installed on your machine._\n\n```sh\n$ yarn build\n```\n\nThis task will create a distribution version of the project\ninside your local `dist/` folder and output a binary in `native/`\n\n## Contributing\n\n1.  Fork it!\n2.  Create your feature branch: `git checkout -b my-new-feature`\n3.  Add your changes: `git add .`\n4.  Commit your changes: `git commit -am 'Add some feature'`\n5.  Push to the branch: `git push origin my-new-feature`\n6.  Submit a pull request :sunglasses:\n\n## Built With\n\n- [Neon](https://neon-bindings.com/)\n- [SeaORM](https://www.sea-ql.org/SeaORM/)\n- VSCode\n- TypeScript\n- Rust\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dan-online/brinedb/tags).\n\n## Authors\n\n- **DanCodes** - [@dan-online](https://github.com/dan-online) - <dan@dancodes.online>\n\n## License\n\n[MIT License](https://dan-online.mit-license.org/2024) © DanCodes\n","readmeFilename":"README.md","gitHead":"602ae8ffd83681182750d3707ad2bd5a4d0d1697","_nodeVersion":"20.12.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-u7/5EgtqbB6cRlLoRnM0IZISG+ENQ7zEix7zRYuXHvnmZdprYq1mrLBG0AfK/P+y8a0Jz0gpxa2m3QW4yuqtfA==","shasum":"3b7c9c8e2d4623528e4c6c5d9a44065f17725b1d","tarball":"https://registry.npmjs.org/@brine-db/brine/-/brine-2.0.1-next.tgz","fileCount":32,"unpackedSize":91062,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICmFvV8ikz/njvlhJInbki0gUBw0qGZ3xJNgMes1bVszAiEAxl+cuhf6s6uL+jQX17ZyDJUpLQOSQDet69TlsBkDiQo="}]},"_npmUser":{"name":"dan-online","email":"dan@dancodes.online"},"directories":{},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/brine_2.0.1-next_1712764676125_0.7760040948880198"},"_hasShrinkwrap":false},"2.0.2-next":{"name":"@brine-db/brine","version":"2.0.2-next","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","scripts":{"artifacts":"napi artifacts","build":"yarn build:rs && yarn build:ts","build:ts":"tsup","build:rs":"napi build --platform --release native","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm --skip-gh-release","test":"vitest run","universal":"napi universal","version":"napi version","lint":"biome check src/**/*.ts","docs":"typedoc --plugin typedoc-plugin-markdown --out docs --excludeExternals --exclude benchmark/ --externalPattern '**/node_modules/**' src/index.ts"},"napi":{"name":"brine","triples":{}},"workspaces":["benchmark"],"license":"MIT","devDependencies":{"@biomejs/biome":"^1.6.4","@napi-rs/cli":"^2.18.0","@sapphire/ts-config":"^5.0.1","@vitest/coverage-v8":"^1.4.0","tslib":"^2.6.2","tsup":"^8.0.2","typedoc":"^0.25.13","typedoc-plugin-markdown":"^3.17.1","typescript":"^5.4.4","vitest":"^1.4.0"},"packageManager":"yarn@4.1.1","optionalDependencies":{"@brine-db/brine-win32-x64-msvc":"2.0.2-next","@brine-db/brine-darwin-x64":"2.0.2-next","@brine-db/brine-linux-x64-gnu":"2.0.2-next"},"_id":"@brine-db/brine@2.0.2-next","readme":"![npm version](https://img.shields.io/npm/v/brinedb)\n\n# BrineDB\n\n[SeaORM](https://www.sea-ql.org/SeaORM/) wrapper for NodeJS, providing basic key/value storage in SQLite/Postgres/MySQL/MariaDB.\n\n## Table of contents\n\n- [BrineDB](#brinedb)\n  - [Table of contents](#table-of-contents)\n  - [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Quick Start](#quick-start)\n  - [Typescript](#typescript)\n  - [Development](#development)\n    - [Prerequisites](#prerequisites)\n    - [Building the entire package](#building-the-entire-package)\n  - [Contributing](#contributing)\n  - [Built With](#built-with)\n  - [Versioning](#versioning)\n  - [Authors](#authors)\n  - [License](#license)\n\n## Getting Started\n\n## Installation\n\nTo install and set up the library, run:\n\n```sh\n$ yarn add brinedb\n```\n\nOr if you prefer npm:\n\n```sh\n$ npm i brinedb\n```\n\n## Quick Start\n\n```js\nconst { Brine } = require('brinedb');\n\n// SQLite\nconst brinedb = new Brine('sqlite::memory:');\nconst brinedb = new Brine('sqlite:/path/to/database.sqlite');\n\n// Postgres\nconst brinedb = new Brine('postgres://user:pass@localhost:5432/dbname');\n\n// MariaDB\nconst brinedb = new Brine('mariadb://user:pass@localhost:3306/dbname');\n\n// MySQL\nconst brinedb = new Brine('mysql://user:pass@localhost:3306/dbname');\n\n// Initialize the database (also runs migrations)\nawait brinedb.init();\n\n// Set a value\nawait brinedb.set('key', { hello: 'world' });\n\n// Get a value\nconst value = await brinedb.get('key');\n```\n\n## Typescript\n\nThis library is written in Typescript and includes type definitions. Here is an example that will be typed correctly:\n\n```ts\nimport { Brine } from 'brinedb';\n\ntype Value = { hello: string }\n\nconst brinedb = new Brine<Value>('sqlite::memory:');\n\nawait brinedb.set('key', { hello: 'world' });\n\nconst decoded = brinedb.get('key'); // Correctly typed\n```\n\n## Development\n\n### Prerequisites\n\nThis project requires NodeJS (version 20 or later) and yarn.\n[Node](http://nodejs.org) and [Yarn](https://yarnpkg.com/) are really easy to install.\nTo make sure you have them available on your machine,\ntry running the following command.\n\n```sh\n$ yarn -v && node -v && rustc --version # Example output\n3.6.3\nv20.11.1\nrustc 1.78.0-nightly (4a0cc881d 2024-03-11)\n```\n\n### Building the entire package\n\n_Requirement: Rust is installed on your machine._\n\n```sh\n$ yarn build\n```\n\nThis task will create a distribution version of the project\ninside your local `dist/` folder and output a binary in `native/`\n\n## Contributing\n\n1.  Fork it!\n2.  Create your feature branch: `git checkout -b my-new-feature`\n3.  Add your changes: `git add .`\n4.  Commit your changes: `git commit -am 'Add some feature'`\n5.  Push to the branch: `git push origin my-new-feature`\n6.  Submit a pull request :sunglasses:\n\n## Built With\n\n- [Neon](https://neon-bindings.com/)\n- [SeaORM](https://www.sea-ql.org/SeaORM/)\n- VSCode\n- TypeScript\n- Rust\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dan-online/brinedb/tags).\n\n## Authors\n\n- **DanCodes** - [@dan-online](https://github.com/dan-online) - <dan@dancodes.online>\n\n## License\n\n[MIT License](https://dan-online.mit-license.org/2024) © DanCodes\n","readmeFilename":"README.md","gitHead":"c6b6bb0877841ec82e1c83d7fed80631e163a9fe","_nodeVersion":"20.12.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-LS079A9WwZGXyGLYoCnaYr6I/9Fb1kC/qqU2+L0Ohuhhnc9jB6LU03uxBY0klVNa7156hrvHfNjc1BrcG94JYw==","shasum":"d48e095edb6a8b939dd4eb0e712c8d50b353fdfd","tarball":"https://registry.npmjs.org/@brine-db/brine/-/brine-2.0.2-next.tgz","fileCount":32,"unpackedSize":91114,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC28KT0cIFPJsdZnaE141x/3LEvEf/S6eAQjBOgYf1FNwIhAMxI7mlZwTZs8RZxoVmjvoqdLCvrb4m+NTLQTPBPlchv"}]},"_npmUser":{"name":"dan-online","email":"dan@dancodes.online"},"directories":{},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/brine_2.0.2-next_1712765672790_0.0756046930698191"},"_hasShrinkwrap":false},"2.0.0":{"name":"@brine-db/brine","version":"2.0.0","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","scripts":{"artifacts":"napi artifacts","build":"yarn build:rs && yarn build:ts","build:ts":"tsup","build:rs":"napi build --platform --release native","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm --skip-gh-release","test":"vitest run","universal":"napi universal","version":"napi version","lint":"biome check src/**/*.ts","docs":"typedoc --plugin typedoc-plugin-markdown --out docs --excludeExternals --exclude benchmark/ --externalPattern '**/node_modules/**' src/index.ts"},"napi":{"name":"brine","triples":{}},"workspaces":["benchmark"],"license":"MIT","devDependencies":{"@biomejs/biome":"^1.6.4","@napi-rs/cli":"^2.18.0","@sapphire/ts-config":"^5.0.1","@vitest/coverage-v8":"^1.4.0","tslib":"^2.6.2","tsup":"^8.0.2","typedoc":"^0.25.13","typedoc-plugin-markdown":"^3.17.1","typescript":"^5.4.4","vitest":"^1.4.0"},"packageManager":"yarn@4.1.1","optionalDependencies":{"@brine-db/brine-win32-x64-msvc":"2.0.0","@brine-db/brine-darwin-x64":"2.0.0","@brine-db/brine-linux-x64-gnu":"2.0.0"},"_id":"@brine-db/brine@2.0.0","gitHead":"c01850ba7d31e195c3ef491c171f0afc61226e8e","_nodeVersion":"20.12.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-c7dsqKvFHINRiL0ICJpCXX0ypYGqmM2WK3uB0hPVOXgs9K9C+P1vam1vwIc9s6Ac+baXNv0Ptc0PUlOZr3+d0g==","shasum":"122698d06d379cd7cc4d171cad24388ed313bc58","tarball":"https://registry.npmjs.org/@brine-db/brine/-/brine-2.0.0.tgz","fileCount":32,"unpackedSize":91753,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCgFxMNjVYSNf7vY2Bw7IFuYjFtIdUS/ddkZQ8ngafvVgIhAOVdVZikP62CItK21MGWIM95wqVMupkCOBoWfsvwWg6y"}]},"_npmUser":{"name":"dan-online","email":"dan@dancodes.online"},"directories":{},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/brine_2.0.0_1712776821476_0.4140527611232161"},"_hasShrinkwrap":false},"2.0.1":{"name":"@brine-db/brine","version":"2.0.1","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","scripts":{"artifacts":"napi artifacts","build":"yarn build:rs && yarn build:ts","build:ts":"tsup","build:rs":"napi build --platform --release native","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm --skip-gh-release","test":"vitest run","universal":"napi universal","version":"napi version","lint":"biome check src/**/*.ts","docs":"typedoc --plugin typedoc-plugin-markdown --out docs --excludeExternals --exclude benchmark/ --externalPattern '**/node_modules/**' src/index.ts"},"napi":{"name":"brine","triples":{}},"workspaces":["benchmark"],"license":"MIT","devDependencies":{"@biomejs/biome":"^1.6.4","@napi-rs/cli":"^2.18.0","@sapphire/ts-config":"^5.0.1","@vitest/coverage-v8":"^1.4.0","tinybench":"^2.6.0","tslib":"^2.6.2","tsup":"^8.0.2","typedoc":"^0.25.13","typedoc-plugin-markdown":"^3.17.1","typescript":"^5.4.4","vitest":"^1.4.0"},"packageManager":"yarn@4.1.1","optionalDependencies":{"@brine-db/brine-win32-x64-msvc":"2.0.1","@brine-db/brine-darwin-x64":"2.0.1","@brine-db/brine-linux-x64-gnu":"2.0.1"},"_id":"@brine-db/brine@2.0.1","gitHead":"64941848cb6c0fbc42bb93eac76e8f618d397be2","_nodeVersion":"20.12.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-E5JKtWjR4QQgxd9y3M936ZwgzWdiotp9d6narm3SJ4RTTJ4l2Hi4XydkSfmVzjfZ4fMUE65vKk1koBwSDZ7pKA==","shasum":"5592c19621fc067cdda9381f5cae0ec89d2e28ea","tarball":"https://registry.npmjs.org/@brine-db/brine/-/brine-2.0.1.tgz","fileCount":32,"unpackedSize":92217,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDKBnoyZJ9+OHn0RDyXKss2vG6fUqEf/B70eLwTCFfygwIgK6hYxv5WQeoQeCs9SB23DfEtVxdySr4BqoYTvN+13Co="}]},"_npmUser":{"name":"dan-online","email":"dan@dancodes.online"},"directories":{},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/brine_2.0.1_1712833768521_0.45451685991303026"},"_hasShrinkwrap":false}},"time":{"created":"2024-04-10T15:42:55.249Z","2.0.0-next":"2024-04-10T15:42:55.597Z","modified":"2024-04-11T11:09:28.870Z","2.0.1-next":"2024-04-10T15:57:56.281Z","2.0.2-next":"2024-04-10T16:14:33.011Z","2.0.0":"2024-04-10T19:20:21.644Z","2.0.1":"2024-04-11T11:09:28.680Z"},"maintainers":[{"name":"dan-online","email":"dan@dancodes.online"}],"description":"SeaORM wrapper for NodeJS, providing basic key/value storage in sqlite/postgres/mysql","license":"MIT","readme":"![npm version](https://img.shields.io/npm/v/@brine-db/brine)\n\n# BrineDB\n\n[SeaORM](https://www.sea-ql.org/SeaORM/) wrapper for NodeJS, providing basic key/value storage in SQLite/Postgres/MySQL/MariaDB.\n\n## Table of contents\n\n- [BrineDB](#brinedb)\n  - [Table of contents](#table-of-contents)\n  - [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Quick Start](#quick-start)\n  - [Typescript](#typescript)\n  - [Development](#development)\n    - [Prerequisites](#prerequisites)\n    - [Building the entire package](#building-the-entire-package)\n  - [Contributing](#contributing)\n  - [Built With](#built-with)\n  - [Versioning](#versioning)\n  - [Authors](#authors)\n  - [License](#license)\n\n## Getting Started\n\n## Installation\n\nTo install and set up the library, run:\n\n```sh\n$ yarn add @brine-db/brine\n```\n\nOr if you prefer npm:\n\n```sh\n$ npm i @brine-db/brine\n```\n\n## Quick Start\n\n```js\nconst { Brine } = require('@brine-db/brine');\n\n// SQLite\nconst brinedb = new Brine('sqlite::memory:');\nconst brinedb = new Brine('sqlite:/path/to/database.sqlite');\n\n// Postgres\nconst brinedb = new Brine('postgres://user:pass@localhost:5432/dbname');\n\n// MySQL/MariaDB\nconst brinedb = new Brine('mysql://user:pass@localhost:3306/dbname');\n\n// Initialize the database (also runs migrations)\nawait brinedb.init();\n\n// Set a value\nawait brinedb.set('key', { hello: 'world' });\n\n// Get a value\nconst value = await brinedb.get('key');\n```\n\n## Typescript\n\nThis library is written in Typescript and includes type definitions. Here is an example that will be typed correctly:\n\n```ts\nimport { Brine } from '@brine-db/brine';\n\ntype Value = { hello: string }\n\nconst brinedb = new Brine<Value>('sqlite::memory:');\n\nawait brinedb.set('key', { hello: 'world' });\n\nconst decoded = brinedb.get('key');\n\ntypeof decoded.hello; // string\n```\n\n## Development\n\n### Prerequisites\n\nThis project requires NodeJS (version 18 or later) and yarn.\n[Node](http://nodejs.org) and [Yarn](https://yarnpkg.com/) are really easy to install.\nTo make sure you have them available on your machine,\ntry running the following command.\n\n```sh\n$ yarn -v && node -v && rustc --version # Example output\n3.6.3\nv20.11.1\nrustc 1.78.0-nightly (4a0cc881d 2024-03-11)\n```\n\n### Building the entire package\n\n_Requirement: Rust is installed on your machine._\n\n```sh\n$ yarn build\n```\n\nThis task will create a distribution version of the project\ninside your local `dist/` folder and output a binary in `native/`\n\n## Contributing\n\n1.  Fork it!\n2.  Create your feature branch: `git checkout -b my-new-feature`\n3.  Add your changes: `git add .`\n4.  Commit your changes: `git commit -am 'Add some feature'`\n5.  Push to the branch: `git push origin my-new-feature`\n6.  Submit a pull request :sunglasses:\n\n## Built With\n\n- [Napi-RS](https://napi.rs/)\n- [SeaORM](https://www.sea-ql.org/SeaORM/)\n- VSCode\n- TypeScript\n- Rust\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dan-online/brinedb/tags).\n\n## Authors\n\n- **DanCodes** - [@dan-online](https://github.com/dan-online) - <dan@dancodes.online>\n\n## License\n\n[MIT License](https://dancodes.mit-license.org/2024) © DanCodes\n","readmeFilename":"README.md"}