3.1.0 • Published 12 months ago

@losting/ls v3.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

ls

Easy localStorage

Usage

npm install @losting/ls

ES Module

import * as ls from '@losting/ls';

set('name', 'admin');

// json data
set('data', {
  name: '张三',
  password: '12345678',
});

// Set expiration time and enable simple encryption.
set('password', '12345678', {
  expires: 1000 * 60 * 60 * 24 * 7,
  encrypt: true,
});

CDN

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>example page</title>
  <script src="https://unpkg.com/@losting/ls@3.0.0/dist/ls.iife.js"></script>
</head>
<body>
  <div id="app"></div>
  <script>
    window.$ls.set('key', 'value');
    // ...
  </script>
</body>
</html>

setPrefix

import { setPrefix } from '@losting/ls';

// setPrefix(prefix: string)
setPrefix('__EXAMPLE_');

set

import { set } from '@losting/ls';

// set(key: string, value: unknown, option?: { expires?: number, encrypt?: boolean })
set('key', 'value');
// or
set('key', 'value', {
  expires: 0, // 0 or undefined mean never expire. 3000 means expire after 3 seconds
  encrypt: false, // Whether to encrypt
});

get

import { get } from '@losting/ls';

const value = get('key');

// use callback
const value = get('token', ({value, expires}) => {
  if (expires - Date.now() <= 1000 * 60 * 5) {
    // do something
    // return custom value
  }
  return value;
});

remove

import { remove } from '@losting/ls';

// remove(key: string)
remove('key');

clear

import { clear } from '@losting/ls';

clear();
3.1.0

12 months ago

3.0.0

12 months ago

2.0.1

1 year ago

2.0.0

1 year ago

1.1.0-alpha.1

2 years ago

1.1.0-alpha.2

2 years ago

1.1.0-alpha.0

2 years ago

1.1.0-alpha.5

2 years ago

1.1.0-alpha.4

2 years ago

1.0.0

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago