diff --git a/assets/generator.html b/assets/generator.html new file mode 100644 index 0000000..713d134 --- /dev/null +++ b/assets/generator.html @@ -0,0 +1,71 @@ +
+
+

Online (short) UUID generator

+

Press the buttons below to generate your short uuid codes:

+ Length: + +

+ Your random UUID:   +

+ +

+ Your sequential UUID: +

+

Random Color generator

+

+ The ability to set a custom dictionary and length means that Short Unique ID is useful for many other cases such as this random color generator. +

+ 
+    
+      // instantiate using a dictionary containing all 16 valid hex characters
+
+      var uid = new ShortUniqueId({
+        dictionary: [
+          '0', '1', '2', '3',
+          '4', '5', '6', '7',
+          '8', '9', 'A', 'B',
+          'C', 'D', 'E', 'F',
+        ],
+      });
+
+      // or using default dictionaries available since v4.3+
+
+      var uid = new ShortUniqueId({ dictionary: 'hex' });
+
+      // then taste the rainbow 🌈
+
+      var color = '#' + uid.randomUUID(6) + ';';
+    
+
+

+ + Your random color: +

+ + +
\ No newline at end of file diff --git a/docs/assets/generator.html b/docs/assets/generator.html new file mode 100644 index 0000000..713d134 --- /dev/null +++ b/docs/assets/generator.html @@ -0,0 +1,71 @@ +
+
+

Online (short) UUID generator

+

Press the buttons below to generate your short uuid codes:

+ Length: + +

+ Your random UUID:   +

+ +

+ Your sequential UUID: +

+

Random Color generator

+

+ The ability to set a custom dictionary and length means that Short Unique ID is useful for many other cases such as this random color generator. +

+ 
+    
+      // instantiate using a dictionary containing all 16 valid hex characters
+
+      var uid = new ShortUniqueId({
+        dictionary: [
+          '0', '1', '2', '3',
+          '4', '5', '6', '7',
+          '8', '9', 'A', 'B',
+          'C', 'D', 'E', 'F',
+        ],
+      });
+
+      // or using default dictionaries available since v4.3+
+
+      var uid = new ShortUniqueId({ dictionary: 'hex' });
+
+      // then taste the rainbow 🌈
+
+      var color = '#' + uid.randomUUID(6) + ';';
+    
+
+

+ + Your random color: +

+ + +
\ No newline at end of file diff --git a/docs/classes/ShortUniqueId.html b/docs/classes/ShortUniqueId.html index f7fc66a..616e7e2 100644 --- a/docs/classes/ShortUniqueId.html +++ b/docs/classes/ShortUniqueId.html @@ -32,7 +32,7 @@

Hierarchy

+
  • Defined in index.ts:125
    • @@ -87,59 +87,59 @@

    Parameters

    argOptions: Partial<ShortUniqueIdOptions> = {}

    Returns ShortUniqueId

    +
  • Defined in index.ts:590

    • Properties

    counter

    counter: number
    +
  • Defined in index.ts:129

    • debug

    debug: boolean
    +
  • Defined in index.ts:130

    • dict

    dict: string[]
    +
  • Defined in index.ts:131

    • dictIndex

    dictIndex: number = 0
    +
  • Defined in index.ts:133

    • dictLength

    dictLength: number = 0
    +
  • Defined in index.ts:137

    • dictRange

    dictRange: number[] = []
    +
  • Defined in index.ts:134

    • lowerBound

    lowerBound: number = 0
    +
  • Defined in index.ts:135

    • upperBound

    upperBound: number = 0
    +
  • Defined in index.ts:136

    • uuidLength

    uuidLength: number
    +
  • Defined in index.ts:138

    • version

    version: string
    +
  • Defined in index.ts:132

    • Methods

    @@ -172,7 +172,7 @@
    rounds: Returns number
    +
  • Defined in index.ts:403

    • availableUUIDs

    +
  • Defined in index.ts:376

    • collisionProbability

    +
  • Defined in index.ts:434

    • fmt

    Returns string

    +
  • Defined in index.ts:323

    • formattedUUID

    +
  • Defined in index.ts:331

    • getVersion

    +
  • Defined in index.ts:485

    • parseStamp

    +
  • Defined in index.ts:538

    • randomUUID

    +
  • Defined in index.ts:294

    • rnd

    Returns string

    +
  • Defined in index.ts:286

    • seq

    +
  • Defined in index.ts:260

    • sequentialUUID

    +
  • Defined in index.ts:268

    • setCounter

    +
  • Defined in index.ts:586

    • setDictionary

    +
  • Defined in index.ts:212

    • stamp

    +
  • Defined in index.ts:501

    • uniqueness

    +
  • Defined in index.ts:467
    • diff --git a/docs/index.html b/docs/index.html index fe7af80..cf31ad5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,6 +19,77 @@

    short-unique-id - v5.0.2

    12 Contributors

    +
    +
    +

    Online (short) UUID generator

    +

    Press the buttons below to generate your short uuid codes:

    + Length: + +

    + Your random UUID:   +

    + +

    + Your sequential UUID: +

    +

    Random Color generator

    +

    + The ability to set a custom dictionary and length means that Short Unique ID is useful for many other cases such as this random color generator. +

    + 
    +    
