Klaf.js NPM | npm.io

Klaf

Very simple read/write database with a NoSQL.
It's written in JavaScript using pure Node.js API and pretty easy and small.
This database works seamlessly with Node.js, Bun, and Deno.

Choose the database and engine that best fit your needs to handle your data efficiently!

Database

klaf comes in two flavors: key-value database and document-oriented database.
You have the freedom to choose based on your needs, but most users will likely prefer the document-oriented database.

For details on how to use each database, please refer to the links below.

Engine

Klaf.js introduces the concept of an engine, which is an instance responsible for handling how data is stored. Currently, three types of engines are supported by default: FileSystem, InMemory, and WebWorker. If needed, you can also create your own custom engine.
Choose the engine that best fits your needs.

For a detailed list of the supported engines and more information, refer to this link.
If you're unsure what to choose, select the FileSystem engine.

Example

This example shows how to build a database using the document-oriented database KlafDocument and the FileSystem engine.

import { KlafDocument } from 'klaf.js'
import { FileSystemEngine } from 'klaf.js/engine/FileSystem'

const db = await KlafDocument.Open({
  path: 'my-database-path.db',
  version: 0,
  engine: new FileSystemEngine(),
  scheme: {
    id: {
      default: () => crypto.randomUUID()
    },
    nickname: {
      default: () => 'Anonymous',
      validate: (v) => typeof v === 'string',
    },
    gender: {
      default: () => 'other',
      validate: (v) => ['male', 'female', 'other'].includes(v),
    }
  }
})

await db.put({ nickname: 'faker', gender: 'male' })
const documents = await db.pick({ gender: 'male' })

The following example demonstrates how to build a database using the key-value database Klaf and the WebWorker engine.

import { Klaf } from 'klaf.js'
import { WebWorkerEngine } from 'klaf.js/engine/WebWorker'

const db = await Klaf.Open({
  path: 'my-database-path.db',
  engine: new WebWorkerEngine(),
})

const key = await db.put('Faker, GOAT.')
const record = (await db.pick(key)).record.payload // "Faker, GOAT."

Install

Node.js (NPM)

npm i klaf.js

Deno (JSR)

deno add jsr:@izure/klaf

Browser (ESM)

import { Klaf, KlafDocument } from 'https://cdn.jsdelivr.net/npm/klaf.js/dist/esm/index.mjs'

// engines
import { InMemoryEngine } from 'https://cdn.jsdelivr.net/npm/klaf.js/dist/esm/engine/InMemory.mjs'
import { WebWorkerEngine } from 'https://cdn.jsdelivr.net/npm/klaf.js/dist/esm/engine/WebWorker.mjs'

Why

Why use klaf?

JavaScript has numerous fantastic database libraries available, but at times, they can seem overly complex.
This particular solution is ideal for situations where you need to store data for an extended period, making it well-suited for less critical data that doesn't require a rigid structure.

Since it is implemented in pure JavaScript, there is no need for pre-builds or configuration based on the Node.js version. It is compatible with all versions!

Why should I use this instead of JSON?

When the JSON files get large, quick data read and write operations can become challenging.
klaf handles data input and output in real-time, ensuring fast and lightweight performance. Check the performance tests below.

How

How does klaf work?

klaf manages files by breaking them into logical blocks called pages. You can set the page size when creating the database.

When you insert data, the ID you get back includes information about where the data is stored on the page. This makes it possible to work with large files quickly. This value could be seen by users, but it's encrypted to make it hard to predict. This way, it stops users from trying to steal data by requesting fake record IDs.

How many can I own data?

klaf can make a unsigned 32bit range of page block. This is a 4,294,967,296. And each page can own unsigned 32bit range of records also. So you can theoretically insert 4,294,967,295 * 4,294,967,295 records.

Performance Test

The test result is the average value from 10 attempts.
The latest performance benchmarking was conducted based on version 2.0.6.

klaf supports two databases, and this test tested the core functions of data reading/writing of the two databases. Therefore, it's not a perfect test result, but it's enough to show the time complexity.

If you're adding data to the database in real-time, the results would be as follows:

WRITE

Overall, Klaf supports faster writes than JSON. As the size increases, this gap becomes even larger.

`WRITE`	JSON	KLAF	`RESULT`
1,000 times	1014ms	864ms	*+15% Faster*
2,000 times	2200ms	1700ms	*+23% Faster*
4,000 times	5674ms	3163ms	*+44% Faster*
8,000 times	15332ms	5925ms	*+61% Faster*

READ

klaf maintains a steady reading speed no matter the database size. In contrast, JSON files slow down as they get bigger.

`READ`	JSON	KLAF	`RESULT`
from 8,000 records	1.8ms	2ms	-10% Slower
from 16,000 records	4ms	2ms	*+100% Faster*
from 32,000 records	5.4ms	2ms	*+170% Faster*
from 64,000 records	11.4ms	2ms	*+470% Faster*
from 128,000 records	26.4ms	2ms	*+1220% Faster*

RESULT

WRITE READ

NOTICE!

This is the usual case, but the results can be different depending on programming optimizations. Please note that this test takes a square of the sample size to easily show the error with a small number of tests. Therefore, the graph appears to increase exponentially, but in terms of time complexity, JSON has O(n), and klaf has a speed of O(1) or O(log n).