# @types/jfs

> TypeScript definitions for jfs

Latest version **0.2.9** (published 2023-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jfs
pnpm add @types/jfs
yarn add @types/jfs
bun add @types/jfs
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.9 |
| Published | 2023-11-22 |
| First published | 2017-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51372 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jfs
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jfs
- npm.io page: https://npm.io/package/@types/jfs

## Recent versions

- 0.2.9 (latest) — 2023-11-22
- 0.2.5 (ts3.8) — 2021-12-16
- 0.2.4 (ts3.6) — 2021-07-08
- 0.2.3 (ts2.1) — 2019-02-13
- 0.2.8 — 2023-11-07
- 0.2.7 — 2023-10-18
- 0.2.6 — 2023-09-15
- 0.2.2 — 2017-08-21
- 0.2.1 — 2017-03-24
- 0.2.0 — 2017-01-19

## README

# Installation
> `npm install --save @types/jfs`

# Summary
This package contains type definitions for jfs (https://github.com/flosse/json-file-store).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jfs.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jfs/index.d.ts)
````ts
declare const JsonFileStore: JsonFileStore.JsonFileStore;

declare namespace JsonFileStore {
    interface Storable {
        [key: string]: any;
    }

    interface Options {
        type?: "single" | "memory" | undefined;
        pretty?: boolean | undefined;
        saveId?: boolean | string | undefined;
    }

    interface JsonFileStore {
        new<T extends Storable>(name?: string, opts?: Options): Instance<T>;
    }

    interface Instance<T> {
        save<K extends keyof T, V extends T[K]>(id: K, o: V, cb?: (err?: Error, id?: K) => void): void;
        save<V extends T[keyof T]>(o: V, cb?: (err?: Error, id?: string) => void): void;

        saveSync<K extends keyof T, V extends T[K]>(id: K, o: V): void;
        saveSync<V extends T[keyof T]>(o: V): void;

        get<K extends keyof T, V extends T[K]>(id: K, cb?: (err?: Error, o?: V) => void): void;

        getSync<K extends keyof T, V extends T[K]>(id: K): V | Error;

        delete<K extends keyof T>(id: K, cb?: (err?: Error) => void): void;

        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
        deleteSync<K extends keyof T>(id: K): Error | void;

        all(cb: (err?: Error, all?: T) => void): void;

        allSync(): T;
    }
}

export = JsonFileStore;

````

### Additional Details
 * Last updated: Wed, 22 Nov 2023 00:24:48 GMT
 * Dependencies: none

# Credits
These definitions were written by [Tomasz Łaziuk](https://github.com/tlaziuk).

---
_Source: https://npm.io/package/@types/jfs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._