package.json
5.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
{
"_args": [
[
{
"raw": "yeast@0.1.2",
"scope": null,
"escapedName": "yeast",
"name": "yeast",
"rawSpec": "0.1.2",
"spec": "0.1.2",
"type": "version"
},
"/Users/fzy/project/3mang/node_modules/engine.io-client"
]
],
"_from": "yeast@0.1.2",
"_id": "yeast@0.1.2",
"_inCache": true,
"_location": "/yeast",
"_nodeVersion": "0.12.3",
"_npmUser": {
"name": "3rdeden",
"email": "npm@3rd-Eden.com"
},
"_npmVersion": "2.9.1",
"_phantomChildren": {},
"_requested": {
"raw": "yeast@0.1.2",
"scope": null,
"escapedName": "yeast",
"name": "yeast",
"rawSpec": "0.1.2",
"spec": "0.1.2",
"type": "version"
},
"_requiredBy": [
"/engine.io-client"
],
"_resolved": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz",
"_shasum": "008e06d8094320c372dbc2f8ed76a0ca6c8ac419",
"_shrinkwrap": null,
"_spec": "yeast@0.1.2",
"_where": "/Users/fzy/project/3mang/node_modules/engine.io-client",
"author": {
"name": "Arnout Kazemier"
},
"bugs": {
"url": "https://github.com/unshiftio/yeast/issues"
},
"dependencies": {},
"description": "Tiny but linear growing unique id generator",
"devDependencies": {
"assume": "1.3.x",
"istanbul": "0.3.x",
"mocha": "2.3.x",
"pre-commit": "1.1.x",
"zuul": "3.4.x"
},
"directories": {},
"dist": {
"shasum": "008e06d8094320c372dbc2f8ed76a0ca6c8ac419",
"tarball": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz"
},
"gitHead": "5a7300f934302009aa8733fa84d43cc570756b98",
"homepage": "https://github.com/unshiftio/yeast",
"keywords": [
"yeast",
"id",
"generator",
"unique"
],
"license": "MIT",
"main": "index.js",
"maintainers": [
{
"name": "unshift",
"email": "npm@unshift.io"
},
{
"name": "3rdeden",
"email": "npm@3rd-Eden.com"
}
],
"name": "yeast",
"optionalDependencies": {},
"readme": "# yeast\n\n[](http://unshift.io)[](http://browsenpm.org/package/yeast)[](https://travis-ci.org/unshiftio/yeast)[](https://david-dm.org/unshiftio/yeast)[](https://coveralls.io/r/unshiftio/yeast?branch=master)[](https://webchat.freenode.net/?channels=unshift)\n\n[](https://saucelabs.com/u/yeast)\n\nYeast is a unique id generator. It has been primarily designed to generate a\nunique id which can be used for cache busting. A common practice for this is\nto use a timestamp, but there are couple of downsides when using timestamps.\n\n1. The timestamp is already 13 chars long. This might not matter for 1 request\n but if you make hundreds of them this quickly adds up in bandwidth and\n processing time.\n2. It's not unique enough. If you generate two stamps right after each other,\n they would be identical because the timing accuracy is limited to\n milliseconds.\n\nYeast solves both of these issues by:\n\n1. Compressing the generated timestamp using a custom `encode()` function that\n returns a string representation of the number.\n2. Seeding the id in case of collision (when the id is identical to the previous\n one).\n\nTo keep the strings unique it will use the `.` char to separate the generated\nstamp from the seed.\n\n## Installation\n\nThe module is intended to be used in browsers as well as in Node.js and is\ntherefore released in the npm registry and can be installed using:\n\n```\nnpm install --save yeast\n```\n\n## Usage\n\nAll the examples assume that this library is initialized as follow:\n\n```js\n'use strict';\n\nvar yeast = require('yeast');\n```\n\nTo generate an id just call the `yeast` function.\n\n```js\nconsole.log(yeast(), yeast(), yeast()); // outputs: KyxidwN KyxidwN.0 KyxidwN.1\n\nsetTimeout(function () {\n console.log(yeast()); // outputs: KyxidwO\n});\n```\n\n### yeast.encode(num)\n\nAn helper function that returns a string representing the specified number. The\nreturned string contains only URL safe characters.\n\n```js\nyeast.encode(+new Date()); // outputs: Kyxjuo1\n```\n\n### yeast.decode(str)\n\nAn helper function that returns the integer value specified by the given string.\nThis function can be used to retrieve the timestamp from a `yeast` id.\n\n```js\nvar id = yeast(); // holds the value: Kyxl1OU\n\nyeast.decode(id); // outputs: 1439816226334\n```\n\nThat's all folks. If you have ideas on how we can further compress the ids\nplease open an issue!\n\n## License\n\n[MIT](LICENSE)\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/unshiftio/yeast.git"
},
"scripts": {
"100%": "istanbul check-coverage --statements 100 --functions 100 --lines 100 --branches 100",
"coverage": "istanbul cover _mocha -- test.js",
"test": "mocha test.js",
"test-browser": "zuul -- test.js",
"test-node": "istanbul cover _mocha --report lcovonly -- test.js",
"watch": "mocha --watch test.js"
},
"version": "0.1.2"
}