isomorphic-mongo-objectid
v1.0.9
Published
Pure JavaScript implementation of mongo ObjectID for the client and server
Downloads
3,583
Maintainers
Readme
isomorphic-mongo-objectid
A 0.7k pure JavaScript implementation of mongo ObjectID for the client (browser) and server (nodejs). A machine id is created for each client and persistent across a single domain using localStorage.
Installation
Client-side
Copy isomorphic-mongo-objectid.min.js into your page and add a script tag:
<script src="isomorphic-mongo-objectid.min.js"></script>
Server-side
Install via npm:
npm install --save isomorphic-mongo-objectid
Require in your module:
var ObjectID = require('isomorphic-mongo-objectid');
Usage
ObjectID(); // returns 5aab1a1a5e756f5b6d000001
ObjectID('5aab1a1a5e756f5b6d000001').getDate(); // returns Fri Mar 16 2018 01:12:58 GMT+0000 (GMT)
ObjectID('5aab1a1a5e756f5b6d000001').toArray(); // returns [90, 171, 26, 26, 94, 117, 111, 91, 109, 0, 0, 1]
ObjectID(0, 0, 0, 0x00ffffff); // returns 000000000000000000ffffff
Contributing
Checkout the project
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes (including tests):
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Run unit tests
- Checkout using
git clone https://github.com/john-doherty/isomorphic-mongo-objectid
- Navigate into project folder
cd isomorphic-mongo-objectid
- Install dependencies
npm install
- Run the tests
npm test
Update .min version
- Checkout using
git clone https://github.com/john-doherty/isomorphic-mongo-objectid
- Navigate into project folder
cd isomorphic-mongo-objectid
- Install dependencies
npm install
- Make the relevant changes
- Updated
version
number inpackage.json
- Run
npm run build
to generate a new isomorphic-mongo-objectid.min.js file
Bugs
History
For change-log, check releases.
License
Licensed under MIT License © John Doherty