From 68ba62a8fb1ee9018963cce3aa30e6d0050195d6 Mon Sep 17 00:00:00 2001 From: "Jean M. Lescure" Date: Mon, 4 Sep 2023 19:08:40 -0600 Subject: [PATCH] docs: update docs --- docs/classes/ShortUniqueId.html | 62 +++++++++---------- docs/index.html | 10 +-- docs/interfaces/ShortUniqueIdOptions.html | 20 +++--- docs/interfaces/ShortUniqueIdRanges.html | 10 +-- docs/interfaces/ShortUniqueIdRangesMap.html | 10 +-- docs/modules.html | 8 +-- .../ShortUniqueIdDefaultDictionaries.html | 10 +-- docs/variables/DEFAULT_OPTIONS.html | 10 +-- docs/variables/DEFAULT_UUID_LENGTH.html | 10 +-- 9 files changed, 75 insertions(+), 75 deletions(-) diff --git a/docs/classes/ShortUniqueId.html b/docs/classes/ShortUniqueId.html index 5872d68..7cb4026 100644 --- a/docs/classes/ShortUniqueId.html +++ b/docs/classes/ShortUniqueId.html @@ -1,4 +1,4 @@ -ShortUniqueId | short-unique-id - v5.0.0
+ShortUniqueId | short-unique-id - v5.0.1
  • Preparing search index...
    • -
  • The search index is not available
ShortUniqueId - v5.0.0
+
  • The search index is not available
    • ShortUniqueId - v5.0.1

    Class ShortUniqueId

    @@ -32,7 +32,7 @@

    Hierarchy

    • ShortUniqueId
    +
  • 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

      @@ -200,7 +200,7 @@
      uuidLength: Returns number
    +
  • Defined in index.ts:376

    • collisionProbability

      @@ -236,7 +236,7 @@
      uuidLength: Returns number
    +
  • Defined in index.ts:434

    • fmt

      @@ -251,7 +251,7 @@
      format: Optional date: Date

    Returns string

    +
  • Defined in index.ts:323

    • formattedUUID

      @@ -271,7 +271,7 @@

      Returns stringAlias

      const uid = new ShortUniqueId(); uid.fmt(format: string);

    +
  • Defined in index.ts:331

    • getVersion

    +
  • Defined in index.ts:485

    • parseStamp

      @@ -302,7 +302,7 @@
      Optional Returns Date
    +
  • Defined in index.ts:538

    • randomUUID

      @@ -320,7 +320,7 @@

      Returns stringAlias

      const uid = new ShortUniqueId(); uid.rnd(uuidLength: number);

    +
  • Defined in index.ts:294

    • rnd

      @@ -333,7 +333,7 @@

      Parameters

      uuidLength: number = ...

    Returns string

    +
  • Defined in index.ts:286

    • seq

    +
  • Defined in index.ts:260

    • sequentialUUID

      @@ -354,7 +354,7 @@

      Returns stringAlias

      const uid = new ShortUniqueId(); uid.seq();

    +
  • Defined in index.ts:268

    • setCounter

      @@ -370,7 +370,7 @@
      counter: Returns void
    +
  • Defined in index.ts:586

    • setDictionary

      @@ -388,7 +388,7 @@
      Optional Returns void
    +
  • Defined in index.ts:212

    • stamp

      @@ -408,7 +408,7 @@
      Optional Returns string
    +
  • Defined in index.ts:501

    • uniqueness

      @@ -441,7 +441,7 @@
      rounds: Returns number
    +
  • Defined in index.ts:467
    • @@ -495,7 +495,7 @@

    uniqueness

    -
    -

    short-unique-id - v5.0.0

    -

    Short Unique ID (UUID) Generating Library

    Tests +

    short-unique-id - v5.0.1

    +

    Short Unique ID (UUID) Generating Library

    Tests Try short-unique-id on RunKit NPM Downloads JsDelivr Hits

    @@ -225,7 +225,7 @@

    License

    -

    Interface ShortUniqueIdOptions

    @@ -27,7 +27,7 @@

    Hierarchy

    • ShortUniqueIdOptions
    +
  • 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
    • @@ -106,7 +106,7 @@

    shuffle

    -

    Interface ShortUniqueIdRanges

    @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [k: string]: [number, number]
    +
  • Defined in index.ts:10
    • @@ -38,7 +38,7 @@

    Member Visibility

    Theme

    -

    Interface ShortUniqueIdRangesMap

    @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [k: string]: ShortUniqueIdRanges
    +
  • Defined in index.ts:14
    • @@ -38,7 +38,7 @@

    Member Visibility

    Theme

    -
    -

    short-unique-id - v5.0.0

    +

    short-unique-id - v5.0.1

    Index

    @@ -48,7 +48,7 @@

    Member Visibility

    Theme

    -

    Type alias ShortUniqueIdDefaultDictionaries

    ShortUniqueIdDefaultDictionaries: "number" | "alpha" | "alpha_lower" | "alpha_upper" | "alphanum" | "alphanum_lower" | "alphanum_upper" | "hex"
    +
  • Defined in index.ts:18
    • @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    -

    Variable DEFAULT_OPTIONSConst

    DEFAULT_OPTIONS: ShortUniqueIdOptions = ...
    +
  • Defined in index.ts:61
    • @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    -

    Variable DEFAULT_UUID_LENGTHConst

    DEFAULT_UUID_LENGTH: number = 6
    @@ -26,7 +26,7 @@

    Variable DEFAULT_UUID_LENGTHConst

    +
  • Defined in index.ts:59
    • @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    -