keg

2.1.0 • Public • Published

keg

This is a simple registry that is used by nokku to track local service installations and versions. Could be used to store any versioned data though.

NOTE: Uses more restrictive slimver versioning over semver, so be aware of those limitations.

NPM

unstable Build Status

Endpoints

PUT /:store/:name/:version

Put a versioned, named payload of JSON metadata into the registry.

GET /:store/:name/:version

Get a versioned, named payload of JSON metadata from the :store registry.

GET /:store/:name/:range

Get the latest version of a package that satisfies the supplied slimver range.

GET /:store/name

Get the latest version of a named payload of JSON metadata from the registry.

Changes Feed

A couchdb like changes feed is provied at the _changes endpoint, with various options as outlined below:

GET /:store/_changes

Get all the changes since the beginning of keg data. End once we have hit the last known change.

The following querystring options are supported:

  • since=%timestamp%

    get all the changes since the specified monontonic-timestamp.

  • includeDocs=true

    get the docs in addition to the package and version information associated with a change

  • live=true

    once we hit the end continue to listen for new changes.

Usage

To be completed.

License(s)

MIT

Copyright (c) 2014 Damon Oehlman damon.oehlman@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i keg

Weekly Downloads

0

Version

2.1.0

License

MIT

Last publish

Collaborators

  • damonoehlman