Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenvachon/urlcache
Normalized URL key-value cache.
https://github.com/stevenvachon/urlcache
cache data-structure nodejs url whatwg
Last synced: 3 months ago
JSON representation
Normalized URL key-value cache.
- Host: GitHub
- URL: https://github.com/stevenvachon/urlcache
- Owner: stevenvachon
- License: mit
- Created: 2015-07-30T00:34:05.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-02-27T22:52:58.000Z (almost 4 years ago)
- Last Synced: 2024-10-06T04:24:17.204Z (3 months ago)
- Topics: cache, data-structure, nodejs, url, whatwg
- Language: JavaScript
- Homepage:
- Size: 39.1 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# urlcache [![NPM Version][npm-image]][npm-url] ![File Size][filesize-image] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency Monitor][greenkeeper-image]][greenkeeper-url]
> Normalized [`URL`](https://mdn.io/URL/) key-value cache.
In an effort to prevent duplicates, unnecessary URL components will be (optionally) reduced/normalized.
## Installation
[Node.js](https://nodejs.org) `>= 14` is required. To install, type this at the command line:
```shell
npm install urlcache
```
## Constructor
```js
const URLCache = require('urlcache');
const cache = new URLCache(options);
```
## Methods & Properties
### `.clean()`
Removes all stored key-value pairs that have expired.
### `.clear()`
Removes all stored key-value pairs.
### `.delete(url)`
Removes the `url` key-value pair.
### `.get(url)`
Returns the stored value for `url`, or `undefined` if there is none.
### `.has(url)`
Returns `true` if there is a stored value for `url`.
### `.length`
Returns the number of stored key-value pairs.
### `.set(url, value[, options])`
Stores `value` (any type) associated with `url` key. Optionally, define `options` to override any defined in the constructor.
```js
const url = new URL('http://domain/');
cache.set(url, {'key':'value'});
cache.get(url); //-> {'key':'value'}
cache.set(url, new Promise(resolve => {
// set value after some delayed event
setTimeout(() => resolve('value'), 500);
});
console.log(await cache.get(url)); //-> 'value'
```
## Options
### `carefulProfile`
Type: `Object`
Default value: see [minurl option profiles](https://npmjs.com/minurl#option-profiles)
A configuration of normalizations performed on URLs to hosts that may not be configured correctly or ideally.
### `commonProfile`
Type: `Object`
Default value: see [minurl option profiles](https://npmjs.com/minurl#option-profiles)
A configuration of normalizations performed on URLs to hosts that you expect to be configured correctly and ideally.
### `maxAge`
Type: `Number`
Default value: `Infinity`
The number of milliseconds in which a cached value should be considered valid.
### `profile`
Type: `String`
Default value: `'common'`
The URL normalization profile. For example, value of `'common'` will use `commonProfile`.
### Default Options
`URLCache.DEFAULT_OPTIONS` is available for customizable extension.
[npm-image]: https://img.shields.io/npm/v/urlcache.svg
[npm-url]: https://npmjs.org/package/urlcache
[filesize-image]: https://img.shields.io/badge/bundle-40kB%20gzipped-blue.svg
[travis-image]: https://img.shields.io/travis/stevenvachon/urlcache.svg
[travis-url]: https://travis-ci.org/stevenvachon/urlcache
[coveralls-image]: https://img.shields.io/coveralls/stevenvachon/urlcache.svg
[coveralls-url]: https://coveralls.io/github/stevenvachon/urlcache
[greenkeeper-image]: https://badges.greenkeeper.io/stevenvachon/urlcache.svg
[greenkeeper-url]: https://greenkeeper.io/