v1.2.2 - Fix network error on background, auto-retry streaming with reconnect
This commit is contained in:
70
node_modules/@kvs/storage/README.md
generated
vendored
Normal file
70
node_modules/@kvs/storage/README.md
generated
vendored
Normal file
@@ -0,0 +1,70 @@
|
||||
# @kvs/storage
|
||||
|
||||
Storage-like for KVS.
|
||||
|
||||
You can inject Storage object like localStorage, sessionStorage to this storage.
|
||||
|
||||
## Install
|
||||
|
||||
Install with [npm](https://www.npmjs.com/):
|
||||
|
||||
npm install @kvs/storage
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import assert from "assert";
|
||||
import { kvsStorage } from "@kvs/storage";
|
||||
(async () => {
|
||||
type StorageSchema = {
|
||||
a1: string;
|
||||
b2: number;
|
||||
c3: boolean;
|
||||
};
|
||||
const storage = await kvsStorage<StorageSchema>({
|
||||
name: "test",
|
||||
version: 1,
|
||||
storage: localStorage
|
||||
});
|
||||
await storage.set("a1", "string");
|
||||
await storage.set("b2", 42);
|
||||
await storage.set("c3", false);
|
||||
const a1 = await storage.get("a1");
|
||||
const b2 = await storage.get("b2");
|
||||
const c3 = await storage.get("c3");
|
||||
assert.strictEqual(a1, "string");
|
||||
assert.strictEqual(b2, 42);
|
||||
assert.strictEqual(c3, false);
|
||||
})();
|
||||
```
|
||||
|
||||
## Changelog
|
||||
|
||||
See [Releases page](https://github.com/azu/kvs/releases).
|
||||
|
||||
## Running tests
|
||||
|
||||
Install devDependencies and Run `npm test`:
|
||||
|
||||
npm test
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests and stars are always welcome.
|
||||
|
||||
For bugs and feature requests, [please create an issue](https://github.com/azu/kvs/issues).
|
||||
|
||||
1. Fork it!
|
||||
2. Create your feature branch: `git checkout -b my-new-feature`
|
||||
3. Commit your changes: `git commit -am 'Add some feature'`
|
||||
4. Push to the branch: `git push origin my-new-feature`
|
||||
5. Submit a pull request :D
|
||||
|
||||
## Author
|
||||
|
||||
- [github/azu](https://github.com/azu)
|
||||
- [twitter/azu_re](https://twitter.com/azu_re)
|
||||
|
||||
## License
|
||||
|
||||
MIT © azu
|
||||
Reference in New Issue
Block a user