lis-db v2.0.0

lis-db

LIS (Local Interface for Storage), is a "key-value" frontend database builded on indexedDB and with Typescript support.

API

The library offers one object (lis as default import) & one class (Key)

Key

Is used to identify the values in the database. Using it you can provide the target (string that represents the id of the item in the database) and a defaultValue (to be used by default when this key is used to read the database)

import { Key } from 'lis-db'

const KEY = new Key( 'key', 'default value' )

lis.write

lis.write<T>( key:Key<T>, value:T ): Promise<void> Can save persistent data with key-value structure.

import lis, { Key } from 'lis-db'

const HELLO = new Key( 'hello', '' )

lis.write( HELLO, 'Hello World!' ).then( () => {
  console.log( 'Data Saved' )
} )

lis.read

lis.read<T>( key:Key<T> ): Promise<T[> Is used to read data from the database. The type of the value provided by the Key object as default is used as the type of the resulting request

import lis, { Key } from 'lis-db'

const HELLO = new Key( 'hello', '' )  // Default value is an empty string
lis.read( HELLO ).then( ( value:string ) => {  // The value is the same type of defaultValue
  console.log( value ) // 'Hello World!'
} )

Using default value

import lis, { Key } from 'lis-db'

// "x" was not written
const X = new Key( 'x', 'x was not declared' )
lis.read( X ).then( ( value:string ) => {
  console.log( value )  // 'x was not delcared'
} )

lis.erase

erase( key:string ): Promise<void> is used to erase data from the database

import lis, { Key } from 'lis-db'

const HELLO = new Key( 'key', '' )

lis.read( HELLO ).then( ( value:string ) => {
  console.log( value )  // 'Hello World!'
  lis.erase( HELLO ).then( () => {
    // Waiting for erase data to read it
    lis.read( HELLO ).then( ( value:string ) => {
      console.log( hello )  // ''
    } )
  } )
} )