https://github.com/iamsebastiandev/flotsam

A lightweight, dependency free, in memory storage, json document based database written in TypeScript.
https://github.com/iamsebastiandev/flotsam

database dependency-free json-document nodejs typescript

Last synced: about 1 year ago
JSON representation

A lightweight, dependency free, in memory storage, json document based database written in TypeScript.

• Host: GitHub
• URL: https://github.com/iamsebastiandev/flotsam
• Owner: IamSebastianDev
• License: mit
• Created: 2022-11-20T11:39:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-05T21:51:49.000Z (over 2 years ago)
• Last Synced: 2024-04-26T00:08:07.935Z (about 2 years ago)
• Topics: database, dependency-free, json-document, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 1010 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: docs/readme.md
  • Contributing: contributing.md
  • License: license.md

Awesome Lists containing this project

README

          


# Fløtsam

In depth documentation for `1.2.0`

## API Documentation

The main database instance class is created using the **[Flotsam](./db/Flotsam.md)** class. All operations concerning **[Collections](./db/Collection.md)** as well as the general setup of the database is done here.

**[Collections](./db/Collection.md)** can be queried using [`Find Options`](./db/FindOptions.md) and [`Evaluators`](./evaluators/evaluators.md). [Schema Validation](./validators/schema-validation.md) is done via [`Validator Functions`](./validators/validators.md).

## Examples

The `examples` directory contains examples on how to use **Fløtsam**

-   [ts-node](./examples/ts-node.md)

-   [express](./examples/express.md)