s-uid

1.3.1
Need help reading this?

uid

generate random id based on template string. Default template string is 'xxxxxxxx-xxxx-1xxx-1xxx-xxxxxxxxxxxx'.

Template rules very simple:

base - it's a string for creating id. Rewrite only special characters

N - Rewrite to random Number

H - Rewrite to random hex numder

S - Rewrite to random english symbol

X - Rewrite to any from "N","H","S"

uid(base: String?): String
Parameters
base (String?) : [ default: 'XXXXXXXX-XXXX-1XXX-1XXX-XXXXXXXXXXXX' ]
Returns
String:
Example
uid();
uid('XXX-4NNN-dummy-SSS');

uid._time

Humanized time string. This method is very sensitive to the correctness of the input arguments

uid._time(separator: String, date: Date): String
Parameters
separator (String) Separator character for output
date (Date) instance of Date constructor
Returns
String:
Example
uid._time('-', new Date() );

uid._date

Humanized date string. This method is very sensitive to the correctness of the input arguments

uid._date(separator: String, date: Date): String
Parameters
separator (String) Separator character for output
date (Date) instance of Date constructor
Returns
String:
Example
uid._date('-', new Date() );

uid.time

Humanized date+time string. Safe method.

uid.time(date: Date?, separator1: String?, separator2: String?, separator3: String?): String
Parameters
date (Date?) : [ default: new Date() ] - instance of Date constructor
separator1 (String?) : [ default: ' - ' ] - Separator character for output date
separator2 (String?) : [ default: ' \s ' ] - Separator character for output bitwin date and time
separator3 (String?) : [ default: ' : ' ] - Separator character for output time
Returns
String:
Example
uid.time();
uid.time( new Date() );
uid.time( new Date(), '-', ':', '-');

uid.th

hash based on time in 36 numerical system by default

uid.th(date: Date?, null-null: Number): String
Parameters
date (Date?) : [ default: new Date() ] - instance of Date constructor
null-null (Number) [ bit ] : [ default: 36 ] - expect number 2-36
Returns
String: hash string
Example
uid.th();
uid.th(null, 4);
uid.th(new Date(), 10);

uid.guid

generate uuid (xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx) based on time, reserved characters and random symbols

uid.guid(M: String?, N: String?, time: Date?): String
Parameters
M (String?) [ default: random english symbol ( uid('S') ) ]
N (String?) [ default: random number ( uid('N') ) ]
time (Date?) [ default: new Date() ] - date of guid generation
Returns
String:
Example
uid.guid();
uid.guid('M', 0, new Date() );

exports

defination on platforms (both variants on platform like Electron)

bower i --save s-uid

npm i --save s-uid

exports
Example
window.uid || window['s-uid'] // in browser
var uid = require('s-uid')    // in Node.js