Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shimataro/maylily
fast, distributable, serverless, and customizable unique ID number generator based on Snowflake
https://github.com/shimataro/maylily
generator snowflake twitter unique-id
Last synced: about 17 hours ago
JSON representation
fast, distributable, serverless, and customizable unique ID number generator based on Snowflake
- Host: GitHub
- URL: https://github.com/shimataro/maylily
- Owner: shimataro
- License: mit
- Created: 2016-10-29T04:54:19.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2019-11-23T04:17:56.000Z (almost 5 years ago)
- Last Synced: 2024-10-07T21:20:24.967Z (30 days ago)
- Topics: generator, snowflake, twitter, unique-id
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/maylily
- Size: 604 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MayLily
[![Build Status (Windows)][image-build-windows]][link-build-windows]
[![Build Status (macOS)][image-build-macos]][link-build-macos]
[![Build Status (Linux)][image-build-linux]][link-build-linux]
[![Syntax check][image-syntax-check]][link-syntax-check]
[![Code Coverage][image-code-coverage]][link-code-coverage]
[![Release][image-release]][link-release]
[![Node.js version][image-engine]][link-engine]
[![License][image-license]][link-license]
[![NPM][image-npm]][link-npm]
distributable, serverless, and customizable unique ID generator based on [Snowflake](https://github.com/twitter/snowflake/tree/snowflake-2010/)
## Features
* distributable / scalable
* no external servers required
* customizable
* supports 2-36 radix
* supports multiple precision integer
* supports CommonJS, ES Modules, TypeScript
## How to install
Install by `npm`.
```bash
npm install -S maylily
```
## How to use
No external servers needed.
Just import and call `maylily()`!
### JavaScript
Traditional syntax.
This code will run on most JavaScript engine.
```javascript
var maylily = require("maylily");
(function() {
// returns a Promise object
maylily()
.then(function(id) {
// do something...
})
.catch(function(err) {
// err is instance of Error
});
}();
```
### ECMAScript 7
Modern syntax.
Async/await syntax is easy to read
```javascript
const maylily = require("maylily");
(async() => { // async syntax / arrow function
try {
const id = await maylily(); // await syntax
// do something...
}
catch(err) {
// err is instance of Error
}
})();
```
### ES Modules / Babel / TypeScript (import, async/await)
VERY modern syntax!
```javascript
import maylily from "maylily"; // import syntax
(async() => {
try {
const id = await maylily();
// do something...
}
catch(err) {
// err is instance of Error
}
})();
```
## How to customize
| name | description | default |
|------|-------------|---------|
| `radix` | radix of generated ID (2-36) | 10 |
| `timeBase` | base time in unixtime(millisec) | 946684800000 (2000-01-01T00:00:00Z) |
| `machineId` | identifier of machine; must be unique in service | 0 |
| `machineBits` | required bits to represent machineId | 3 |
| `generatorId` | identifier of generator; must be unique in machine | process ID |
| `generatorBits` | required bits to represent generatorId | 10 |
| `sequenceBits` | required bits to represent sequence | 8 |
Generated value is stringified multiple precision integer (in specified radix).
```
000001011100000101111010101110101010111101 001 1101101010 00000110
|------------------------------------------| current time from timeBase in millisec
|---| machineId (uses machineBits bits)
|----------| generatorId (uses generatorBits bits)
|--------| sequence number (uses sequenceBits bits)
```
example:
```javascript
// keeps options until next change
maylily({
timeBase: Date.parse("2017-01-01T00:00:00Z"), // if your service starts in 2017, this is enough.
machineBits: 1 // if required number machines are up to 2, this is enough.
});
```
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
[image-build-windows]: https://github.com/shimataro/maylily/workflows/Windows/badge.svg
[link-build-windows]: https://github.com/shimataro/maylily
[image-build-macos]: https://github.com/shimataro/maylily/workflows/macOS/badge.svg
[link-build-macos]: https://github.com/shimataro/maylily
[image-build-linux]: https://github.com/shimataro/maylily/workflows/Linux/badge.svg
[link-build-linux]: https://github.com/shimataro/maylily
[image-syntax-check]: https://github.com/shimataro/maylily/workflows/Syntax%20check/badge.svg
[link-syntax-check]: https://github.com/shimataro/maylily
[image-code-coverage]: https://img.shields.io/codecov/c/github/shimataro/maylily/master.svg
[link-code-coverage]: https://codecov.io/gh/shimataro/maylily
[image-release]: https://img.shields.io/github/release/shimataro/maylily.svg
[link-release]: https://github.com/shimataro/maylily/releases
[image-engine]: https://img.shields.io/node/v/maylily.svg
[link-engine]: https://nodejs.org/
[image-license]: https://img.shields.io/github/license/shimataro/maylily.svg
[link-license]: ./LICENSE
[image-npm]: https://nodei.co/npm/maylily.svg?downloads=true&downloadRank=true&stars=true
[link-npm]: https://nodei.co/npm/maylily/