/guid

Primary LanguageJavaScriptMIT LicenseMIT

license CI npm NPM downloads Percentage of issues still open

Simple guid generator for JS. Support IE6

简单好用的JS全局ID生成工具,原生兼容IE6

English | 简体中文

Environment Support

unit test ensure it supports the following environments.

IE/Edge Chrome Firefox Safari Opera IOS Android Node
6+ 23+ 4+ 6+ 10+ 5+ 2.3+ 0.10+

Directory

.
├── demo
├── dist  # production code
├── doc   # document
├── src   # source code
├── test  # unit test
├── CHANGELOG.md
└── TODO.md

Usage

npm installation

$ npm install --save @jsmini/guid

Node.js

var guid = require('@jsmini/guid').guid;

guid();

webpack

import { guid } from '@jsmini/guid';

guid();

Require.js

requirejs(
  ['node_modules/@jsmini/guid/dist/index.aio.js'],
  function (jsmini_guid) {
    var guid = jsmini_guid.guid;

    guid();
  },
);

Browser

<script src="node_modules/@jsmini/guid/dist/index.aio.js"></script>

<script>
  var guid = jsmini_guid.guid;

  guid();
</script>

Document

API

Contributing Guide PRs welcome

when initialize, install dependencies

$ npm install

builds your code for production to build folder

$ npm run build

run unit test. notice: borwser enviroment need to test manually. test file is in test/browser

$ npm test

change the version in package.json and README.md, add your description in CHANGELOG.md, and then release it happily.

$ npm run release

publish the new package to npm

$ npm publish --access=public

Maybe you should change relative information in the follow files

  • README.md
  • package.json
  • config/rollup.js
  • test/browser/index.html

CHANGELOG

CHANGELOG.md

TODO

TODO.md

who is using