https://github.com/jabranr/js-memcache
Store data in memory for better performance by saving on network requests.
https://github.com/jabranr/js-memcache
cache in-memory-storage javascript nodejs requirejs
Last synced: 2 months ago
JSON representation
Store data in memory for better performance by saving on network requests.
- Host: GitHub
- URL: https://github.com/jabranr/js-memcache
- Owner: jabranr
- License: mit
- Created: 2016-12-26T02:45:35.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-10-28T23:42:57.000Z (over 2 years ago)
- Last Synced: 2025-02-16T01:06:45.172Z (over 1 year ago)
- Topics: cache, in-memory-storage, javascript, nodejs, requirejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/js-memcache
- Size: 43.9 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSMemcache [](https://travis-ci.org/jabranr/js-memcache) [](https://www.npmjs.com/package/js-memcache)
Store data in memory for better performance by saving on network requests. (~600 bytes – minified and gzipped)
# Installation
#### Using [npm](https://npmjs.org):
```shell
$ npm install js-memcache --save-dev
```
#### Using [bower](https://bower.io):
```shell
$ bower install js-memcache --save-dev
```
#### In browser:
`JSMemcache` is available via namespace `JSMemcache` in browsers' global scope i.e.
```html
const jsMemcache = new JSMemcache(); // available via window.JSMemcache
...
```
#### In node / Using CommonJS:
`JSMemcache` can be setup in node as following i.e.
```javascript
const JSMemcache = require('JSMemcache');
const jsMemcache = new JSMemcache();
...
```
#### Using AMD (RequireJS):
`JSMemcache` can be setup as following using RequireJS i.e.
```javascript
require(['path/to/JSMemcache'], function(JSMemcache) {
const jsMemcache = new JSMemcache();
...
});
```
# API
JSMemcache exposes following API:
#### `.setLimit(limit {int})`
Set cache maximum limit. Default is set to 100 entries.
#### `.setSeparator(separator {string})`
Set a key separator for each entry in cache. Default is `+`.
#### `.getLimit()`
Get cache's current limit.
#### `.getSeparator()`
Get cache's current separator.
#### `.getSize()`
Get cache's current size.
#### `.add(key {string|array}, value {mixed})`
Add a new entry into cache as key value pair. Throws a `TypeError` if key is neither a `string` nor an `array`.
#### `.get(key {string|array})`
Get an entry by key from cache.
#### `.update(key {string|array}, value {mixed})`
Update an entry by key in cache. Throws a `ReferenceError` if key does not exist in cache.
#### `.remove(key {string|array})`
Remove an entry by key from cache. Throws a `ReferenceError` if key does not exist in cache.
#### `.all()`
Get list of all entries in cache.
#### `.keys()`
Get list of keys for all entries in cache.
#### `.clear()`
Clear all data in cache and remove all entries.
#### `.set(key {string|array}, value {mixed})`
An alias for `.add()`
#### `.replace(key {string|array}, value {mixed})`
An alias for `.update()`
# Issues / Contributing
If you find an issue or wish to suggest any improvements then use the [issue tracker](https://github.com/jabranr/js-memcache/issues/new) to file an issue. Please provide as much possible details in there. Even better that you can submit a pull request for your issue if you already have a solution in mind.
Contribution is most welcome. To cotribute, fork the repository and branch out from `master` for your changes. Make sure you update/add tests. This repository uses the fantastic and super easy-to-use testing framework [AVA](https://github.com/avajs/ava). Once ready [open a pull request](https://github.com/jabranr/js-memcache/compare).
# License
MIT License
© 2016 – Jabran Rafique