cyberflake v1.0.3
About
cyberflake was developing for CyberEngine. And now, she is open source! cyberflake generete id like Twitter's snowflake and deconstruct these genereted id's to original timesamp, date or binary.
Installation
cyberflake requires Node.js latest version to run.
$ npm i cyberflake -S
or
$ yarn add cyberflake
Usage
// how to make an id
const cyberflake = require('cyberflake')
const id = cyberflake.generate()
console.log(id)
// how to deconstruct generated id to timestamp, date or binary
const data = cyberflake.deconstruct('STRING_ID')
console.log(data)
Altenative Usage Styles
/* first style */
const { generate, deconstruct } = require('cyberflake')
const id = generate()
console.log(id)
const data = deconstruct('STRING_ID')
console.log(data)
/* second style */
const id = require('cyberflake').generate()
console.log(id)
/* third style */
const id = require('cyberflake').generate
console.log(id())
Technology
cyberflake uses a number of open source projects to work properly:
- Node.JS - cyberflake uses this powerful programming language.
- VScode - We're highly recommending this awesome code editor.
And of course cyberflake itself is open source with a public repository on GitHub.
Plugins
cyberflake is currently extended with the following plugins. Instructions on how to use them in your own application are linked below.
Plugin | README |
---|---|
@types/node | plugins/definitelytyped/README.md |
Eslint | plugins/eslint/README.md |
Nodemon | plugins/nodemon/README.md |
Semantic Versioning
We're using SemVer for this project.
Development
Want to contribute? Great!
cyberflake uses eslint for stable developing. Make a change in your file and instantanously see your updates!
Open your favorite Terminal and run these commands.
$ git clone <url>
$ cd <cloned_folder_name>
$ npm i -d
$ npm test
Our Contributors
- Yankı Küçük - Twitter
And you can see also all contributors here.
License
Aphace 2.0