From 97f7a8da11ec95e240e8b717a80b08506e5478dc Mon Sep 17 00:00:00 2001 From: Alex Jarvis Date: Tue, 16 Aug 2022 01:10:41 -0400 Subject: [PATCH] 1.5.3 -> 1.5.4 (#203) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 1.5.4 * 🤖 Updating Docs 🤖 --- docs/functions/randsum.html | 24 ++++++++++----------- docs/index.html | 8 +++---- docs/interfaces/CapModifier.html | 12 +++++------ docs/interfaces/CapOptions.html | 14 ++++++------ docs/interfaces/DropModifier.html | 12 +++++------ docs/interfaces/DropOptions.html | 20 ++++++++--------- docs/interfaces/ExplodeModifier.html | 12 +++++------ docs/interfaces/InternalRollParameters.html | 18 ++++++++-------- docs/interfaces/MinusModifier.html | 12 +++++------ docs/interfaces/PlusModifier.html | 12 +++++------ docs/interfaces/ReplaceModifier.html | 12 +++++------ docs/interfaces/ReplaceOptions.html | 14 ++++++------ docs/interfaces/RerollModifier.html | 12 +++++------ docs/interfaces/RerollOptions.html | 18 ++++++++-------- docs/interfaces/RollOptions.html | 16 +++++++------- docs/interfaces/RollParameters.html | 22 +++++++++---------- docs/interfaces/RollResult.html | 16 +++++++------- docs/interfaces/UniqueModifier.html | 12 +++++------ docs/interfaces/UniqueOptions.html | 12 +++++------ docs/interfaces/UserOptions.html | 14 ++++++------ docs/modules.html | 8 +++---- docs/types/DiceNotation.html | 10 ++++----- docs/types/Modifier.html | 10 ++++----- docs/types/NumberString.html | 10 ++++----- docs/types/Randomizer.html | 10 ++++----- docs/types/RandsumOptions.html | 10 ++++----- docs/types/RandsumOptionsWithoutSides.html | 10 ++++----- package.json | 2 +- 28 files changed, 181 insertions(+), 181 deletions(-) diff --git a/docs/functions/randsum.html b/docs/functions/randsum.html index de618e6e..ea0f69c2 100644 --- a/docs/functions/randsum.html +++ b/docs/functions/randsum.html @@ -1,16 +1,16 @@ -randsum | randsum - v1.5.3
+randsum | randsum - v1.5.4
+
  • The search index is not available
    • randsum - v1.5.4

    Function randsum

    @@ -24,7 +24,7 @@

    Parameters

    sides: number | `${number}`

    Returns number

    +
  • Defined in randsum.ts:12
  • @@ -36,7 +36,7 @@
    sides: numberRandsumOptionsWithoutSides<false>

    • Returns number

    +
  • Defined in randsum.ts:13
  • @@ -48,7 +48,7 @@
    sides: numberRandsumOptionsWithoutSides<true>

    • Returns RollResult

    +
  • Defined in randsum.ts:14
  • @@ -58,7 +58,7 @@

    Parameters

    notation: `${number}d${number}${string}` | `${number}D${number}${string}`

    • Returns number

    +
  • Defined in randsum.ts:15
  • @@ -70,7 +70,7 @@
    notation: `UserOptions<false>

    • Returns number

    +
  • Defined in randsum.ts:16
  • @@ -82,7 +82,7 @@
    notation: `UserOptions<true>

    • Returns RollResult

    +
  • Defined in randsum.ts:17
  • @@ -92,7 +92,7 @@

    Parameters

    rollOptions: RandsumOptions<false>

    • Returns number

    +
  • Defined in randsum.ts:18
  • @@ -102,7 +102,7 @@

    Parameters

    rollOptions: RandsumOptions<true>

    • Returns RollResult

    +
  • Defined in randsum.ts:19
    • @@ -122,7 +122,7 @@

    Theme

    • Preparing search index...
      • -
    • The search index is not available
    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4
    -

    randsum - v1.5.3

    +

    randsum - v1.5.4

    randsum

    @@ -66,7 +66,7 @@

    Theme

    • Preparing search index...
      • -
    • The search index is not available
    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface CapModifier<T>

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

    Hierarchy

    • CapModifier
    +
  • Defined in types/modifiers.ts:48
    • @@ -43,7 +43,7 @@

    Properties

    cap

    cap: CapOptions<T>
    +
  • Defined in types/modifiers.ts:49
    • @@ -63,7 +63,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface CapOptions<T>

    @@ -33,7 +33,7 @@

    Hierarchy

    +
  • Defined in types/modifiers.ts:36
    • @@ -52,14 +52,14 @@

    Optional

    A NumberString, representing the maximum number allowed to be rolled on this die (all rolls greater will be reduced to this value)

    +
  • Defined in types/modifiers.ts:38

    • Optional lessThan

    lessThan?: NumberString<T>

    A NumberString, representing the minimum number allowed to be rolled on this die (all rolls lessThan will be increased to this value)

    +
  • Defined in types/modifiers.ts:40
    • @@ -79,7 +79,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface DropModifier<T>

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

    Hierarchy

    • DropModifier
    +
  • Defined in types/modifiers.ts:8
    • @@ -43,7 +43,7 @@

    Properties

    drop

    drop: DropOptions<T>
    +
  • Defined in types/modifiers.ts:9
    • @@ -63,7 +63,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface DropOptions<T>

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

    Hierarchy

    • DropOptions
    +
  • Defined in types/modifiers.ts:17
    • @@ -49,35 +49,35 @@

    Optional

    A NumberString, representing the amount of high rolls that will be dropped from this result.

    +
  • Defined in types/modifiers.ts:19

    • Optional lowest

    lowest?: NumberString<T>

    A NumberString, representing the amount of low rolls that will be dropped from this result.

    +
  • Defined in types/modifiers.ts:21

    • Optional greaterThan

    greaterThan?: NumberString<T>

    A NumberString, representing the maximum number allowed to be rolled on this die (all rolls greater will be dropped)

    +
  • Defined in types/modifiers.ts:23

    • Optional lessThan

    lessThan?: NumberString<T>

    A NumberString, representing the minimum number allowed to be rolled on this die (all rolls lesser will be dropped)

    +
  • Defined in types/modifiers.ts:25

    • Optional exact

    exact?: NumberString<T>[]

    An array of NumberString, representing which specific results will be dropped

    +
  • Defined in types/modifiers.ts:27
    • @@ -97,7 +97,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface ExplodeModifier

    @@ -21,7 +21,7 @@

    Hierarchy

    • ExplodeModifier
    +
  • Defined in types/modifiers.ts:117
    • @@ -37,7 +37,7 @@

    Properties

    explode

    explode: boolean
    +
  • Defined in types/modifiers.ts:118
    • @@ -57,7 +57,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface InternalRollParameters

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

    Hierarchy

    +
  • Defined in types/parameters.ts:10
    • @@ -49,25 +49,25 @@

    Optional

    +
  • Defined in types/options.ts:32

    • sides

    sides: number
    +
  • Defined in types/options.ts:41

    • modifiers

    modifiers: Modifier<number>[]
    +
  • Defined in types/parameters.ts:11

    • quantity

    quantity: number
    +
  • Defined in types/parameters.ts:12
    • @@ -87,7 +87,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface MinusModifier<T>

    @@ -26,7 +26,7 @@

    Hierarchy

    • MinusModifier
    +
  • Defined in types/modifiers.ts:133
    • @@ -42,7 +42,7 @@

    Properties

    minus

    minus: NumberString<T>
    +
  • Defined in types/modifiers.ts:134
    • @@ -62,7 +62,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface PlusModifier<T>

    @@ -26,7 +26,7 @@

    Hierarchy

    • PlusModifier
    +
  • Defined in types/modifiers.ts:125
    • @@ -42,7 +42,7 @@

    Properties

    plus

    plus: NumberString<T>
    +
  • Defined in types/modifiers.ts:126
    • @@ -62,7 +62,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface ReplaceModifier<T>

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

    Hierarchy

    • ReplaceModifier
    +
  • Defined in types/modifiers.ts:90
    • @@ -43,7 +43,7 @@

    Properties

    replace

    replace: ReplaceOptions<T> | ReplaceOptions<T>[]
    +
  • Defined in types/modifiers.ts:91
    • @@ -63,7 +63,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface ReplaceOptions<T>

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

    Hierarchy

    • ReplaceOptions
    +
  • Defined in types/modifiers.ts:78
    • @@ -46,14 +46,14 @@

    from

    A CapOptions or NumberString, representing what numbers or kind of numbers are to be replaced

    +
  • Defined in types/modifiers.ts:80

    • to

    to: NumberString<T>

    A NumberString, representing what number will replace numbers matching the from key.

    +
  • Defined in types/modifiers.ts:82
    • @@ -73,7 +73,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface RerollModifier<T>

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

    Hierarchy

    • RerollModifier
    +
  • Defined in types/modifiers.ts:69
    • @@ -43,7 +43,7 @@

    Properties

    reroll

    reroll: RerollOptions<T> | RerollOptions<T>[]
    +
  • Defined in types/modifiers.ts:70
    • @@ -63,7 +63,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface RerollOptions<T>

    @@ -29,7 +29,7 @@

    Hierarchy

    • RerollOptions
    +
  • Defined in types/modifiers.ts:57
    • @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in types/modifiers.ts:38

    • Optional lessThan

    lessThan?: NumberString<T>
    @@ -59,21 +59,21 @@

    Optional

    +
  • Defined in types/modifiers.ts:40

    • Optional exact

    exact?: NumberString<T> | NumberString<T>[]

    A single instance or array of NumberString, representing what numbers will be rerolled.

    +
  • Defined in types/modifiers.ts:59

    • Optional maxReroll

    maxReroll?: NumberString<T>

    A NumberString, representing the maximum number of times a die will be rerolled

    +
  • Defined in types/modifiers.ts:61
    • @@ -93,7 +93,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface RollOptions<T>

    @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in types/options.ts:39
    • @@ -46,17 +46,17 @@

    Properties

    Optional quantity

    quantity?: NumberString<T>
    +
  • Defined in types/options.ts:40

    • sides

    sides: NumberString<T>
    +
  • Defined in types/options.ts:41

    • Optional modifiers

    modifiers?: Modifier<T>[]
    +
  • Defined in types/options.ts:42
    • @@ -76,7 +76,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface RollParameters

    @@ -24,7 +24,7 @@

    Hierarchy

    • RollParameters
    +
  • Defined in types/parameters.ts:15
    • @@ -48,30 +48,30 @@

    Optional

    +
  • Defined in types/options.ts:32

    • sides

    sides: number
    +
  • Defined in types/options.ts:41

    • modifiers

    modifiers: Modifier<number>[]
    +
  • Defined in types/parameters.ts:11

    • quantity

    quantity: number
    +
  • Defined in types/parameters.ts:12

    • initialRolls

    initialRolls: number[]
    +
  • Defined in types/parameters.ts:16

    • rollOne

    rollOne: (() => number)
    @@ -84,7 +84,7 @@

    Type declaration

  • Returns number

    • +
  • Defined in types/parameters.ts:17
    • @@ -104,7 +104,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface RollResult

    @@ -21,7 +21,7 @@

    Hierarchy

    • RollResult
    +
  • Defined in types/result.ts:7
    • @@ -41,21 +41,21 @@

    total

    The sum total of the dice rolls, after modifiers have been applied

    +
  • Defined in types/result.ts:9

    • rolls

    rolls: number[]

    An array of the numbers of each individual die rolled, after modifiers have been applied

    +
  • Defined in types/result.ts:11

    • rollParameters

    rollParameters: RollParameters

    The object used the calculate the total and rolls

    +
  • Defined in types/result.ts:13
    • @@ -75,7 +75,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface UniqueModifier<T>

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

    Hierarchy

    • UniqueModifier
    +
  • Defined in types/modifiers.ts:109
    • @@ -43,7 +43,7 @@

    Properties

    unique

    unique: boolean | UniqueOptions<T>
    +
  • Defined in types/modifiers.ts:110
    • @@ -63,7 +63,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface UniqueOptions<T>

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

    Hierarchy

    • UniqueOptions
    +
  • Defined in types/modifiers.ts:99
    • @@ -45,7 +45,7 @@

    notUnique

    An array of NumberString, representing numbers that are allowed to repeat in the roll.

    +
  • Defined in types/modifiers.ts:101
    • @@ -65,7 +65,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Interface UserOptions<D>

    @@ -28,7 +28,7 @@

    Hierarchy

    • UserOptions
    +
  • Defined in types/options.ts:28
    • @@ -47,14 +47,14 @@

    Optional

    Whether or not to display a RollResult (true) or a number (false)

    +
  • Defined in types/options.ts:30

    • Optional randomizer

    randomizer?: Randomizer

    A custom functtion that replaces the default randomizer function

    +
  • Defined in types/options.ts:32
    • @@ -74,7 +74,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4
    -

    randsum - v1.5.3

    +

    randsum - v1.5.4

    Index

    @@ -66,7 +66,7 @@

    Theme

    randsum - v1.5.3 +
  • The search index is not available
    • randsum - v1.5.4

    Type alias DiceNotation

    DiceNotation: `${number}${"d" | "D"}${number}${string}`
    @@ -19,7 +19,7 @@

    Type alias DiceNotation

    See Randsum Dice Notation for more.

    +
  • Defined in types/primitives.ts:6
    • @@ -39,7 +39,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Type alias Modifier<T>

    Modifier<T>: CapModifier<T> | DropModifier<T> | ReplaceModifier<T> | RerollModifier<T> | ExplodeModifier | UniqueModifier<T> | PlusModifier<T> | MinusModifier<T>
    @@ -21,7 +21,7 @@

    Type Parameters

  • T extends number | "inclusive" = "inclusive"

    • +
  • Defined in types/modifiers.ts:140
    • @@ -41,7 +41,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Type alias NumberString<T>

    NumberString<T>: T extends "inclusive" ? number | `${number}` : number
    @@ -25,7 +25,7 @@

    Type Parameters

  • T extends number | "inclusive" = "inclusive"

    • +
  • Defined in types/primitives.ts:17
    • @@ -45,7 +45,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Type alias Randomizer

    Randomizer: ((sides: NumberString) => number)
    @@ -30,7 +30,7 @@

    Parameters

    sides: NumberString

    Returns number

    +
  • Defined in types/options.ts:21
    • @@ -50,7 +50,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Type alias RandsumOptions<D>

    RandsumOptions<D>: RollOptions & UserOptions<D>
    @@ -23,7 +23,7 @@

    D extends

    Making overloading a breeze, always a Boolean.

    +
  • Defined in types/options.ts:9
    • @@ -43,7 +43,7 @@

    Theme

    randsum - v1.5.3
    +
  • The search index is not available
    • randsum - v1.5.4

    Type alias RandsumOptionsWithoutSides<D>

    RandsumOptionsWithoutSides<D>: Omit<RandsumOptions<D>, "sides">
    @@ -23,7 +23,7 @@

    D extends

    Making overloading a breeze, always a Boolean.

    +
  • Defined in types/options.ts:16
    • @@ -43,7 +43,7 @@

    Theme