Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feathersjs-ecosystem/feathers-localstorage
A client side service based on feathers-memory that persists to LocalStorage
https://github.com/feathersjs-ecosystem/feathers-localstorage
Last synced: about 2 months ago
JSON representation
A client side service based on feathers-memory that persists to LocalStorage
- Host: GitHub
- URL: https://github.com/feathersjs-ecosystem/feathers-localstorage
- Owner: feathersjs-ecosystem
- License: mit
- Created: 2016-02-23T06:03:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-30T10:17:01.000Z (over 1 year ago)
- Last Synced: 2024-10-31T09:25:54.514Z (2 months ago)
- Language: JavaScript
- Size: 2.81 MB
- Stars: 38
- Watchers: 8
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - feathers-localstorage - feathers-logo.png) (Plugins / Database)
README
# feathers-localstorage
[](https://greenkeeper.io/)
[](https://travis-ci.org/feathersjs-ecosystem/feathers-localstorage)
[](https://david-dm.org/feathersjs-ecosystem/feathers-localstorage)
[](https://www.npmjs.com/package/feathers-localstorage)
[feathers-localstorage](https://github.com/feathersjs-ecosystem/feathers-localstorage/) is a database service adapter that extends [feathers-memory](./memory.md) and stores data in [localStorage](https://developer.mozilla.org/en/docs/Web/API/Window/localStorage) in the browser or [AsyncStorage](https://facebook.github.io/react-native/docs/asyncstorage.html) in React Native.
```bash
$ npm install --save feathers-localstorage
```
> __Important:__ This branch only works for FeathersJS Dove (v5). Please choose a non-pre release for other versions of FeathersJS.
> __Important:__ `feathers-localstorage` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
## API
### `service(options)`
Returns a new service instance initialized with the given options.
```js
const service = require('feathers-localstorage');
app.use('/messages', service({
storage: window.localStorage || AsyncStorage
}));
app.use('/messages', service({ storage, id, startId, name, store, paginate }));
```
__Options:__
- `storage` (**required**) - The local storage engine. You can pass in the browsers `window.localStorage`, React Native's `AsyncStorage` or a NodeJS localstorage module.
- `throttle` (*optional*, default `200`) - The minimum time (ms) before in-memory data is written to `storage`. Data is only written if changed since last write.
- `id` (*optional*, default: `'id'`) - The name of the id field property.
- `startId` (*optional*, default: `0`) - An id number to start with that will be incremented for new record.
- `name` (*optional*, default: `'feathers'`) - The key to store data under in local or async storage.
- `store` (*optional*) - An object with id to item assignments to pre-initialize the data store.
- `events` (*optional*) - A list of [custom service events](https://docs.feathersjs.com/api/events.html#custom-events) sent by this service.
- `paginate` (*optional*) - A [pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination) containing a `default` and `max` page size.
- `whitelist` (*optional*) - A list of additional query parameters to allow.
- `multi` (*optional*) - Allow `create` with arrays and `update` and `remove` with `id` `null` to change multiple items. Can be `true` for all methods or an array of allowed methods (e.g. `[ 'remove', 'create' ]`).
- `reuseKeys` (*optional*, default: `false`) Allow duplicate keys i.e. last definition wins. Mostly useful for demonstration and testing purposes.
## Example
See the [clients](https://docs.feathersjs.com/api/client.html) chapter for more information about using Feathers in the browser and React Native.
### Browser
```html
var service = feathers.localstorage({
storage: window.localStorage
});
var app = feathers().use('/messages', service);
var messages = app.service('messages');
messages.on('created', function(message) {
console.log('Someone created a message', message);
});
messages.create({
text: 'Message created in browser'
});
```
### React Native
```bash
$ npm install @feathersjs/feathers feathers-localstorage --save
```
```js
import React from 'react-native';
import feathers from '@feathersjs/feathers';
import localstorage from 'feathers-localstorage';
const { AsyncStorage } = React;
const app = feathers()
.use('/messages', localstorage({ storage: AsyncStorage }));
const messages = app.service('messages');
messages.on('created', function(message) {
console.log('Someone created a message', message);
});
messages.create({
text: 'Message from React Native'
});
```
## License
Copyright (c) 2017
Licensed under the [MIT license](LICENSE).