@tomiocodes/sled

A key value database.

Table of Contents

• @tomiocodes/sled
  • Description
  • Features
  • Installation
  • Usage
    • Basic Usage
    • Configuration
  • API Documentation

Description

A simple key-value database.

Features

• Written in TypeScript
• Offers CommonJS, ESM bundles
• Fully tested
• Powered by Rust
• Persistent

Installation

yarn add @tomiocodes/sled
# npm install @tomiocodes/sled
# pnpm add @tomiocodes/sled

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { set } = require('@tomiocodes/sled') equals import { set } from '@tomiocodes/sled'.

Basic Usage

const { set, get } = require('@tomiocodes/sled');

set('hello', 'world');

console.log(get('hello'));

Configuration

We support any configuration file if the config crate supports it.

{
	"name": "sled-database"
}

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.