Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.46 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.46 KB

semver-store

js-standard-style Build Status

An extremely fast semver based store.

Install

npm i semver-store

Usage

Use it is very easy, you just need to require the library and start adding values.

const store = require('semver-store')()

store.set('1.2.0', { value: 42 })

console.log(
  store.get('1.2.0') // { value: 42 }
)

API

set(version, store)

Add a document to the store with the specified version.
The version must be conform with the semver specification.

get(version)

Get a document from the store with the specified version.
The version string could be a full version string or specify a range, such as 1.x, in which case the highest version compatible will be returned. Specify * to get the highest version available.

del(version)

Deletes a document from the store with the specified version.
The version string could be a full version string or specify a range, such as 1.x, in which case all the compatible values will be deleted.

empty()

Empties the store.

Why is fast?

Internally uses a prefix tree, which allows the search to be extremely performant.

License

Licensed under MIT.