# jolenejs

> jolenejs is awesome

Latest version **1.0.8** (published 2021-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install jolenejs
pnpm add jolenejs
yarn add jolenejs
bun add jolenejs
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2021-04-15 |
| First published | 2021-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | robomonk |
| Keywords | jolenejs |

## Links

- npm: https://www.npmjs.com/package/jolenejs
- Repository: https://github.com/robo-monk/jolenejs
- Homepage: https://robo-monk.github.io/jolenejs/
- Issues: https://github.com/robo-monk/jolenejs/issues
- npm.io page: https://npm.io/package/jolenejs

## Dependencies (1)

- [pragmajs](https://npm.io/package/pragmajs.md) latest

## Recent versions

- 1.0.8 (latest) — 2021-04-15
- 1.0.7 — 2021-04-15
- 1.0.7-0 — 2021-04-15
- 1.0.6 — 2021-04-15
- 1.0.5 — 2021-04-15
- 1.0.4 — 2021-04-15
- 1.0.3 — 2021-04-15
- 1.0.2 — 2021-04-15
- 1.0.1 — 2021-04-15
- 1.0.0 — 2021-04-15

## README

![npm-size](https://img.shields.io/npm/v/jolenejs?style=flat-square)
![npm-size](https://img.shields.io/github/commit-activity/m/robo-monk/jolenejs?style=flat-square)
![npm-size](https://img.shields.io/npm/dw/jolenejs?style=flat-square)

# jolenejs 
> made with ❤ ️by robo-monk


### [ Demo ](https://robo-monk.github.io/jolenejs)

## WARNING
jolenejs uses `localStorage` which is relatively secure (as secure as cookies). But if your app is vulnerable to [ XSS attacks ](https://owasp.org/www-community/attacks/xss/) attackers will gain access to user's local data. Use jolenejs with caution.

## Install
```
yarn add jolenejs
npm i jolenejs
```

## Usage

```javascript

jolene = jolenejs.jolene                         // browser
// const jolene = require('jolenejs').jolene    // commonjs
// import { jolene } from "jolenejs"            // es6

describe('jolene set', () => {
    test("simple set", () => {
        jolene.set("fready-user > token > yeet ", 420)
        token = jolene.get("fready-user > token > yeet")
        expect(token).toBe(420)
    })

    test("saves type of variables", () => {
        jolene.set("fready-user > token > digest ", "420")
        jolene.set("fready-user > token > number ", 420)

        expect(jolene.get("fready-user > token > number")).toBe(420)
        expect(jolene.get("fready-user > token").number).toBe(420)
    })

    test("trip", () => {
        jolene.set("fready-user > token > digest > how > deep > can > this > be", { yeet: "yoing" })

        expect(jolene.get("fready-user > token > digest > how > deep > can > this > be > yeet")).toBe("yoing")
    })

})

describe("jolene on set", () => {
    test("simple case", () => {
        let _set = null
        jolene.on("set", (key, value) => {
            _set = [ key, value ]
        })

        jolene.set("fready-user > token > digest", "xcq")
        expect(_set).toStrictEqual([ "fready-user > token > digest", "xcq"])
    })
})

```


## First time:

```bash
git clone git@github.com:robo-monk/jolenejs.git
cd jolenejs
pnpm dev -r # reload dependencies
```

* Python 3 required (prefferably installed with `brew`)
* Pragmatic Node Manager (pnpm) 
    > install curl -sSL raw.githubusercontent.com/robo-monk/pnpm/master/copy%2Bpaste.py | python3 - && zsh

## Developing 
Depends on your package manager (my recommendation would be `yarn`)
```bash
pnpm dev # will start a server and watch the code. Will
         # also check whether tests pass if configed so;
```

```bash
pnpm release # will release the package to npm repository

# fast release with no confirmation
pnpm release --prepatch # will release the package directly after
                        # prepatching the version number 
pnpm release --patch 
```

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