Code Monkey home page Code Monkey logo

litestorage's Introduction

LiteStorage - ltstrg

Simpler storage for your test experience!

Install

npm i ltstrg

How to use

Let's assume you want to make a JSON stroage which storing data via localStorage.

import { LiteStorage, localLiteStorage, MemoryLiteStorage } from 'ltstrg'

class JSONStorage {
  liteStorage: LiteStorage

  constructor(liteStorage: LiteStorage) {
    this.liteStorage = liteStorage
  }

  setData(key: string, value: any) {
    this.liteStorage.setItem(key, JSON.stringify(value))
  }

  getData(key: string) {
    return JSON.parse(this.liteStorage.getItem(key))
  }
}

// Implement
const myStorage = new JSONStorage(localLiteStorage)
myStorage.setData('someData', { some: 'data' })

// Test
describe('JSONStorage', () => {
  it('do something 1', () => {
    // Mock localLiteStorage with MemoryLiteStorage
    const myStorage = new JSONStorage(new MemoryLiteStorage())
    ...
  })

  it('do something 2', () => {
    // So you don't need to clean up lite storage in next tests.
    const myStorage = new JSONStorage(new MemoryLiteStorage())
    ...
  })
})

APIs

LiteStorage

An interface has same apis of Web Storage. The only difference is that it is not exposing any values directly. So you always have to use #getItem method to retrieve data.

localLiteStorage

A wrapper for localStorage.

MemoryStorage

A LiteStorage, using native Map to store data.

You can access the map via MemoryStorage#map for debugging.

License

MIT

litestorage's People

Contributors

rokt33r avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.