https://github.com/owen3h/json-simple-store

A simple way of storing and modifying JSON files locally.
https://github.com/owen3h/json-simple-store

fs json localstorage node npm storage

Last synced: 3 months ago
JSON representation

A simple way of storing and modifying JSON files locally.

• Host: GitHub
• URL: https://github.com/owen3h/json-simple-store
• Owner: Owen3H
• Created: 2022-08-12T15:02:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T21:19:22.000Z (6 months ago)
• Last Synced: 2024-10-14T01:13:21.427Z (4 months ago)
• Topics: fs, json, localstorage, node, npm, storage
• Language: TypeScript
• Homepage: https://npmjs.com/package/json-simple-store
• Size: 70.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# json-simple-store

A simple KV store, where entries are both cached for current use, and stored in a JSON file as a database.

**Note:** This type of local DB will not work on hosting solutions with ephemeral storage.

While the library has a similar syntax to `Map`, it is actually a plain object (`Record`) matching the structure of JSON.\

This means you can **only use strings for keys**.

## Installation

## Creating a store

Constructs a new store with an optional path.

If no path is specified, it defaults to `default_store.json`

> [!WARNING]

> When a store is created with a path to a file that already exists, the new store is able to overwrite it!

```ts

const customStore = new JSONStore('custom_store.json')

const defaultStore = new JSONStore()

```

## Documentation

**Set** (`set(key: string, value: any) => Promise`)\

Overwrites or adds a new entry to the file.\

Returns a boolean indicating whether writing to the file succeeded.

```ts

const saved = await store.set('myObject', { test: { count: 69 } })

// Not allowed!

await store.set(420, { test: { count: 69 } })

```

**Get** `get(key: string, skipCache?: boolean) => Promise`\

Gets the value associated with the given key.

By default, it will try to use the cached value to prevent reading from the file.\

You can specify `true` as the last argument To skip the cache and always access the DB.

```ts

interface MyObject {

    test: {

        count: number

        timestamp?: number

    }

}

const obj = await store.get('myObject')

const { count, timestamp } = obj.test

```

**Clear** (`clear() => Promise`)\

Clears every entry by writing an empty object to the file.\

Like `set`, this also returns a boolean indicating whether the file write succeeded.

```ts

```

**Exists** (`exists() => Promise`)\

Whether the file at the absolute path (made when constructing the store) still exists.

```ts

const store = new JSONStore('example_store.json')

const created = await store.exists()

```