Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fed135/ha-store
Efficient data fetching for your Javascript Applications
https://github.com/fed135/ha-store
cache dataloader hacktoberfest javascript nodejs
Last synced: about 1 month ago
JSON representation
Efficient data fetching for your Javascript Applications
- Host: GitHub
- URL: https://github.com/fed135/ha-store
- Owner: fed135
- License: other
- Created: 2018-04-26T11:52:26.000Z (over 6 years ago)
- Default Branch: next
- Last Pushed: 2023-11-23T06:48:47.000Z (about 1 year ago)
- Last Synced: 2024-10-29T01:12:17.852Z (about 2 months ago)
- Topics: cache, dataloader, hacktoberfest, javascript, nodejs
- Language: JavaScript
- Homepage: https://ha-store.js.org
- Size: 1.55 MB
- Stars: 79
- Watchers: 10
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- montreal - HA-store - A data loader for your node projects. (Projects)
README
High-Availability store
Efficient data fetching
[](https://www.npmjs.com/package/ha-store)
[](https://nodejs.org)
[](https://github.com/fed135/ha-store/security/dependabot)
---
**HA-store** is a wrapper for your data queries, it features:
- Smart TLRU cache for 'hot' information
- Supports mutliple caching levels
- Request coalescing and batching (solves the [Thundering Herd problem](https://en.wikipedia.org/wiki/Thundering_herd_problem))
- Insightful stats and [events](#Monitoring-and-events)
- Lightweight, configurable, battle-tested
Learn how you can improve your app's performance, design and resiliancy [here](https://github.com/fed135/ha-store/wiki)!
## Installing
`npm install ha-store`
## Usage
```javascript
// Create your store
const store = require('ha-store');
const itemStore = store({
resolver: getItems,
delimiter: ['language']
});
// Define your resolver
function getItems(ids, params, contexts) {
// Ids will be a list of all the unique requested items
// Params will be the parameters for the request, which must be declared in the `delimiter` config of the store
// Contexts will be the list of originating context information
// Now perform some exensive network call or database lookup...
// Then, respond with your data formatted into this formats:
// { '123': { language: 'fr', name: 'fred' } }
}
// Now to use your store
itemStore.get('123', { language: 'fr' }, { requestId: '123' })
.then(item => /* The item you requested */);
// You can even ask for more than one item at a time
itemStore.getMany(['123', '456'], { language: 'en' }, { requestId: '123' })
.then(items => /* All the items you requested, in Promise.allSettled fashion */);
```
## Options
Name | Required | Default | Description
--- | --- | --- | ---
resolver | true | - | The method to wrap, and how to interpret the returned data. Uses the format ``
delimiter | false | `[]` | The list of parameters that, when passed, generate unique results. Ex: 'language', 'view', 'fields', 'country'. These will generate different combinations of cache keys.
cache | false |
{
enabled: false,
tiers: [
{
store: <instance of a store>,
limit: 5000,
ttl: 300000
}
]
} | A list of storage tiers for the data. The order indicates where to look first. It's recommended to keep an instance of an in-memory store, like `ha-store/stores/in-memory` as the first one, and then expend to external stores like [ha-store-redis](https://github.com/fed135/ha-redis-adapter). Caching options for the data - `limit` - the maximum number of records, and `ttl` - time to live for a record in milliseconds.
batch | false | {
enabled: false,
delay: 50,
limit: 100
} | Batching options for the requests - `delay` is the amount of time to wait before sending the batch, `limit` is the maximum number of data items to send in a batch.
*All options are in (ms)
## Monitoring and events
HA-store emits events to track cache hits, miss and outbound requests.
Event | Format | Description
--- | --- | ---
localCacheHit | `` | When the requested item is present in the first listed local store (usually in-memory).
cacheHit | `` | When the requested item is present in a store.
cacheMiss | `` | When the requested item not cached or coalesced and must be fetched.
coalescedHit | `` | When a record query successfully hooks to the promise of the same record in transit.
query | `` | When a batch of requests is about to be sent, gives the detail of the query and what triggered it.
queryFailed | `` | Indicates that the batch has failed. Retry policy will dictate if it should be re-attempted.
querySuccess | `` | Indicates that the batch request was successful.
You may also want to track the amount of `contexts` and `records` stored via the `size` method.
## Testing
`npm test`
## Benchmarks
Read instructions [here](./tests/profiling/README.md)
`npm run bench`
## Contribute
Please do! This is an open source project - if you see something that you want, [open an issue](https://github.com/fed135/ha-store/issues/new) or file a pull request.
I am always looking for more maintainers, as well.
## License
[Apache 2.0](LICENSE) (c) Frederic Charette