# gj-state

> ## Installation In order to add this package to your service, make sure you are logged in to your npm account. Inside your project folder run the following command: ``` npm i gs-state ```

Latest version **1.0.7** (published 2020-05-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install gj-state
pnpm add gj-state
yarn add gj-state
bun add gj-state
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2020-05-16 |
| First published | 2020-05-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | garysjennings |

## Links

- npm: https://www.npmjs.com/package/gj-state
- npm.io page: https://npm.io/package/gj-state

## Recent versions

- 1.0.7 (latest) — 2020-05-16
- 1.0.2 — 2020-05-16
- 1.0.1 — 2020-05-16
- 1.0.0 — 2020-05-16

## README

# gj-state

## Installation
In order to add this package to your service, make sure you are logged in to your npm account. Inside your project folder run the following command:
```
npm i gs-state
```

## API
Input:
```js

    mode: 'serverless' | 'none' // default serverless
    filePath: String | false  // default false

```

Output:
```js
{
    read(projectRoot: String),
    remove(projectRoot: String),
    write(projectRoot: String)
}

```


## Usage 2
```js
const setupState = require('gj-state')
const state = setupFs()

const main = async () => {
    await state.write(__dirname, {
        data: 'something'
    })

    const data = await state.read(__dirname)
    await state.remove(__dirname)
   
}

```

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