https://github.com/gamtiq/iden

Unique identifier generator
https://github.com/gamtiq/iden

create generate generator id identifier random uid unique unique-id uuid

Last synced: about 7 hours ago
JSON representation

Unique identifier generator

• Host: GitHub
• URL: https://github.com/gamtiq/iden
• Owner: gamtiq
• License: mit
• Created: 2016-11-16T21:04:23.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-19T21:13:44.000Z (over 7 years ago)
• Last Synced: 2024-10-06T17:18:41.911Z (about 1 month ago)
• Topics: create, generate, generator, id, identifier, random, uid, unique, unique-id, uuid
• Language: JavaScript
• Size: 545 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# iden 

Unique identifier generator.

[![NPM version](https://badge.fury.io/js/iden.png)](http://badge.fury.io/js/iden)

[![Build Status](https://secure.travis-ci.org/gamtiq/iden.png?branch=master)](http://travis-ci.org/gamtiq/iden)

[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

* [Usage](#usage)

* [Examples](#examples)

* [API](#api)

* [Inspiration](#inspiration)

* [Contributing](#contributing)

* [License](#license)

## Installation

### Node

    npm install iden

### [Bower](http://bower.io)

    bower install iden

### AMD, <script>

Use `dist/iden.js` or `dist/iden.min.js` (minified version).

## Usage  [↑](#start)

### ECMAScript 6

```js

import * as iden from 'iden';

```

### Node

```js

var iden = require("iden");

```

### [Duo](http://duojs.org)

```js

var iden = require("gamtiq/iden");

```

### AMD

```js

define(["path/to/dist/iden.js"], function(iden) {

    ...

});

```

### Bower, <script>

```html

    // iden is available via iden field of window object

    

    ...

```

### Examples  [↑](#start)

```js

iden.getUuid(); // uuid in form of xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

```

## API  [↑](#start)

### getUuid([settings: Object]): String

Generate unique identifier (UUID as described in RFC 4122 version 4).

See `doc` folder for details.

## Inspiration  [↑](#start)

* [http://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript](http://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript)

* [leahciMic/uuid-v4](https://github.com/leahciMic/uuid-v4/blob/master/uuidv4.js)

* [broofa/node-uuid](https://github.com/broofa/node-uuid/blob/master/uuid.js)

* [makeable/uuid-v4.js](https://github.com/makeable/uuid-v4.js/blob/master/uuid-v4.js)

## Contributing  [↑](#start)

In lieu of a formal styleguide, take care to maintain the existing coding style.

Add unit tests for any new or changed functionality.

Lint and test your code using [Grunt](http://gruntjs.com/).

## License  [↑](#start)

Copyright (c) 2016 Denis Sikuler  

Licensed under the MIT license.