{"id":18573882,"url":"https://github.com/basedwon/leveldb","last_synced_at":"2025-05-15T23:34:11.883Z","repository":{"id":197118346,"uuid":"698022969","full_name":"basedwon/leveldb","owner":"basedwon","description":"A convenient wrapper around LevelDB for both server-side and client-side JavaScript","archived":false,"fork":false,"pushed_at":"2023-12-16T12:16:05.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-05T03:35:22.852Z","etag":null,"topics":["database","isomorphic","leveldb"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/basedwon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-29T01:17:55.000Z","updated_at":"2023-09-29T02:15:19.000Z","dependencies_parsed_at":"2024-10-12T22:32:12.969Z","dependency_job_id":"0a479714-7074-44f7-97f9-32ee68229d6d","html_url":"https://github.com/basedwon/leveldb","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"093b528b0067824680e715eecf1a96baa132b9ee"},"previous_names":["basedwon/leveldb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fleveldb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fleveldb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fleveldb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fleveldb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/basedwon","download_url":"https://codeload.github.com/basedwon/leveldb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442329,"owners_count":22071863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","isomorphic","leveldb"],"created_at":"2024-11-06T23:13:18.625Z","updated_at":"2025-05-15T23:34:11.832Z","avatar_url":"https://github.com/basedwon.png","language":"JavaScript","readme":"# LevelDB\n\n[![npm](https://img.shields.io/npm/v/@plaindb/leveldb?style=flat\u0026logo=npm)](https://www.npmjs.com/package/@plaindb/leveldb)\n[![pipeline](https://gitlab.com/frenware/framework/plaindb/leveldb/badges/master/pipeline.svg)](https://gitlab.com/frenware/framework/plaindb/leveldb/-/pipelines)\n[![license](https://img.shields.io/npm/l/@plaindb/leveldb)](https://gitlab.com/frenware/framework/plaindb/leveldb/-/blob/master/LICENSE)\n[![downloads](https://img.shields.io/npm/dw/@plaindb/leveldb)](https://www.npmjs.com/package/@plaindb/leveldb) \n\n[![Gitlab](https://img.shields.io/badge/Gitlab%20-%20?logo=gitlab\u0026color=%23383a40)](https://gitlab.com/frenware/framework/plaindb/leveldb)\n[![Github](https://img.shields.io/badge/Github%20-%20?logo=github\u0026color=%23383a40)](https://github.com/basedwon/leveldb)\n[![Twitter](https://img.shields.io/badge/@basdwon%20-%20?logo=twitter\u0026color=%23383a40)](https://twitter.com/basdwon)\n[![Discord](https://img.shields.io/badge/Basedwon%20-%20?logo=discord\u0026color=%23383a40)](https://discordapp.com/users/basedwon)\n\nProvides a convenient wrapper around LevelDB for both server-side and client-side JavaScript. Extending basic LevelDB functionality, integrating seamlessly with emitted events and enabling a more straightforward and modular approach for database operations.\n\n## Features\n\n- Singleton pattern for database instances\n- Easy-to-use asynchronous APIs\n- Stream support for read and write operations\n- Sub-levels for better data organization\n- Custom encoding/decoding options\n- Event emission and handling\n- Batch operations\n\n## Installation\n\nInstall the package with:\n\n```bash\nnpm install @plaindb/leveldb\n```\n\n## Usage\n\nFirst, import the `LevelDB` library.\n\n```js\nimport LevelDB from '@plaindb/leveldb'\n```\nor\n```js\nconst LevelDB = require('@plaindb/leveldb')\n```\n\n### Initialization\n\nYou can initialize a LevelDB instance as follows:\n\n```js\nconst db = new LevelDB({\n  dbName: 'myDatabase',\n  dbPrefix: 'prefix',\n  reset: true,\n  separator: '!',\n  keyEncoding: 'utf8',\n  valueEncoding: 'msgpack'\n})\n```\n\n### Constructor Options\n\nWhen instantiating a `LevelDB` object, you can pass an options object as follows:\n\n- **`dbName`**: (string) The name of the LevelDB database. Default is `'.db'`.\n- **`dbPrefix`**: (string) A prefix to be used before the dbName. Default is `''` (empty string).\n- **`client`**: (object) Custom Level client. If not provided, a new Level client will be created.\n- **`reset`**: (boolean) If `true`, clears the database on instantiation. Default is `false`.\n- **`separator`**: (string) The separator used for key names. Default is `'!'`.\n- **`keyEncoding`**: (string | object) Encoding for keys. Default is `'utf8'`.\n- **`valueEncoding`**: (string | object) Encoding for values. Default is `'msgpack'`.\n\n### Putting Data\n\nTo insert data into the LevelDB database:\n\n```js\nawait db.put('key', 'value')\n```\n\n### Getting Data\n\nTo retrieve data from the database:\n\n```js\nconst value = await db.get('key')\n```\n\n### Deleting Data\n\nTo delete data:\n\n```js\nawait db.del('key')\n```\n\n### Stream Operations\n\nFor large datasets, you can use streaming:\n\n```js\nconst readStream = db.createReadStream()\nreadStream.on('data', data =\u003e {\n  console.log(data)\n})\n```\n\n### Sub-levels\n\nYou can create sub-levels for better data organization:\n\n```js\nconst subDB = db.sub('subPath')\n```\n\n### Batch Operations\n\nFor performing multiple operations atomically:\n\n```js\nawait db.batch([\n  { type: 'put', key: 'key1', value: 'value1' },\n  { type: 'del', key: 'key2' }\n])\n```\n\n### Event Handling\n\nYou can also attach event listeners:\n\n```js\ndb.on('put', (key, value) =\u003e {\n  // Do something\n})\n```\n\n## Documentation\n\n- [API Reference](/docs/api.md)\n\n## Tests\n\nIn order to run the test suite, simply clone the repository and install its dependencies:\n\n```bash\ngit clone https://gitlab.com/frenware/framework/plaindb/leveldb.git\ncd basd\nnpm install\n```\n\nTo run the tests:\n\n```bash\nnpm test\n```\n\n## Contributing\n\nThank you! Please see our [contributing guidelines](/docs/contributing.md) for details.\n\n## Donations\n\nIf you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!\n\n**Bitcoin (BTC):**\n```\n1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF\n```\n\n**Monero (XMR):**\n```\n46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ\n```\n\n## License\n\n@plaindb/leveldb is [MIT licensed](https://gitlab.com/frenware/framework/plaindb/leveldb/-/blob/master/LICENSE).\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fleveldb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasedwon%2Fleveldb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fleveldb/lists"}