+      // instantiate using a dictionary containing all 16 valid hex characters
+
+      var uid = new ShortUniqueId({
+        dictionary: [
+          '0', '1', '2', '3',
+          '4', '5', '6', '7',
+          '8', '9', 'A', 'B',
+          'C', 'D', 'E', 'F',
+        ],
+      });
+
+      // or using default dictionaries available since v4.3+
+
+      var uid = new ShortUniqueId({ dictionary: 'hex' });
+
+      // then taste the rainbow 🌈
+
+      var color = '#' + uid.randomUUID(6) + ';';
+    
+
    +

    + + Your random color: +

    + + +

    Tiny (6.7kB minified) no-dependency library for generating random or sequential UUID of any length diff --git a/docs/interfaces/ShortUniqueIdOptions.html b/docs/interfaces/ShortUniqueIdOptions.html index 8a65150..054a4f2 100644 --- a/docs/interfaces/ShortUniqueIdOptions.html +++ b/docs/interfaces/ShortUniqueIdOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in index.ts:32
    • @@ -50,7 +50,7 @@

    counter

    +
  • Defined in index.ts:46

    • debug

    debug: boolean
    @@ -58,7 +58,7 @@

    debug

    +
  • Defined in index.ts:40

    • dictionary

    dictionary: string[] | ShortUniqueIdDefaultDictionaries
    @@ -66,7 +66,7 @@

    dictionary

    +
  • Defined in index.ts:34

    • length

    length: number
    @@ -74,7 +74,7 @@

    length

    +
  • Defined in index.ts:43

    • shuffle

    shuffle: boolean
    @@ -82,7 +82,7 @@

    shuffle

    +
  • Defined in index.ts:37
    • diff --git a/docs/interfaces/ShortUniqueIdRanges.html b/docs/interfaces/ShortUniqueIdRanges.html index 04bb9bb..a01bbd4 100644 --- a/docs/interfaces/ShortUniqueIdRanges.html +++ b/docs/interfaces/ShortUniqueIdRanges.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [k: string]: [number, number]
    +
  • Defined in index.ts:10
    • diff --git a/docs/interfaces/ShortUniqueIdRangesMap.html b/docs/interfaces/ShortUniqueIdRangesMap.html index ba97850..85d0bd9 100644 --- a/docs/interfaces/ShortUniqueIdRangesMap.html +++ b/docs/interfaces/ShortUniqueIdRangesMap.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [k: string]: ShortUniqueIdRanges
    +
  • Defined in index.ts:14
    • diff --git a/docs/types/ShortUniqueIdDefaultDictionaries.html b/docs/types/ShortUniqueIdDefaultDictionaries.html index 97cced0..e109cbf 100644 --- a/docs/types/ShortUniqueIdDefaultDictionaries.html +++ b/docs/types/ShortUniqueIdDefaultDictionaries.html @@ -17,7 +17,7 @@

    Type alias ShortUniqueIdDefaultDictionaries

    ShortUniqueIdDefaultDictionaries: "number" | "alpha" | "alpha_lower" | "alpha_upper" | "alphanum" | "alphanum_lower" | "alphanum_upper" | "hex"
    +
  • Defined in index.ts:18
    • diff --git a/docs/variables/DEFAULT_OPTIONS.html b/docs/variables/DEFAULT_OPTIONS.html index f0dc388..8f13317 100644 --- a/docs/variables/DEFAULT_OPTIONS.html +++ b/docs/variables/DEFAULT_OPTIONS.html @@ -17,7 +17,7 @@

    Variable DEFAULT_OPTIONSConst

    DEFAULT_OPTIONS: ShortUniqueIdOptions = ...
    +
  • Defined in index.ts:61
    • diff --git a/docs/variables/DEFAULT_UUID_LENGTH.html b/docs/variables/DEFAULT_UUID_LENGTH.html index 1034c02..64c1ac3 100644 --- a/docs/variables/DEFAULT_UUID_LENGTH.html +++ b/docs/variables/DEFAULT_UUID_LENGTH.html @@ -26,7 +26,7 @@

    Variable DEFAULT_UUID_LENGTHConst

    +
  • Defined in index.ts:59
    • diff --git a/scripts/docs b/scripts/docs index d6dbe0e..2aa0d1a 100644 --- a/scripts/docs +++ b/scripts/docs @@ -20,6 +20,7 @@ typedoc --name "short-unique-id - v$(jq -r .version package.json)"\ --cname shortunique.id\ --useTsLinkResolution\ --titleLink "https://shortunique.id" +./scripts/generator cp -r ./assets ./docs mv ./docs/assets/favicon.ico ./docs/ mv ./docs/assets/cookie-policy ./docs/ diff --git a/scripts/generator b/scripts/generator new file mode 100644 index 0000000..246a4fd --- /dev/null +++ b/scripts/generator @@ -0,0 +1,14 @@ +#! /usr/bin/env node + +const fs = require('fs'); +const path = require('path'); + +const indexContents = fs.readFileSync(path.join(__dirname, '../docs/index.html'), 'utf8'); +const generatorContents = fs.readFileSync(path.join(__dirname, '../assets/generator.html'), 'utf8'); + +const indexContentsWithGenerator = indexContents.replace( + '', + `\n${generatorContents}` +); + +fs.writeFileSync(path.join(__dirname, '../docs/index.html'), indexContentsWithGenerator);