TF
/
docuri
mirror of https://github.com/jo/docuri.git
1
0
Fork 0
Code Releases Wiki Activity
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.
16 Commits
35 Branches
5 Tags
156 KiB
JavaScript 100%
 
greenkeeper-tap-10.3.2
greenkeeper-tap-10.3.1
greenkeeper-tap-10.3.0
greenkeeper-tap-10.2.2
greenkeeper-tap-10.2.1
greenkeeper-tap-10.2.0
greenkeeper-tap-10.1.2
greenkeeper-shuffle-array-1.0.1
greenkeeper-tap-10.1.1
greenkeeper-tap-10.1.0
greenkeeper-tap-10.0.2
greenkeeper-tap-10.0.1
greenkeeper-tap-10.0.0
master
greenkeeper-tap-9.0.3
greenkeeper-tap-9.0.2
greenkeeper-tap-9.0.1
greenkeeper-tap-9.0.0
greenkeeper-tap-8.0.1
greenkeeper/remove-node-0.10
greenkeeper-tap-8.0.0
greenkeeper-tap-7.1.2
greenkeeper-tap-7.1.1
greenkeeper-tap-7.1.0
greenkeeper-tap-7.0.1
greenkeeper-tap-7.0.0
greenkeeper-tap-6.3.2
greenkeeper-tap-6.3.1
greenkeeper-tap-6.3.0
greenkeeper-tap-6.2.0
greenkeeper-tap-6.1.1
greenkeeper-tap-6.1.0
greenkeeper-tap-6.0.0
greenkeeper-shuffle-array-1.0.0
greenkeeper-shuffle-array-2.0.0
v4.1.1
v4.1.0
v4.2.0
v4.2.1
v4.2.2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ed9f5886e8'
${ noResults }
Go to file
Johannes J. Schmidt ed9f5886e8 rewrite 11 years ago
test change sequence of version and index 11 years ago
.gitignore first commit 11 years ago
.travis.yml test on current versions 11 years ago
README.md change sequence of version and index 11 years ago
index.js rewrite 11 years ago
package.json rewrite 11 years ago

README.md

docuri Build Status

Rich document ids for CouchDB.

type/id/subtype/index/version

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

Usage

Parse id string:

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

Build id string from object:

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

Change id string components:

require('docuri').merge('mytype/myid/mysubtype/myindex/myversion', {
  type: 'my_new_type',
});
// 'my_new_type/myid/mysubtype/myindex/myversion'

Browser support

To use docid in your client-side application, browserify it like this:

browserify -s DocURI path/to/docuri/index.js > path/to/your/assets

Once added to your DOM, this will leave you with a global DocURI object for use in your e.g. Backbone Models/Collections.

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.