Rich document ids for CouchDB
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Go to file
Johannes J. Schmidt eb4f8732b5 test on current versions 10 years ago
test first commit 10 years ago
.gitignore first commit 10 years ago
.travis.yml test on current versions 10 years ago
README.md travis badge 10 years ago
index.js first commit 10 years ago
package.json first commit 10 years ago

README.md

docuri Build Status

Rich document ids for CouchDB.

type/id/subtype/version/index

eg movie/blade-runner/gallery-image/medium/12

Usage

Parse id string:

require('docuri').parse('mytype/myid/mysubtype/myversion/myindex');
// {
//   type: 'mytype',
//   id: 'myid',
//   subtype: 'mysubtype',
//   version: 'myversion',
//   index: 'myindex'
// }

Build id string from object:

require('docuri').stringify({
  type: 'mytype',
  id: 'myid',
  subtype: 'mysubtype',
  version: 'myversion',
  index: 'myindex'
});
// 'mytype/myid/mysubtype/myversion/myindex'

Development

To run the unit tests:

npm test

For JShint:

npm run jshint

License

Copyright (c) 2014 Johannes J. Schmidt, null2 GmbH
Licensed under the MIT license.