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 1a46dcccc3 bump version 11 years ago
test allow 0 as path element (closes #2) 11 years ago
.gitignore first commit 11 years ago
.travis.yml test on current versions 11 years ago
README.md travis badge 11 years ago
index.js allow 0 as path element (closes #2) 11 years ago
package.json bump version 11 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.