diff --git a/docs/api/classes/AggregateDisposable.html b/docs/api/classes/AggregateDisposable.html index 602b2b0..77dbb7f 100644 --- a/docs/api/classes/AggregateDisposable.html +++ b/docs/api/classes/AggregateDisposable.html @@ -1,9 +1,9 @@ AggregateDisposable | @michaelcoxon/utilities

Class AggregateDisposable

A Disposable that can collect disposable objects and dispose then when it is disposed

-

Hierarchy

  • AggregateDisposable

Implements

Constructors

constructor +

Hierarchy

  • AggregateDisposable

Implements

Constructors

constructor

Properties

#disposables #disposed

Methods

dispose disposeAsync track -

Constructors

constructor

Properties

Private #disposables

#disposables: IDisposable[]

Private #disposed

#disposed: boolean = false

Methods

dispose

disposeAsync

track

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private #disposables

#disposables: IDisposable[]

Private #disposed

#disposed: boolean = false

Methods

dispose

disposeAsync

track

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Assertions.ArgumentAssertionBuilder.html b/docs/api/classes/Assertions.ArgumentAssertionBuilder.html index 9440f23..9dc3034 100644 --- a/docs/api/classes/Assertions.ArgumentAssertionBuilder.html +++ b/docs/api/classes/Assertions.ArgumentAssertionBuilder.html @@ -1,6 +1,6 @@ ArgumentAssertionBuilder | @michaelcoxon/utilities

Class ArgumentAssertionBuilder<T>

Instance of

See

IArgumentAssertionBuilder

-

Type Parameters

  • T

Hierarchy

Implements

  • IArgumentAssertionBuilder<T>

Constructors

constructor +

Type Parameters

  • T

Hierarchy

Implements

  • IArgumentAssertionBuilder<T>

Constructors

constructor

Properties

argument argumentName

Methods

isNotNull @@ -9,13 +9,13 @@ isOneOf isTypeOf matches -

Constructors

constructor

Properties

Readonly argument

argument: T

Readonly argumentName

argumentName: string

Methods

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

Constructors

constructor

Properties

Readonly argument

argument: T

Readonly argumentName

argumentName: string

Methods

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

matches

  • Asserts on the value of predicate to whether the assertion is valid.

    +

Returns ArgumentAssertionBuilder<T>

matches

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns ArgumentAssertionBuilder<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Assertions.ArrayLikeArgumentAssertionBuilder.html b/docs/api/classes/Assertions.ArrayLikeArgumentAssertionBuilder.html index b98c7d7..e2166cb 100644 --- a/docs/api/classes/Assertions.ArrayLikeArgumentAssertionBuilder.html +++ b/docs/api/classes/Assertions.ArrayLikeArgumentAssertionBuilder.html @@ -1,6 +1,6 @@ ArrayLikeArgumentAssertionBuilder | @michaelcoxon/utilities

Class ArrayLikeArgumentAssertionBuilder<T>

Instance of

See

IArgumentAssertionBuilder

-

Type Parameters

  • T

Hierarchy

Constructors

constructor +

Type Parameters

  • T

Hierarchy

Constructors

constructor

Properties

argument argumentName

Methods

isNotEmpty @@ -11,15 +11,15 @@ isOneOf isTypeOf matches -

Constructors

constructor

Properties

Readonly argument

argument: ArrayLike<T>

Readonly argumentName

argumentName: string

Methods

isNotEmpty

isNotNull

isNotNullOrUndefined

isNotNullOrUndefinedOrEmpty

isNotUndefined

isOneOf

isTypeOf

Constructors

constructor

Properties

Readonly argument

argument: ArrayLike<T>

Readonly argumentName

argumentName: string

Methods

isNotEmpty

isNotNull

isNotNullOrUndefined

isNotNullOrUndefinedOrEmpty

isNotUndefined

isOneOf

isTypeOf

matches

Returns ArrayLikeArgumentAssertionBuilder<T>

matches

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns ArrayLikeArgumentAssertionBuilder<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Assertions.CompareAssertionBuilder.html b/docs/api/classes/Assertions.CompareAssertionBuilder.html index f64d340..10433ce 100644 --- a/docs/api/classes/Assertions.CompareAssertionBuilder.html +++ b/docs/api/classes/Assertions.CompareAssertionBuilder.html @@ -1,6 +1,6 @@ CompareAssertionBuilder | @michaelcoxon/utilities

Class CompareAssertionBuilder<T>

Instance of

See

IArgumentAssertionBuilder

-

Type Parameters

Hierarchy

Constructors

constructor +

Type Parameters

Hierarchy

Constructors

constructor

Properties

argument argumentName

Methods

isEqualTo @@ -14,13 +14,13 @@ isOneOf isTypeOf matches -

Constructors

constructor

Properties

Readonly argument

argument: T

Readonly argumentName

argumentName: string

Methods

isEqualTo

isGreaterThan

isGreaterThanOrEqualTo

isLessThan

isLessThanOrEqualTo

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

Constructors

constructor

Properties

Readonly argument

argument: T

Readonly argumentName

argumentName: string

Methods

isEqualTo

isGreaterThan

isGreaterThanOrEqualTo

isLessThan

isLessThanOrEqualTo

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

matches

  • Asserts on the value of predicate to whether the assertion is valid.

    +

Returns CompareAssertionBuilder<T>

matches

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns CompareAssertionBuilder<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Assertions.GuidArgumentAssertionBuilder.html b/docs/api/classes/Assertions.GuidArgumentAssertionBuilder.html index 57f23fd..b5897dd 100644 --- a/docs/api/classes/Assertions.GuidArgumentAssertionBuilder.html +++ b/docs/api/classes/Assertions.GuidArgumentAssertionBuilder.html @@ -1,6 +1,6 @@ GuidArgumentAssertionBuilder | @michaelcoxon/utilities

Class GuidArgumentAssertionBuilder

Instance of

See

IArgumentAssertionBuilder

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

argument argumentName

Methods

isNotNull @@ -10,13 +10,13 @@ isTypeOf isValidGuid matches -

Constructors

constructor

Properties

Readonly argument

argument: Guid

Readonly argumentName

argumentName: string

Methods

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

Constructors

constructor

Properties

Readonly argument

argument: Guid

Readonly argumentName

argumentName: string

Methods

isNotNull

isNotNullOrUndefined

isNotUndefined

isOneOf

isTypeOf

isValidGuid

matches

Returns GuidArgumentAssertionBuilder

isValidGuid

matches

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns GuidArgumentAssertionBuilder

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Assertions.StringArgumentAssertionBuilder.html b/docs/api/classes/Assertions.StringArgumentAssertionBuilder.html index 2560b31..8223c74 100644 --- a/docs/api/classes/Assertions.StringArgumentAssertionBuilder.html +++ b/docs/api/classes/Assertions.StringArgumentAssertionBuilder.html @@ -1,6 +1,6 @@ StringArgumentAssertionBuilder | @michaelcoxon/utilities

Class StringArgumentAssertionBuilder

Instance of

See

IArgumentAssertionBuilder

-

Hierarchy

Implements

  • IArgumentAssertionBuilder<string>

Constructors

constructor +

Hierarchy

Implements

  • IArgumentAssertionBuilder<string>

Constructors

constructor

Properties

argument argumentName

Methods

isEqualTo @@ -17,28 +17,28 @@ isTypeOf matches matchesRegex -

Constructors

constructor

Properties

Readonly argument

argument: string

Readonly argumentName

argumentName: string

Methods

isEqualTo

Constructors

constructor

Properties

Readonly argument

argument: string

Readonly argumentName

argumentName: string

Methods

isEqualTo

isGreaterThan

Returns StringArgumentAssertionBuilder

Throws

isGreaterThan

isGreaterThanOrEqualTo

Returns StringArgumentAssertionBuilder

Throws

isGreaterThanOrEqualTo

isLessThan

Returns StringArgumentAssertionBuilder

Throws

isLessThan

isLessThanOrEqualTo

Returns StringArgumentAssertionBuilder

Throws

isLessThanOrEqualTo

isNotEmpty

isNotNull

isNotNullOrUndefined

isNotNullOrUndefinedOrEmpty

isNotUndefined

isOneOf

isTypeOf

Returns StringArgumentAssertionBuilder

isNotEmpty

isNotNull

isNotNullOrUndefined

isNotNullOrUndefinedOrEmpty

isNotUndefined

isOneOf

isTypeOf

matches

Returns StringArgumentAssertionBuilder

matches

matchesRegex

Returns StringArgumentAssertionBuilder

matchesRegex

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns StringArgumentAssertionBuilder

Throws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Cache.AsyncCacheItem.html b/docs/api/classes/Cache.AsyncCacheItem.html index ff7f69b..9df16ed 100644 --- a/docs/api/classes/Cache.AsyncCacheItem.html +++ b/docs/api/classes/Cache.AsyncCacheItem.html @@ -1,6 +1,6 @@ -AsyncCacheItem | @michaelcoxon/utilities

Class AsyncCacheItem<T>

Type Parameters

  • T

Hierarchy

  • AsyncCacheItem

Implements

Constructors

constructor +AsyncCacheItem | @michaelcoxon/utilities

Class AsyncCacheItem<T>

Type Parameters

  • T

Hierarchy

  • AsyncCacheItem

Implements

Constructors

constructor

Properties

#expiryPolicy #promiseOrValue

Accessors

expiredAsync valueAsync -

Constructors

constructor

Properties

Private Readonly #expiryPolicy

#expiryPolicy: IExpiryPolicyDelegate<T, AsyncCacheItem<T>>

Private Readonly #promiseOrValue

#promiseOrValue: Awaitable<T>

Accessors

expiredAsync

valueAsync

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly #expiryPolicy

#expiryPolicy: IExpiryPolicyDelegate<T, AsyncCacheItem<T>>

Private Readonly #promiseOrValue

#promiseOrValue: Awaitable<T>

Accessors

expiredAsync

valueAsync

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Cache.CacheExpiredException.html b/docs/api/classes/Cache.CacheExpiredException.html index f1303c9..6ad5827 100644 --- a/docs/api/classes/Cache.CacheExpiredException.html +++ b/docs/api/classes/Cache.CacheExpiredException.html @@ -1,5 +1,5 @@ CacheExpiredException | @michaelcoxon/utilities

Class CacheExpiredException

Represents errors that occur during application execution.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

#innerException? __proto__ cause? @@ -11,8 +11,8 @@

Accessors

innerException

Methods

captureStackTrace isException -

Constructors

constructor

Properties

Private Optional Readonly #innerException

#innerException?: Exception

__proto__

__proto__: Error

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

Private Optional Readonly #innerException

#innerException?: Exception

__proto__

__proto__: Error

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

innerException

Methods

Static captureStackTrace

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static isException

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns undefined | Exception

Methods

Static captureStackTrace

Static isException

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Cache.MemoryCache.html b/docs/api/classes/Cache.MemoryCache.html index 945043d..414d0ae 100644 --- a/docs/api/classes/Cache.MemoryCache.html +++ b/docs/api/classes/Cache.MemoryCache.html @@ -1,5 +1,5 @@ MemoryCache | @michaelcoxon/utilities

Class MemoryCache<TKey>

Creates an in-memory cache. This cache will be forgotten on disposal.

-

Type Parameters

  • TKey = string

Hierarchy

  • MemoryCache

Implements

Constructors

constructor +

Type Parameters

  • TKey = string

Hierarchy

  • MemoryCache

Implements

Constructors

constructor

Properties

#internalCache

Methods

add addOrGetAsync @@ -8,4 +8,4 @@ getAsync replace tryGetAsync -

Constructors

constructor

Properties

Private Readonly #internalCache

#internalCache: Map<TKey, IAsyncCacheItem<any>>

Methods

add

addOrGetAsync

addOrReplace

cleanAsync

getAsync

replace

tryGetAsync

  • Type Parameters

    • T

    Parameters

    • key: TKey

    Returns Promise<{
        success: boolean;
        value?: T;
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly #internalCache

#internalCache: Map<TKey, IAsyncCacheItem<any>>

Methods

add

addOrGetAsync

addOrReplace

cleanAsync

getAsync

replace

tryGetAsync

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api/classes/Comparers.CaseInsensitiveStringComparer.html b/docs/api/classes/Comparers.CaseInsensitiveStringComparer.html index 48ff95a..e11537f 100644 --- a/docs/api/classes/Comparers.CaseInsensitiveStringComparer.html +++ b/docs/api/classes/Comparers.CaseInsensitiveStringComparer.html @@ -1,4 +1,4 @@ -CaseInsensitiveStringComparer | @michaelcoxon/utilities

Class CaseInsensitiveStringComparer

Hierarchy

  • CaseInsensitiveStringComparer

Implements

Constructors

constructor +CaseInsensitiveStringComparer | @michaelcoxon/utilities

Class CaseInsensitiveStringComparer

Hierarchy

  • CaseInsensitiveStringComparer

Implements

Constructors

constructor

Methods

compare equals greaterThan @@ -11,9 +11,9 @@
  • x == y : return 0
  • x > y : return >0
    • -

    Parameters

    • x: string
    • y: string

    Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • x: string
    • y: string

    Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Comparers.CustomComparer.html b/docs/api/classes/Comparers.CustomComparer.html index 1338ef3..b48bca0 100644 --- a/docs/api/classes/Comparers.CustomComparer.html +++ b/docs/api/classes/Comparers.CustomComparer.html @@ -1,4 +1,4 @@ -CustomComparer | @michaelcoxon/utilities

    Class CustomComparer<T>

    Type Parameters

    • T

    Hierarchy

    • CustomComparer

    Implements

    Constructors

    constructor +CustomComparer | @michaelcoxon/utilities

    Class CustomComparer<T>

    Type Parameters

    • T

    Hierarchy

    • CustomComparer

    Implements

    Constructors

    constructor

    Properties

    #comparer? #equalityComparer?

    Methods

    compare @@ -7,15 +7,15 @@ greaterThanOrEqual lessThan lessThanOrEqual -

    Constructors

    constructor

    • Type Parameters

      • T

      Parameters

      • Optional comparer: ((a, b) => number)
          • (a, b): number

          • Parameters

            • a: T
            • b: T

            Returns number

      • Optional equalityComparer: ((x, y) => boolean)
          • (x, y): boolean

          • Parameters

            • x: T
            • y: T

            Returns boolean

      Returns CustomComparer<T>

    Properties

    Private Optional Readonly #comparer

    #comparer?: ((a, b) => number)

    Type declaration

      • (a, b): number

      • Parameters

        • a: T
        • b: T

        Returns number

    Private Optional Readonly #equalityComparer

    #equalityComparer?: ((x, y) => boolean)

    Type declaration

      • (x, y): boolean

      • Parameters

        • x: T
        • y: T

        Returns boolean

    Methods

    compare

    • Compares 'x' to 'y' where the following rules apply;

      +

    Constructors

    constructor

    • Type Parameters

      • T

      Parameters

      • Optional comparer: ((a, b) => number)
          • (a, b): number

          • Parameters

            • a: T
            • b: T

            Returns number

      • Optional equalityComparer: ((x, y) => boolean)
          • (x, y): boolean

          • Parameters

            • x: T
            • y: T

            Returns boolean

      Returns CustomComparer<T>

    Properties

    Private Optional Readonly #comparer

    #comparer?: ((a, b) => number)

    Type declaration

      • (a, b): number

      • Parameters

        • a: T
        • b: T

        Returns number

    Private Optional Readonly #equalityComparer

    #equalityComparer?: ((x, y) => boolean)

    Type declaration

      • (x, y): boolean

      • Parameters

        • x: T
        • y: T

        Returns boolean

    Methods

    compare

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Comparers.MapComparer.html b/docs/api/classes/Comparers.MapComparer.html index 9a00ec7..9630be4 100644 --- a/docs/api/classes/Comparers.MapComparer.html +++ b/docs/api/classes/Comparers.MapComparer.html @@ -1,6 +1,6 @@ MapComparer | @michaelcoxon/utilities

    Class MapComparer<T, TProperty>

    Compares objects of the same type using a custom selector and a comparer for the selector's return value.

    -

    Type Parameters

    • T

    • TProperty

    Hierarchy

    • MapComparer

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    • TProperty

    Hierarchy

    • MapComparer

    Implements

    Constructors

    constructor

    Properties

    #comparer #selector

    Methods

    compare @@ -9,15 +9,15 @@ greaterThanOrEqual lessThan lessThanOrEqual -

    Constructors

    constructor

    Properties

    Private Readonly #comparer

    #comparer: IComparer<TProperty>

    Private Readonly #selector

    #selector: ((a) => TProperty)

    Type declaration

      • (a): TProperty

      • Parameters

        • a: T

        Returns TProperty

    Methods

    compare

    • Compares 'x' to 'y' where the following rules apply;

      +

    Constructors

    constructor

    Properties

    Private Readonly #comparer

    #comparer: IComparer<TProperty>

    Private Readonly #selector

    #selector: ((a) => TProperty)

    Type declaration

      • (a): TProperty

      • Parameters

        • a: T

        Returns TProperty

    Methods

    compare

    • Compares 'x' to 'y' where the following rules apply;

      • x < y : return <0
      • x == y : return 0
      • x > y : return >0
      -

      Parameters

      • x: T
      • y: T

      Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Comparers.ReverseComparer.html b/docs/api/classes/Comparers.ReverseComparer.html index bc11882..5fb5204 100644 --- a/docs/api/classes/Comparers.ReverseComparer.html +++ b/docs/api/classes/Comparers.ReverseComparer.html @@ -1,5 +1,5 @@ ReverseComparer | @michaelcoxon/utilities

    Class ReverseComparer<T>

    reverses the comparer provided

    -

    Type Parameters

    • T

    Hierarchy

    • ReverseComparer

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    • ReverseComparer

    Implements

    Constructors

    constructor

    Properties

    #comparer

    Methods

    compare equals @@ -7,15 +7,15 @@ greaterThanOrEqual lessThan lessThanOrEqual -

    Constructors

    constructor

    Properties

    Private Readonly #comparer

    #comparer: IComparer<T>

    Methods

    compare

    • Compares 'x' to 'y' where the following rules apply;

      +

    Constructors

    constructor

    Properties

    Private Readonly #comparer

    #comparer: IComparer<T>

    Methods

    compare

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns number

    equals

    greaterThan

    greaterThanOrEqual

    lessThan

    lessThanOrEqual

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Configuration.JsonConfigurationBuilder.html b/docs/api/classes/Configuration.JsonConfigurationBuilder.html index 82760d7..c1bcf87 100644 --- a/docs/api/classes/Configuration.JsonConfigurationBuilder.html +++ b/docs/api/classes/Configuration.JsonConfigurationBuilder.html @@ -1,7 +1,7 @@ -JsonConfigurationBuilder | @michaelcoxon/utilities

    Class JsonConfigurationBuilder

    Hierarchy

    • JsonConfigurationBuilder

    Implements

    Constructors

    constructor +JsonConfigurationBuilder | @michaelcoxon/utilities

    Class JsonConfigurationBuilder

    Hierarchy

    • JsonConfigurationBuilder

    Implements

    Constructors

    constructor

    Properties

    #configs #configuration? #reload

    Methods

    append build -

    Constructors

    constructor

    Properties

    Private Readonly #configs

    #configs: Record<string, ConfigValue>[] = []

    Private Optional #configuration

    #configuration?: IConfiguration

    Private #reload

    #reload: boolean = false

    Methods

    append

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #configs

    #configs: Record<string, ConfigValue>[] = []

    Private Optional #configuration

    #configuration?: IConfiguration

    Private #reload

    #reload: boolean = false

    Methods

    append

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.ArrayEnumerable.html b/docs/api/classes/Enumerables.ArrayEnumerable.html index 11d1db4..acb421f 100644 --- a/docs/api/classes/Enumerables.ArrayEnumerable.html +++ b/docs/api/classes/Enumerables.ArrayEnumerable.html @@ -1,4 +1,4 @@ -ArrayEnumerable | @michaelcoxon/utilities

    Class ArrayEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +ArrayEnumerable | @michaelcoxon/utilities

    Class ArrayEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    _array

    Methods

    [iterator] all @@ -36,53 +36,53 @@ toDictionary toList where -

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    Private internalOrderBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    Private internalOrderBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.Collection.html b/docs/api/classes/Enumerables.Collection.html index 2b46734..80c9870 100644 --- a/docs/api/classes/Enumerables.Collection.html +++ b/docs/api/classes/Enumerables.Collection.html @@ -1,4 +1,4 @@ -Collection | @michaelcoxon/utilities

    Class Collection<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +Collection | @michaelcoxon/utilities

    Class Collection<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    _array

    Accessors

    isReadOnly length @@ -41,62 +41,62 @@ toDictionary toList where -

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    • Adds an item to the ICollection.

      +

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    all

    any

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    Returns boolean

    copyTo

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.Dictionary.html b/docs/api/classes/Enumerables.Dictionary.html index 49d0264..e517f26 100644 --- a/docs/api/classes/Enumerables.Dictionary.html +++ b/docs/api/classes/Enumerables.Dictionary.html @@ -1,4 +1,4 @@ -Dictionary | @michaelcoxon/utilities

    Class Dictionary<TKey, TValue>

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implements

    Constructors

    constructor +Dictionary | @michaelcoxon/utilities

    Class Dictionary<TKey, TValue>

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #hashtable isReadOnly

    Accessors

    keys @@ -48,62 +48,62 @@ toList tryGetValue where -

    Constructors

    constructor

    Properties

    Private #hashtable

    #hashtable: {
        [hash: string]: KeyValuePair<TKey, TValue>;
    }

    Type declaration

    Readonly isReadOnly

    isReadOnly: boolean = false

    Gets a value indicating whether the ICollection is read-only.

    -

    Accessors

    keys

    length

    values

    Methods

    [iterator]

    add

    • Adds an item to the ICollection.

      +

    Constructors

    constructor

    Properties

    Private #hashtable

    #hashtable: {
        [hash: string]: KeyValuePair<TKey, TValue>;
    }

    Type declaration

    Readonly isReadOnly

    isReadOnly: boolean = false

    Gets a value indicating whether the ICollection is read-only.

    +

    Accessors

    keys

    length

    values

    Methods

    [iterator]

    add

    addKeyValue

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    addKeyValue

    all

    any

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    containsKey

    copyTo

    Returns boolean

    containsKey

    copyTo

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    itemByKey

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<KeyValuePair<TKey, TValue>>

    itemByKey

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    remove

    removeByKey

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    remove

    removeByKey

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    tryGetValue

    where

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    toArray

    toDictionary

    toList

    tryGetValue

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.Enumerable.html b/docs/api/classes/Enumerables.Enumerable.html index c15ffbf..68df976 100644 --- a/docs/api/classes/Enumerables.Enumerable.html +++ b/docs/api/classes/Enumerables.Enumerable.html @@ -1,6 +1,6 @@ -Enumerable | @michaelcoxon/utilities

    Class Enumerable

    Hierarchy

    • Enumerable

    Constructors

    constructor +Enumerable | @michaelcoxon/utilities

    Class Enumerable

    Hierarchy

    • Enumerable

    Constructors

    constructor

    Methods

    asArray asEnumerable empty range -

    Constructors

    constructor

    Methods

    Static asArray

    Static asEnumerable

    Static empty

    Static range

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    Static asArray

    Static asEnumerable

    Static empty

    Static range

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.EnumerableBase.html b/docs/api/classes/Enumerables.EnumerableBase.html index 6da2fe3..5e40223 100644 --- a/docs/api/classes/Enumerables.EnumerableBase.html +++ b/docs/api/classes/Enumerables.EnumerableBase.html @@ -1,4 +1,4 @@ -EnumerableBase | @michaelcoxon/utilities

    Class EnumerableBase<T>Abstract

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +EnumerableBase | @michaelcoxon/utilities

    Class EnumerableBase<T>Abstract

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Methods

    [iterator] all any @@ -35,53 +35,53 @@ toDictionary toList where -

    Constructors

    constructor

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Constructors

    constructor

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    Abstract getEnumerator

    groupBy

    Private internalOrderBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    forEach

    Abstract getEnumerator

    groupBy

    Private internalOrderBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.EnumeratorEnumerable.html b/docs/api/classes/Enumerables.EnumeratorEnumerable.html index eb7887f..35f28ca 100644 --- a/docs/api/classes/Enumerables.EnumeratorEnumerable.html +++ b/docs/api/classes/Enumerables.EnumeratorEnumerable.html @@ -1,4 +1,4 @@ -EnumeratorEnumerable | @michaelcoxon/utilities

    Class EnumeratorEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor +EnumeratorEnumerable | @michaelcoxon/utilities

    Class EnumeratorEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor

    Properties

    #enumerator

    Methods

    [iterator] all @@ -35,53 +35,53 @@ toDictionary toList where -

    Constructors

    constructor

    Properties

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Constructors

    constructor

    Properties

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Methods

    [iterator]

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.LinkedList.html b/docs/api/classes/Enumerables.LinkedList.html index fcf4319..bee9501 100644 --- a/docs/api/classes/Enumerables.LinkedList.html +++ b/docs/api/classes/Enumerables.LinkedList.html @@ -1,4 +1,4 @@ -LinkedList | @michaelcoxon/utilities

    Class LinkedList<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +LinkedList | @michaelcoxon/utilities

    Class LinkedList<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #count #current? #root? @@ -44,63 +44,63 @@ toList traverse where -

    Constructors

    constructor

    Properties

    Private #count

    #count: number

    Private Optional #current

    #current?: LinkedListItem<T>

    Private Optional #root

    #root?: LinkedListItem<T>

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    • Adds an item to the ICollection.

      +

    Constructors

    constructor

    Properties

    Private #count

    #count: number

    Private Optional #current

    #current?: LinkedListItem<T>

    Private Optional #root

    #root?: LinkedListItem<T>

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    all

    any

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    Returns boolean

    copyTo

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    Private traverse

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    Private traverse

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.List.html b/docs/api/classes/Enumerables.List.html index be1f23b..211b505 100644 --- a/docs/api/classes/Enumerables.List.html +++ b/docs/api/classes/Enumerables.List.html @@ -1,4 +1,4 @@ -List | @michaelcoxon/utilities

    Class List<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +List | @michaelcoxon/utilities

    Class List<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    _array

    Accessors

    isReadOnly length @@ -48,62 +48,62 @@ toDictionary toList where -

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    • Adds an item to the ICollection.

      +

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    addRange

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    addRange

    all

    any

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    Returns boolean

    copyTo

    count

    distinct

    find

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    indexOf

    insert

    item

    Returns void

    count

    distinct

    find

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    indexOf

    insert

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    prependRange

    remove

    removeAt

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    prependRange

    remove

    removeAt

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    sort

    split

    sum

    Returns IEnumerable<T>

    sort

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerables.default.html b/docs/api/classes/Enumerables.default.html index a1581f9..1bafcd6 100644 --- a/docs/api/classes/Enumerables.default.html +++ b/docs/api/classes/Enumerables.default.html @@ -1,4 +1,4 @@ -default | @michaelcoxon/utilities

    Class default<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +default | @michaelcoxon/utilities

    Class default<T>

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    _array

    Accessors

    isReadOnly length @@ -49,83 +49,83 @@ toList unionWith where -

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    • Adds an item to the ICollection.

      +

    Constructors

    constructor

    Properties

    Protected _array

    _array: T[]

    Accessors

    isReadOnly

    length

    Methods

    [iterator]

    add

    all

    any

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      +

    Returns boolean

    copyTo

    count

    distinct

    exceptWith

    Returns void

    count

    distinct

    exceptWith

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    intersectWith

    Returns void

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    intersectWith

    isSubsetOf

    Returns void

    isSubsetOf

    isSupersetOf

    isSupersetOf

    item

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    overlaps

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    overlaps

    prepend

    remove

    select

    selectMany

    setEquals

    prepend

    remove

    select

    selectMany

    setEquals

    single

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    symmetricExceptWith

    Returns number

    symmetricExceptWith

    take

    Returns void

    take

    toArray

    toDictionary

    toList

    unionWith

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    unionWith

    where

    Returns void

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.AggregateEnumerator.html b/docs/api/classes/Enumerators.AggregateEnumerator.html index e4d9cca..f205883 100644 --- a/docs/api/classes/Enumerators.AggregateEnumerator.html +++ b/docs/api/classes/Enumerators.AggregateEnumerator.html @@ -1,4 +1,4 @@ -AggregateEnumerator | @michaelcoxon/utilities

    Class AggregateEnumerator<T, TReturn>

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor +AggregateEnumerator | @michaelcoxon/utilities

    Class AggregateEnumerator<T, TReturn>

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #accumulate? #aggregateFunction #enumerator @@ -10,8 +10,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Optional #accumulate

    #accumulate?: TReturn

    Private Readonly #aggregateFunction

    #aggregateFunction: ((acumulate, current) => TReturn)

    Type declaration

      • (acumulate, current): TReturn

      • Parameters

        • acumulate: TReturn
        • current: T

        Returns TReturn

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Optional Readonly #initialValue

    #initialValue?: TReturn

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional #accumulate

    #accumulate?: TReturn

    Private Readonly #aggregateFunction

    #aggregateFunction: ((acumulate, current) => TReturn)

    Type declaration

      • (acumulate, current): TReturn

      • Parameters

        • acumulate: TReturn
        • current: T

        Returns TReturn

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Optional Readonly #initialValue

    #initialValue?: TReturn

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.AppendEnumerator.html b/docs/api/classes/Enumerators.AppendEnumerator.html index 544dc2f..b8d0865 100644 --- a/docs/api/classes/Enumerators.AppendEnumerator.html +++ b/docs/api/classes/Enumerators.AppendEnumerator.html @@ -1,5 +1,5 @@ AppendEnumerator | @michaelcoxon/utilities

    Class AppendEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #appendedItemsEnumerator #current #enumerator @@ -10,8 +10,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Readonly #appendedItemsEnumerator

    #appendedItemsEnumerator: IEnumerator<T>

    Private #current

    #current: Undefinable<T>

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #appendedItemsEnumerator

    #appendedItemsEnumerator: IEnumerator<T>

    Private #current

    #current: Undefinable<T>

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.ArrayEnumerator.html b/docs/api/classes/Enumerators.ArrayEnumerator.html index 2865c6b..a925501 100644 --- a/docs/api/classes/Enumerators.ArrayEnumerator.html +++ b/docs/api/classes/Enumerators.ArrayEnumerator.html @@ -1,5 +1,5 @@ ArrayEnumerator | @michaelcoxon/utilities

    Class ArrayEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #baseArray #pointer return? @@ -13,8 +13,8 @@

    Constructors

    constructor

    Properties

    Private Readonly #baseArray

    #baseArray: T[]

    Private #pointer

    #pointer: number = -1

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Private throwOutOfBoundsException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ArrayEnumerator<T>

    Properties

    Private Readonly #baseArray

    #baseArray: T[]

    Private #pointer

    #pointer: number = -1

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Private throwOutOfBoundsException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.AsyncEnumerator.html b/docs/api/classes/Enumerators.AsyncEnumerator.html index cb12b7c..440a9e2 100644 --- a/docs/api/classes/Enumerators.AsyncEnumerator.html +++ b/docs/api/classes/Enumerators.AsyncEnumerator.html @@ -1,9 +1,9 @@ -AsyncEnumerator | @michaelcoxon/utilities

    Class AsyncEnumerator<T>

    Type Parameters

    • T

    Hierarchy

    • AsyncEnumerator

    Implements

    Constructors

    constructor +AsyncEnumerator | @michaelcoxon/utilities

    Class AsyncEnumerator<T>

    Type Parameters

    • T

    Hierarchy

    • AsyncEnumerator

    Implements

    Constructors

    constructor

    Properties

    #baseArray #current? #pointer

    Accessors

    current

    Methods

    moveNextAsync -

    Constructors

    constructor

    Properties

    Private Readonly #baseArray

    #baseArray: Awaitable<T>[]

    Private Optional #current

    #current?: T

    Private #pointer

    #pointer: number = -1

    Accessors

    current

    Methods

    moveNextAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #baseArray

    #baseArray: Awaitable<T>[]

    Private Optional #current

    #current?: T

    Private #pointer

    #pointer: number = -1

    Accessors

    current

    Methods

    moveNextAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.DictionaryEnumerator.html b/docs/api/classes/Enumerators.DictionaryEnumerator.html index ce5047c..3dfe740 100644 --- a/docs/api/classes/Enumerators.DictionaryEnumerator.html +++ b/docs/api/classes/Enumerators.DictionaryEnumerator.html @@ -1,5 +1,5 @@ DictionaryEnumerator | @michaelcoxon/utilities

    Class DictionaryEnumerator<TKey, TValue>

    Enumrates an object source for values.

    -

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #dictionary #keyEnumerator return? @@ -9,8 +9,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Readonly #dictionary

    #dictionary: IDictionary<TKey, TValue>

    Private Readonly #keyEnumerator

    #keyEnumerator: IEnumerator<TKey>

    Optional Readonly return

    return?: ((value?) => IteratorResult<KeyValuePair<TKey, TValue>, KeyValuePair<TKey, TValue>>)

    Type declaration

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<KeyValuePair<TKey, TValue>, KeyValuePair<TKey, TValue>>)

    Type declaration

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #dictionary

    #dictionary: IDictionary<TKey, TValue>

    Private Readonly #keyEnumerator

    #keyEnumerator: IEnumerator<TKey>

    Optional Readonly return

    return?: ((value?) => IteratorResult<KeyValuePair<TKey, TValue>, KeyValuePair<TKey, TValue>>)

    Type declaration

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<KeyValuePair<TKey, TValue>, KeyValuePair<TKey, TValue>>)

    Type declaration

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.EnumeratorBase.html b/docs/api/classes/Enumerators.EnumeratorBase.html index c58546d..6d85672 100644 --- a/docs/api/classes/Enumerators.EnumeratorBase.html +++ b/docs/api/classes/Enumerators.EnumeratorBase.html @@ -1,5 +1,5 @@ EnumeratorBase | @michaelcoxon/utilities

    Class EnumeratorBase<T>Abstract

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    current return? throw? @@ -8,7 +8,7 @@ peek reset

    Constructors

    constructor

    Properties

    Readonly Abstract current

    current: T

    value of the current element

    -

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Methods

    Abstract moveNext

    next

    Abstract peek

    Abstract reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

    Methods

    Abstract moveNext

    next

    Abstract peek

    Abstract reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.IterableEnumerator.html b/docs/api/classes/Enumerators.IterableEnumerator.html index 80f773d..df7dbc0 100644 --- a/docs/api/classes/Enumerators.IterableEnumerator.html +++ b/docs/api/classes/Enumerators.IterableEnumerator.html @@ -1,5 +1,5 @@ IterableEnumerator | @michaelcoxon/utilities

    Class IterableEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #current? #items #iterable @@ -12,10 +12,10 @@ peek reset items -

    Constructors

    constructor

    Properties

    Private Optional #current

    #current?: IteratorResult<T, void>

    Private #items

    #items: Generator<T, void, unknown>

    Private Readonly #iterable

    #iterable: Iterable<T>

    Private Optional #peak

    #peak?: IteratorResult<T, void>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    • returns the next element without moving the pointer forwards

      +

    Constructors

    constructor

    Properties

    Private Optional #current

    #current?: IteratorResult<T, void>

    Private #items

    #items: Generator<T, void, unknown>

    Private Readonly #iterable

    #iterable: Iterable<T>

    Private Optional #peak

    #peak?: IteratorResult<T, void>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    reset

    Static Private items

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Static Private items

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.LinkedListEnumerator.html b/docs/api/classes/Enumerators.LinkedListEnumerator.html index 5f97b2f..991dd6b 100644 --- a/docs/api/classes/Enumerators.LinkedListEnumerator.html +++ b/docs/api/classes/Enumerators.LinkedListEnumerator.html @@ -1,5 +1,5 @@ LinkedListEnumerator | @michaelcoxon/utilities

    Class LinkedListEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #currentIndex #linkedList return? @@ -9,8 +9,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private #currentIndex

    #currentIndex: number

    Private Readonly #linkedList

    #linkedList: LinkedList<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #currentIndex

    #currentIndex: number

    Private Readonly #linkedList

    #linkedList: LinkedList<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.RangeEnumerator.html b/docs/api/classes/Enumerators.RangeEnumerator.html index 1a8c27d..f05392e 100644 --- a/docs/api/classes/Enumerators.RangeEnumerator.html +++ b/docs/api/classes/Enumerators.RangeEnumerator.html @@ -1,5 +1,5 @@ RangeEnumerator | @michaelcoxon/utilities

    Class RangeEnumerator

    Enumrates an object source for values.

    -

    Hierarchy

    Implements

    Constructors

    constructor +

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #count #current? #increment @@ -12,8 +12,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Readonly #count

    #count: number

    Private Optional #current

    #current?: number

    Private Readonly #increment

    #increment: number

    Private #iterations

    #iterations: number

    Private Readonly #start

    #start: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<number, number>)

    Type declaration

      • (value?): IteratorResult<number, number>

      • Parameters

        • Optional value: number

        Returns IteratorResult<number, number>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<number, number>)

    Type declaration

      • (e?): IteratorResult<number, number>

      • Parameters

        • Optional e: number

        Returns IteratorResult<number, number>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #count

    #count: number

    Private Optional #current

    #current?: number

    Private Readonly #increment

    #increment: number

    Private #iterations

    #iterations: number

    Private Readonly #start

    #start: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<number, number>)

    Type declaration

      • (value?): IteratorResult<number, number>

      • Parameters

        • Optional value: number

        Returns IteratorResult<number, number>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<number, number>)

    Type declaration

      • (e?): IteratorResult<number, number>

      • Parameters

        • Optional e: number

        Returns IteratorResult<number, number>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.SelectEnumerator.html b/docs/api/classes/Enumerators.SelectEnumerator.html index bf5f400..11033d0 100644 --- a/docs/api/classes/Enumerators.SelectEnumerator.html +++ b/docs/api/classes/Enumerators.SelectEnumerator.html @@ -1,5 +1,5 @@ SelectEnumerator | @michaelcoxon/utilities

    Class SelectEnumerator<T, TReturn>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #currentItem? #enumerator #selector @@ -10,8 +10,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: TReturn

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #selector

    #selector: Selector<T, TReturn>

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: TReturn

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #selector

    #selector: Selector<T, TReturn>

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.SelectManyEnumerator.html b/docs/api/classes/Enumerators.SelectManyEnumerator.html index 7ba23e0..71a23d0 100644 --- a/docs/api/classes/Enumerators.SelectManyEnumerator.html +++ b/docs/api/classes/Enumerators.SelectManyEnumerator.html @@ -1,5 +1,5 @@ SelectManyEnumerator | @michaelcoxon/utilities

    Class SelectManyEnumerator<T, TReturn>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    • TReturn

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #currentItem? #currentSetEnumerator? #enumerator @@ -11,8 +11,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: TReturn

    Private Optional #currentSetEnumerator

    #currentSetEnumerator?: IEnumerator<TReturn>

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #selector

    #selector: Selector<T, IEnumerable<TReturn>>

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: TReturn

    Private Optional #currentSetEnumerator

    #currentSetEnumerator?: IEnumerator<TReturn>

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #selector

    #selector: Selector<T, IEnumerable<TReturn>>

    Optional Readonly return

    return?: ((value?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (value?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional value: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<TReturn, TReturn>)

    Type declaration

      • (e?): IteratorResult<TReturn, TReturn>

      • Parameters

        • Optional e: TReturn

        Returns IteratorResult<TReturn, TReturn>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.SkipEnumerator.html b/docs/api/classes/Enumerators.SkipEnumerator.html index 67056fa..173affe 100644 --- a/docs/api/classes/Enumerators.SkipEnumerator.html +++ b/docs/api/classes/Enumerators.SkipEnumerator.html @@ -1,5 +1,5 @@ SkipEnumerator | @michaelcoxon/utilities

    Class SkipEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor

    Properties

    #count #currentItem? #enumerator @@ -11,8 +11,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private #count

    #count: number

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #itemsToSkip

    #itemsToSkip: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #count

    #count: number

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #itemsToSkip

    #itemsToSkip: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.TakeEnumerator.html b/docs/api/classes/Enumerators.TakeEnumerator.html index 26a09cc..0036116 100644 --- a/docs/api/classes/Enumerators.TakeEnumerator.html +++ b/docs/api/classes/Enumerators.TakeEnumerator.html @@ -1,5 +1,5 @@ TakeEnumerator | @michaelcoxon/utilities

    Class TakeEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #currentItem? #enumerator #itemsTaken @@ -11,8 +11,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private #itemsTaken

    #itemsTaken: number

    Private Readonly #itemsToTake

    #itemsToTake: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private #itemsTaken

    #itemsTaken: number

    Private Readonly #itemsToTake

    #itemsToTake: number

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Enumerators.WhereEnumerator.html b/docs/api/classes/Enumerators.WhereEnumerator.html index 4b897d0..277525a 100644 --- a/docs/api/classes/Enumerators.WhereEnumerator.html +++ b/docs/api/classes/Enumerators.WhereEnumerator.html @@ -1,5 +1,5 @@ WhereEnumerator | @michaelcoxon/utilities

    Class WhereEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #currentItem? #enumerator #predicate @@ -10,8 +10,8 @@ next peek reset -

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #predicate

    #predicate: Predicate<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional #currentItem

    #currentItem?: T

    Private Readonly #enumerator

    #enumerator: IEnumerator<T>

    Private Readonly #predicate

    #predicate: Predicate<T>

    Optional Readonly return

    return?: ((value?) => IteratorResult<T, T>)

    Type declaration

      • (value?): IteratorResult<T, T>

      • Parameters

        • Optional value: T

        Returns IteratorResult<T, T>

    Optional Readonly throw

    throw?: ((e?) => IteratorResult<T, T>)

    Type declaration

      • (e?): IteratorResult<T, T>

      • Parameters

        • Optional e: T

        Returns IteratorResult<T, T>

    Accessors

    current

    Methods

    moveNext

    next

    peek

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Events.Event.html b/docs/api/classes/Events.Event.html index 1802f17..20858e6 100644 --- a/docs/api/classes/Events.Event.html +++ b/docs/api/classes/Events.Event.html @@ -1,14 +1,14 @@ Event | @michaelcoxon/utilities

    Class Event<TEventArgs>

    Class to represent an event.

    -

    Type Parameters

    • TEventArgs

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • TEventArgs

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #disposed #eventHandlers

    Methods

    addHandler dispose invoke removeHandler -

    Constructors

    constructor

    • Type Parameters

      • TEventArgs

      Returns Event<TEventArgs>

    Properties

    Private #disposed

    #disposed: boolean = false

    Private Readonly #eventHandlers

    #eventHandlers: EventHandler<TEventArgs>[] = []

    Methods

    addHandler

    dispose

    invoke

    • Invokes the event

      +

    Constructors

    constructor

    • Type Parameters

      • TEventArgs

      Returns Event<TEventArgs>

    Properties

    Private #disposed

    #disposed: boolean = false

    Private Readonly #eventHandlers

    #eventHandlers: EventHandler<TEventArgs>[] = []

    Methods

    addHandler

    dispose

    invoke

    • Invokes the event

      Parameters

      • sender: any

        the object that is calling invoke

      • args: TEventArgs

        the arguments to send along with the event.

        -

      Returns void

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Events.SingleInvokeEvent.html b/docs/api/classes/Events.SingleInvokeEvent.html index 4626b91..a5acb0d 100644 --- a/docs/api/classes/Events.SingleInvokeEvent.html +++ b/docs/api/classes/Events.SingleInvokeEvent.html @@ -1,7 +1,7 @@ SingleInvokeEvent | @michaelcoxon/utilities

    Class SingleInvokeEvent<TEventArgs>

    An event type that can only be invoked once. Once the event is invoked, and handler that is added to it will be immediately executed. All subsequent invocations are ignored

    -

    Type Parameters

    • TEventArgs

    Hierarchy

    • Event<TEventArgs>
      • SingleInvokeEvent

    Implements

    Constructors

    constructor +

    Type Parameters

    • TEventArgs

    Hierarchy

    • Event<TEventArgs>
      • SingleInvokeEvent

    Implements

    Constructors

    constructor

    Properties

    #args? #disposed #eventHandlers @@ -12,12 +12,12 @@ invoke removeHandler

    Constructors

    constructor

    Properties

    Private Optional #args

    #args?: TEventArgs

    the firing args

    -

    Private #disposed

    #disposed: boolean = false

    Private Readonly #eventHandlers

    #eventHandlers: EventHandler<TEventArgs>[] = []

    Private #fired

    #fired: boolean

    event has been fired

    -

    Private Optional #sender

    #sender?: any

    the firing sender

    -

    Methods

    addHandler

    dispose

    invoke

    Properties

    Private Optional #args

    #args?: TEventArgs

    the firing args

    +

    Private #disposed

    #disposed: boolean = false

    Private Readonly #eventHandlers

    #eventHandlers: EventHandler<TEventArgs>[] = []

    Private #fired

    #fired: boolean

    event has been fired

    +

    Private Optional #sender

    #sender?: any

    the firing sender

    +

    Methods

    addHandler

    dispose

    invoke

    • Invokes the event

      Parameters

      • sender: any

        the object that is calling invoke

      • args: TEventArgs

        the arguments to send along with the event.

        -

      Returns void

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.AlreadyDisposedException.html b/docs/api/classes/Exceptions.AlreadyDisposedException.html index a20c2bd..261f59b 100644 --- a/docs/api/classes/Exceptions.AlreadyDisposedException.html +++ b/docs/api/classes/Exceptions.AlreadyDisposedException.html @@ -1,5 +1,5 @@ AlreadyDisposedException | @michaelcoxon/utilities

    Class AlreadyDisposedException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.ArgumentException.html b/docs/api/classes/Exceptions.ArgumentException.html index e68fec5..c10d630 100644 --- a/docs/api/classes/Exceptions.ArgumentException.html +++ b/docs/api/classes/Exceptions.ArgumentException.html @@ -1,5 +1,5 @@ ArgumentException | @michaelcoxon/utilities

    Class ArgumentException

    The exception that is thrown when one of the arguments provided to a method is not valid.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -16,8 +16,8 @@
  • Optional message: string

    the message

  • Optional innerException: Exception

    this is used to capture any exceptions that were called before this exception.

    -

    • Returns ArgumentException

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Returns ArgumentException

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.ArgumentNullException.html b/docs/api/classes/Exceptions.ArgumentNullException.html index 0a95418..73c16c0 100644 --- a/docs/api/classes/Exceptions.ArgumentNullException.html +++ b/docs/api/classes/Exceptions.ArgumentNullException.html @@ -1,5 +1,5 @@ ArgumentNullException | @michaelcoxon/utilities

    Class ArgumentNullException

    The exception that is thrown when one of the arguments provided to a method is not valid.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.ArgumentUndefinedException.html b/docs/api/classes/Exceptions.ArgumentUndefinedException.html index a84293a..a04bd99 100644 --- a/docs/api/classes/Exceptions.ArgumentUndefinedException.html +++ b/docs/api/classes/Exceptions.ArgumentUndefinedException.html @@ -1,5 +1,5 @@ ArgumentUndefinedException | @michaelcoxon/utilities

    Class ArgumentUndefinedException

    The exception that is thrown when one of the arguments provided to a method is not valid.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.ErrorException.html b/docs/api/classes/Exceptions.ErrorException.html index 47e8eb2..f0c04d4 100644 --- a/docs/api/classes/Exceptions.ErrorException.html +++ b/docs/api/classes/Exceptions.ErrorException.html @@ -1,5 +1,5 @@ ErrorException | @michaelcoxon/utilities

    Class ErrorException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.Exception.html b/docs/api/classes/Exceptions.Exception.html index 76f2c25..3f7a585 100644 --- a/docs/api/classes/Exceptions.Exception.html +++ b/docs/api/classes/Exceptions.Exception.html @@ -1,5 +1,5 @@ Exception | @michaelcoxon/utilities

    Class Exception

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -12,14 +12,14 @@

    Methods

    captureStackTrace isException

    Constructors

    constructor

    Returns Exception

  • Creates a new Exception with a message and an inner exception

    Parameters

    • message: undefined | string

      the message

    • innerException: Exception

      this is used to capture any exceptions that were called before this exception.

      -

    Returns Exception

    • Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Returns Exception

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.FileNotFoundException.html b/docs/api/classes/Exceptions.FileNotFoundException.html index 4bfccda..12cc7f3 100644 --- a/docs/api/classes/Exceptions.FileNotFoundException.html +++ b/docs/api/classes/Exceptions.FileNotFoundException.html @@ -1,5 +1,5 @@ FileNotFoundException | @michaelcoxon/utilities

    Class FileNotFoundException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.FormatException.html b/docs/api/classes/Exceptions.FormatException.html index 68e32b1..ea08adf 100644 --- a/docs/api/classes/Exceptions.FormatException.html +++ b/docs/api/classes/Exceptions.FormatException.html @@ -1,5 +1,5 @@ FormatException | @michaelcoxon/utilities

    Class FormatException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.IndexOutOfRangeException.html b/docs/api/classes/Exceptions.IndexOutOfRangeException.html index bf2bdbf..a5c9dd5 100644 --- a/docs/api/classes/Exceptions.IndexOutOfRangeException.html +++ b/docs/api/classes/Exceptions.IndexOutOfRangeException.html @@ -1,5 +1,5 @@ IndexOutOfRangeException | @michaelcoxon/utilities

    Class IndexOutOfRangeException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.InvalidOperationException.html b/docs/api/classes/Exceptions.InvalidOperationException.html index 4443120..7bd2500 100644 --- a/docs/api/classes/Exceptions.InvalidOperationException.html +++ b/docs/api/classes/Exceptions.InvalidOperationException.html @@ -1,5 +1,5 @@ InvalidOperationException | @michaelcoxon/utilities

    Class InvalidOperationException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.InvalidTypeException.html b/docs/api/classes/Exceptions.InvalidTypeException.html index d63e596..6609f5b 100644 --- a/docs/api/classes/Exceptions.InvalidTypeException.html +++ b/docs/api/classes/Exceptions.InvalidTypeException.html @@ -1,5 +1,5 @@ InvalidTypeException | @michaelcoxon/utilities

    Class InvalidTypeException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.KeyAlreadyDefinedException.html b/docs/api/classes/Exceptions.KeyAlreadyDefinedException.html index 61c7aea..087c716 100644 --- a/docs/api/classes/Exceptions.KeyAlreadyDefinedException.html +++ b/docs/api/classes/Exceptions.KeyAlreadyDefinedException.html @@ -1,5 +1,5 @@ KeyAlreadyDefinedException | @michaelcoxon/utilities

    Class KeyAlreadyDefinedException<TKey>

    Represents errors that occur during application execution.

    -

    Type Parameters

    • TKey

    Hierarchy

    Constructors

    constructor +

    Type Parameters

    • TKey

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.KeyNotFoundException.html b/docs/api/classes/Exceptions.KeyNotFoundException.html index 021a14a..0b9ca35 100644 --- a/docs/api/classes/Exceptions.KeyNotFoundException.html +++ b/docs/api/classes/Exceptions.KeyNotFoundException.html @@ -1,5 +1,5 @@ KeyNotFoundException | @michaelcoxon/utilities

    Class KeyNotFoundException<TKey>

    Represents errors that occur during application execution.

    -

    Type Parameters

    • TKey

    Hierarchy

    Constructors

    constructor +

    Type Parameters

    • TKey

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.MutexAlreadyAquiredException.html b/docs/api/classes/Exceptions.MutexAlreadyAquiredException.html index 59e646c..57e36dc 100644 --- a/docs/api/classes/Exceptions.MutexAlreadyAquiredException.html +++ b/docs/api/classes/Exceptions.MutexAlreadyAquiredException.html @@ -1,5 +1,5 @@ MutexAlreadyAquiredException | @michaelcoxon/utilities

    Class MutexAlreadyAquiredException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.NotImplementedException.html b/docs/api/classes/Exceptions.NotImplementedException.html index 992f8bf..37776ea 100644 --- a/docs/api/classes/Exceptions.NotImplementedException.html +++ b/docs/api/classes/Exceptions.NotImplementedException.html @@ -1,5 +1,5 @@ NotImplementedException | @michaelcoxon/utilities

    Class NotImplementedException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.NotSupportedException.html b/docs/api/classes/Exceptions.NotSupportedException.html index 755ac98..1527c46 100644 --- a/docs/api/classes/Exceptions.NotSupportedException.html +++ b/docs/api/classes/Exceptions.NotSupportedException.html @@ -1,5 +1,5 @@ NotSupportedException | @michaelcoxon/utilities

    Class NotSupportedException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.NullReferenceException.html b/docs/api/classes/Exceptions.NullReferenceException.html index ab36b02..a526139 100644 --- a/docs/api/classes/Exceptions.NullReferenceException.html +++ b/docs/api/classes/Exceptions.NullReferenceException.html @@ -1,5 +1,5 @@ NullReferenceException | @michaelcoxon/utilities

    Class NullReferenceException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Exceptions.OutOfBoundsException.html b/docs/api/classes/Exceptions.OutOfBoundsException.html index ab9cf5e..15938dd 100644 --- a/docs/api/classes/Exceptions.OutOfBoundsException.html +++ b/docs/api/classes/Exceptions.OutOfBoundsException.html @@ -1,5 +1,5 @@ OutOfBoundsException | @michaelcoxon/utilities

    Class OutOfBoundsException

    Represents errors that occur during application execution.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    #innerException? __proto__ cause? @@ -11,8 +11,8 @@

    Accessors

    innerException

    Methods

    captureStackTrace isException -

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Private Optional Readonly #innerException

    #innerException?: Exception

    __proto__

    __proto__: Error

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    innerException

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | Exception

    Methods

    Static captureStackTrace

    Static isException

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Formatters.DateFormatter.html b/docs/api/classes/Formatters.DateFormatter.html index fdcc23a..10f0a85 100644 --- a/docs/api/classes/Formatters.DateFormatter.html +++ b/docs/api/classes/Formatters.DateFormatter.html @@ -1,4 +1,4 @@ -DateFormatter | @michaelcoxon/utilities

    Class DateFormatter

    Hierarchy

    • DateFormatter

    Implements

    Constructors

    constructor +DateFormatter | @michaelcoxon/utilities

    Class DateFormatter

    Hierarchy

    • DateFormatter

    Implements

    Constructors

    constructor

    Properties

    #config

    Methods

    format -

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: IDateFormatterConfiguration

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: IDateFormatterConfiguration

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Formatters.NumberFormatter.html b/docs/api/classes/Formatters.NumberFormatter.html index 03e01a2..4a10399 100644 --- a/docs/api/classes/Formatters.NumberFormatter.html +++ b/docs/api/classes/Formatters.NumberFormatter.html @@ -1,6 +1,6 @@ NumberFormatter | @michaelcoxon/utilities

    Class NumberFormatter

    Formats numbers

    -

    Hierarchy

    • NumberFormatter

    Implements

    Constructors

    constructor +

    Hierarchy

    • NumberFormatter

    Implements

    Constructors

    constructor

    Properties

    #delegates

    Methods

    #getFormatter format -

    Constructors

    constructor

    Properties

    Private Readonly #delegates

    #delegates: NumberFormatterDelegates

    Methods

    Private Readonly #getFormatter

    • #getFormatter(specifier): ((subject, precision?) => string)

    • Parameters

      • specifier: string

      Returns ((subject, precision?) => string)

        • (subject, precision?): string

        • Parameters

          • subject: number
          • Optional precision: number

          Returns string

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #delegates

    #delegates: NumberFormatterDelegates

    Methods

    Private Readonly #getFormatter

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Formatters.NumberFormatterDelegates.html b/docs/api/classes/Formatters.NumberFormatterDelegates.html index 45fd219..3f6161e 100644 --- a/docs/api/classes/Formatters.NumberFormatterDelegates.html +++ b/docs/api/classes/Formatters.NumberFormatterDelegates.html @@ -1,4 +1,4 @@ -NumberFormatterDelegates | @michaelcoxon/utilities

    Class NumberFormatterDelegates

    Hierarchy

    • NumberFormatterDelegates

    Constructors

    constructor +NumberFormatterDelegates | @michaelcoxon/utilities

    Class NumberFormatterDelegates

    Hierarchy

    • NumberFormatterDelegates

    Constructors

    constructor

    Properties

    #config

    Methods

    formatCurrency formatExponential @@ -8,4 +8,4 @@ formatInteger formatNumber formatPercent -

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: INumberFormatterConfiguration

    Methods

    formatCurrency

    formatExponential

    formatFixed

    formatGeneral

    formatHexadecimal

    formatInteger

    formatNumber

    formatPercent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: INumberFormatterConfiguration

    Methods

    formatCurrency

    formatExponential

    formatFixed

    formatGeneral

    formatHexadecimal

    formatInteger

    formatNumber

    formatPercent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Formatters.StringFormatter.html b/docs/api/classes/Formatters.StringFormatter.html index 7ef41da..b2edef4 100644 --- a/docs/api/classes/Formatters.StringFormatter.html +++ b/docs/api/classes/Formatters.StringFormatter.html @@ -1,4 +1,4 @@ StringFormatter | @michaelcoxon/utilities

    Class StringFormatter

    Formats strings

    -

    Hierarchy

    • StringFormatter

    Implements

    Constructors

    constructor +

    Hierarchy

    • StringFormatter

    Implements

    Constructors

    constructor

    Methods

    format -

    Constructors

    constructor

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Guid.html b/docs/api/classes/Guid.html index 8360d88..76e28d1 100644 --- a/docs/api/classes/Guid.html +++ b/docs/api/classes/Guid.html @@ -1,5 +1,5 @@ Guid | @michaelcoxon/utilities

    Class Guid

    Represents a GUID

    -

    Hierarchy

    • Guid

    Constructors

    constructor +

    Hierarchy

    • Guid

    Constructors

    constructor

    Properties

    #a #b #c @@ -17,9 +17,9 @@ newGuid parseString

    Constructors

    constructor

    Properties

    Private Readonly #a

    #a: UnsignedInt32

    Private Readonly #b

    #b: UnsignedInt16

    Private Readonly #c

    #c: UnsignedInt16

    Private Readonly #d

    #d: Byte

    Private Readonly #e

    #e: Byte

    Private Readonly #f

    #f: Byte

    Private Readonly #g

    #g: Byte

    Private Readonly #h

    #h: Byte

    Private Readonly #i

    #i: Byte

    Private Readonly #j

    #j: Byte

    Private Readonly #k

    #k: Byte

    Static Readonly empty

    empty: Guid = ...

    An empty Guid (all zero's)

    -

    Methods

    toString

    • Returns the Guid as a hypen-separated string without curly braces.

      -

      Returns string

    valueOf

    • Returns the Guid as a hypen-separated string without curly braces.

      -

      Returns string

    Static newGuid

    • Creates a new v4 GUID (its random except for the version nibble)

      -

      Returns Guid

    Static parseString

    • converts astring representaion of a Guid into a Guid object.

      -

      Parameters

      • str: string

      Returns Guid

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Guid

    Properties

    Private Readonly #a

    #a: UnsignedInt32

    Private Readonly #b

    #b: UnsignedInt16

    Private Readonly #c

    #c: UnsignedInt16

    Private Readonly #d

    #d: Byte

    Private Readonly #e

    #e: Byte

    Private Readonly #f

    #f: Byte

    Private Readonly #g

    #g: Byte

    Private Readonly #h

    #h: Byte

    Private Readonly #i

    #i: Byte

    Private Readonly #j

    #j: Byte

    Private Readonly #k

    #k: Byte

    Static Readonly empty

    empty: Guid = ...

    An empty Guid (all zero's)

    +

    Methods

    toString

    valueOf

    Static newGuid

    Static parseString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/IO.IndentedStringBuilder.html b/docs/api/classes/IO.IndentedStringBuilder.html index 66b8184..21f23ca 100644 --- a/docs/api/classes/IO.IndentedStringBuilder.html +++ b/docs/api/classes/IO.IndentedStringBuilder.html @@ -1,5 +1,5 @@ IndentedStringBuilder | @michaelcoxon/utilities

    Class IndentedStringBuilder

    Class for building strings that will only concatenate them upon calling toString().

    -

    Hierarchy

    • IndentedStringBuilder

    Implements

    Constructors

    constructor +

    Hierarchy

    • IndentedStringBuilder

    Implements

    Constructors

    constructor

    Properties

    #indentationLevel #invalidateLastValue #lastValue @@ -11,9 +11,9 @@ toString unindent

    Constructors

    constructor

    Properties

    Private #indentationLevel

    #indentationLevel: number

    Private #invalidateLastValue

    #invalidateLastValue: boolean

    Private #lastValue

    #lastValue: Undefinable<string>

    Private Readonly #strings

    #strings: {
        indent: number;
        value: string;
    }[]

    Type declaration

    • indent: number
    • value: string

    indentationString

    indentationString: string = "\t"

    Methods

    appendLine

    clear

    indent

    toString

    unindent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns IndentedStringBuilder

    Properties

    Private #indentationLevel

    #indentationLevel: number

    Private #invalidateLastValue

    #invalidateLastValue: boolean

    Private #lastValue

    #lastValue: Undefinable<string>

    Private Readonly #strings

    #strings: {
        indent: number;
        value: string;
    }[]

    Type declaration

    • indent: number
    • value: string

    indentationString

    indentationString: string = "\t"

    Methods

    appendLine

    clear

    indent

    toString

    unindent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/IO.StringBuilder.html b/docs/api/classes/IO.StringBuilder.html index 44dc536..655fe98 100644 --- a/docs/api/classes/IO.StringBuilder.html +++ b/docs/api/classes/IO.StringBuilder.html @@ -1,5 +1,5 @@ StringBuilder | @michaelcoxon/utilities

    Class StringBuilder

    Class for building strings that will only concatenate them upon calling toString().

    -

    Hierarchy

    • StringBuilder

    Implements

    Constructors

    constructor +

    Hierarchy

    • StringBuilder

    Implements

    Constructors

    constructor

    Properties

    #invalidateLastValue #lastValue #strings @@ -8,8 +8,8 @@ clear toString

    Constructors

    constructor

    Properties

    Private #invalidateLastValue

    #invalidateLastValue: boolean

    Private #lastValue

    #lastValue: Undefinable<string>

    Private Readonly #strings

    #strings: string[]

    Methods

    append

    appendLine

    clear

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns StringBuilder

    Properties

    Private #invalidateLastValue

    #invalidateLastValue: boolean

    Private #lastValue

    #lastValue: Undefinable<string>

    Private Readonly #strings

    #strings: string[]

    Methods

    append

    appendLine

    clear

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Lazy.html b/docs/api/classes/Lazy.html index 67aa8eb..06ad00e 100644 --- a/docs/api/classes/Lazy.html +++ b/docs/api/classes/Lazy.html @@ -1,5 +1,5 @@ Lazy | @michaelcoxon/utilities

    Class Lazy<T>

    Lazy wrapper for a factory.

    -

    Type Parameters

    • T

    Hierarchy

    • Lazy

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    • Lazy

    Constructors

    constructor

    Properties

    #factory #value #valueCreated @@ -11,6 +11,6 @@

    By default, if the factory returns undefined, the value of isValueCreated will not be true. To alter this set waitForValue to false.

    -

    Type Parameters

    • T

    Parameters

    • factory: (() => T)
        • (): T

        • Returns T

    • waitForValue: boolean = true

    Returns Lazy<T>

    Properties

    Private Readonly #factory

    #factory: (() => T)

    Type declaration

      • (): T

      • Returns T

    Private #value

    #value: Undefinable<T>

    Private #valueCreated

    #valueCreated: boolean = false

    Private #waitForValue

    #waitForValue: boolean

    Accessors

    isValueCreated

    • get isValueCreated(): boolean

    • Returns true if the value has been created.

      -

      Returns boolean

    value

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Lazy<T>

    Properties

    Private Readonly #factory

    #factory: (() => T)

    Type declaration

      • (): T

      • Returns T

    Private #value

    #value: Undefinable<T>

    Private #valueCreated

    #valueCreated: boolean = false

    Private #waitForValue

    #waitForValue: boolean

    Accessors

    isValueCreated

    value

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Logging.AggregateLogger.html b/docs/api/classes/Logging.AggregateLogger.html index 6970408..0209854 100644 --- a/docs/api/classes/Logging.AggregateLogger.html +++ b/docs/api/classes/Logging.AggregateLogger.html @@ -1,5 +1,5 @@ AggregateLogger | @michaelcoxon/utilities

    Class AggregateLogger

    ILogger interface for all logging implementations

    -

    Hierarchy

    • AggregateLogger

    Implements

    Constructors

    constructor +

    Hierarchy

    • AggregateLogger

    Implements

    Constructors

    constructor

    Properties

    #loggers

    Methods

    debug debugError @@ -12,23 +12,23 @@ traceError warn warnError -

    Constructors

    constructor

    Properties

    Private Readonly #loggers

    #loggers: ILogger[]

    Methods

    debug

    debugError

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      +

    Constructors

    constructor

    Properties

    Private Readonly #loggers

    #loggers: ILogger[]

    Methods

    debug

    debugError

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      Parameters

      • name: string

        The tag the logger should be given

      Returns ILogger & IDisposable

      Example

      Use the scope tool inside a 'using' to scope logging to a specific method.
      return using(() => logger.scope("theNameOfMyScope"), logger =>
       {
           logger.debug("Log something here");
       });
      -

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Logging.ConsoleLogger.html b/docs/api/classes/Logging.ConsoleLogger.html index 9106dee..767c8d7 100644 --- a/docs/api/classes/Logging.ConsoleLogger.html +++ b/docs/api/classes/Logging.ConsoleLogger.html @@ -1,5 +1,5 @@ ConsoleLogger | @michaelcoxon/utilities

    Class ConsoleLogger

    ILogger interface for all logging implementations

    -

    Hierarchy

    Implements

    Constructors

    constructor +

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #config #consoleLoggerConfig

    Methods

    _debugMethod @@ -19,23 +19,23 @@ traceError warn warnError -

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: ILoggerConfig

    Private Readonly #consoleLoggerConfig

    #consoleLoggerConfig: IConsoleLoggerConfig

    Methods

    Protected _debugMethod

    Protected _defaultMethod

    Protected _errorMethod

    Protected _infoMethod

    Protected _traceMethod

    Protected _warnMethod

    debug

    debugError

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      +

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: ILoggerConfig

    Private Readonly #consoleLoggerConfig

    #consoleLoggerConfig: IConsoleLoggerConfig

    Methods

    Protected _debugMethod

    Protected _defaultMethod

    Protected _errorMethod

    Protected _infoMethod

    Protected _traceMethod

    Protected _warnMethod

    debug

    debugError

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      Parameters

      • name: string

        The tag the logger should be given

      Returns ILogger & IDisposable

      Example

      Use the scope tool inside a 'using' to scope logging to a specific method.
      return using(() => logger.scope("theNameOfMyScope"), logger =>
       {
           logger.debug("Log something here");
       });
      -

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Logging.Logger.html b/docs/api/classes/Logging.Logger.html index bb8d091..439ffc0 100644 --- a/docs/api/classes/Logging.Logger.html +++ b/docs/api/classes/Logging.Logger.html @@ -1,5 +1,5 @@ Logger | @michaelcoxon/utilities

    Class LoggerAbstract

    ILogger interface for all logging implementations

    -

    Hierarchy

    Implements

    Constructors

    constructor +

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #config

    Methods

    _debugMethod _defaultMethod @@ -19,23 +19,23 @@ traceError warn warnError -

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: ILoggerConfig

    Methods

    Protected Abstract _debugMethod

    Protected Abstract _defaultMethod

    Protected Abstract _errorMethod

    Protected Abstract _infoMethod

    Protected Abstract _traceMethod

    Protected Abstract _warnMethod

    debug

    debugError

    error

    errorError

    info

    infoError

    Private log

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      +

    Constructors

    constructor

    Properties

    Private Readonly #config

    #config: ILoggerConfig

    Methods

    Protected Abstract _debugMethod

    Protected Abstract _defaultMethod

    Protected Abstract _errorMethod

    Protected Abstract _infoMethod

    Protected Abstract _traceMethod

    Protected Abstract _warnMethod

    debug

    debugError

    error

    errorError

    info

    infoError

    Private log

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      Parameters

      • name: string

        The tag the logger should be given

      Returns ILogger & IDisposable

      Example

      Use the scope tool inside a 'using' to scope logging to a specific method.
      return using(() => logger.scope("theNameOfMyScope"), logger =>
       {
           logger.debug("Log something here");
       });
      -

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Logging.ScopedLogger.html b/docs/api/classes/Logging.ScopedLogger.html index 02831b9..6a8da22 100644 --- a/docs/api/classes/Logging.ScopedLogger.html +++ b/docs/api/classes/Logging.ScopedLogger.html @@ -1,5 +1,5 @@ ScopedLogger | @michaelcoxon/utilities

    Class ScopedLogger

    ILogger interface for all logging implementations

    -

    Hierarchy

    • ScopedLogger

    Implements

    Constructors

    constructor +

    Hierarchy

    • ScopedLogger

    Implements

    Constructors

    constructor

    Properties

    #disposed #logger #name @@ -17,23 +17,23 @@ traceError warn warnError -

    Constructors

    constructor

    Properties

    Private #disposed

    #disposed: boolean = false

    Private Readonly #logger

    #logger: ILogger

    Private Readonly #name

    #name: string

    Methods

    Private #ensureNotDisposed

    Private #prepareMessage

    debug

    debugError

    dispose

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      +

    Constructors

    constructor

    Properties

    Private #disposed

    #disposed: boolean = false

    Private Readonly #logger

    #logger: ILogger

    Private Readonly #name

    #name: string

    Methods

    Private #ensureNotDisposed

    Private #prepareMessage

    debug

    debugError

    dispose

    error

    errorError

    info

    infoError

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      Parameters

      • name: string

        The tag the logger should be given

      Returns ILogger & IDisposable

      Example

      Use the scope tool inside a 'using' to scope logging to a specific method.
      return using(() => logger.scope("theNameOfMyScope"), logger =>
       {
           logger.debug("Log something here");
       });
      -

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/ModelState.BaseModelState.html b/docs/api/classes/ModelState.BaseModelState.html index 3158c7c..ad24a35 100644 --- a/docs/api/classes/ModelState.BaseModelState.html +++ b/docs/api/classes/ModelState.BaseModelState.html @@ -1,4 +1,4 @@ -BaseModelState | @michaelcoxon/utilities

    Class BaseModelState<T>Abstract

    Type Parameters

    • T extends any

    Hierarchy

    Implements

    • IModelState<T>

    Constructors

    constructor +BaseModelState | @michaelcoxon/utilities

    Class BaseModelState<T>Abstract

    Type Parameters

    • T extends any

    Hierarchy

    Implements

    • IModelState<T>

    Constructors

    constructor

    Properties

    #postHandlers #preHandlers #updatedEvent @@ -15,14 +15,14 @@ toString unsubscribe valueOf -

    Constructors

    constructor

    Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when +

    Constructors

    constructor

    Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when the state is updated.

      Parameters

      • postCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • Optional preCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      Returns string

      A symbol that must saved to unsubscribe from the ModelState

      -

    Protected subscribeCore

    • Parameters

      • postCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • Optional preCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • publishCurrentValue: boolean = true

      Returns string

    toPromise

    toString

    unsubscribe

    Protected subscribeCore

    • Parameters

      • postCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • Optional preCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • publishCurrentValue: boolean = true

      Returns string

    toPromise

    toString

    unsubscribe

    • Unsubscribes a component from the model state.

      Parameters

      • key: string

        The symbol that was returned from the subscribe method.

        -

      Returns void

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/ModelState.FactoryModelState.html b/docs/api/classes/ModelState.FactoryModelState.html index 7511d08..aff56f7 100644 --- a/docs/api/classes/ModelState.FactoryModelState.html +++ b/docs/api/classes/ModelState.FactoryModelState.html @@ -1,4 +1,4 @@ -FactoryModelState | @michaelcoxon/utilities

    Class FactoryModelState<T>

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor +FactoryModelState | @michaelcoxon/utilities

    Class FactoryModelState<T>

    Type Parameters

    • T

    Hierarchy

    Constructors

    constructor

    Properties

    #currentPromise? #postHandlers #preHandlers @@ -21,18 +21,18 @@ valueOf

    Constructors

    constructor

    Returns FactoryModelState<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseFactory: (() => Promise<T>)

      can be a promise factory

      -
        • (): Promise<T>

        • Returns Promise<T>

    • Optional updateNow: boolean

    Returns FactoryModelState<T>

  • Creates a new PollingModelState

    +
      • (): Promise<T>

      • Returns Promise<T>

  • Optional updateNow: boolean

    • Returns FactoryModelState<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseOrValueFactory: (() => Awaitable<T>)

      can be a promise or a value factory, a value or a promise that will be invoked immediately

      -
    • Optional updateNow: boolean

    Returns FactoryModelState<T>

    • Properties

    Private Optional #currentPromise

    #currentPromise?: CancellablePromise<void>

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updater

    #updater: (() => Promise<void>)

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Private Readonly #waitForPromise

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when +

    • Optional updateNow: boolean

    Returns FactoryModelState<T>

    Properties

    Private Optional #currentPromise

    #currentPromise?: CancellablePromise<void>

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updater

    #updater: (() => Promise<void>)

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Private Readonly #waitForPromise

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when the state is updated.

      Parameters

      • postCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • Optional preCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      Returns string

      A symbol that must saved to unsubscribe from the ModelState

      -

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    update

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    update

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/ModelState.ModelState.html b/docs/api/classes/ModelState.ModelState.html index 16d87e5..2779d98 100644 --- a/docs/api/classes/ModelState.ModelState.html +++ b/docs/api/classes/ModelState.ModelState.html @@ -1,5 +1,5 @@ ModelState | @michaelcoxon/utilities

    Class ModelState<T>

    Provides a mutatable state that can update registered components to the state

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    • IModelState<T>

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    • IModelState<T>

    Constructors

    constructor

    Properties

    #postHandlers #preHandlers #updatedEvent @@ -17,17 +17,17 @@ unsubscribe valueOf

    Constructors

    constructor

    Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when +

    Returns ModelState<T>

    Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when the state is updated.

      Parameters

      • postCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      • Optional preCallback: ((value) => void)
          • (value): void

          • Parameters

            Returns void

      Returns string

      A symbol that must saved to unsubscribe from the ModelState

      -

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/ModelState.PollingModelState.html b/docs/api/classes/ModelState.PollingModelState.html index c55fbf7..8620f86 100644 --- a/docs/api/classes/ModelState.PollingModelState.html +++ b/docs/api/classes/ModelState.PollingModelState.html @@ -1,5 +1,5 @@ PollingModelState | @michaelcoxon/utilities

    Class PollingModelState<T>

    interface for disposable objects

    -

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #postHandlers #preHandlers #timeout? @@ -20,18 +20,18 @@ valueOf

    Constructors

    constructor

    Returns PollingModelState<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseFactory: (() => Promise<T>)

      can be a promise factory

      -
        • (): Promise<T>

        • Returns Promise<T>

    • timeout: number

    Returns PollingModelState<T>

  • Creates a new PollingModelState

    +
      • (): Promise<T>

      • Returns Promise<T>

  • timeout: number

    • Returns PollingModelState<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseOrValueFactory: (() => Awaitable<T>)

      can be a promise or a value factory, a value or a promise that will be invoked immediately

      -
    • timeout: number

    Returns PollingModelState<T>

    • Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Optional #timeout

    #timeout?: any

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    dispose

    Protected getValue

    Protected setValue

    subscribe

    • Creates a subscription to the ModelState that will be called when +

    • timeout: number

    Returns PollingModelState<T>

    Properties

    Private Readonly #postHandlers

    #postHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Readonly #preHandlers

    #preHandlers: Record<string, EventHandler<Undefinable<T>>>

    Private Optional #timeout

    #timeout?: any

    Private Readonly #updatedEvent

    #updatedEvent: Event<Undefinable<T>>

    Private Readonly #updatingEvent

    #updatingEvent: Event<Undefinable<T>>

    Private #value

    #value: Undefinable<T>

    Accessors

    value

    Methods

    Private Readonly #onUpdated

    Private Readonly #onUpdating

    dispose

    Protected getValue

    Protected setValue

    subscribe

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    Protected subscribeCore

    toPromise

    toString

    unsubscribe

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.Byte.html b/docs/api/classes/Numbers.Byte.html index fd6cb8b..dbda90c 100644 --- a/docs/api/classes/Numbers.Byte.html +++ b/docs/api/classes/Numbers.Byte.html @@ -1,5 +1,5 @@ Byte | @michaelcoxon/utilities

    Class Byte

    Represents an unsigned 8-bit integer.

    -

    Hierarchy

    • Number
      • Byte

    Implements

    Constructors

    constructor +

    Hierarchy

    • Number
      • Byte

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -26,7 +26,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -44,8 +44,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 255

    The largest number that can be represented. Equal to 255.

    -

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    -

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      +

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -57,7 +57,7 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    toString

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.Int16.html b/docs/api/classes/Numbers.Int16.html index a140c97..d214915 100644 --- a/docs/api/classes/Numbers.Int16.html +++ b/docs/api/classes/Numbers.Int16.html @@ -1,4 +1,4 @@ -Int16 | @michaelcoxon/utilities

    Class Int16

    Hierarchy

    • Number
      • Int16

    Implements

    Constructors

    constructor +Int16 | @michaelcoxon/utilities

    Class Int16

    Hierarchy

    • Number
      • Int16

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -25,7 +25,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -43,8 +43,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 32767

    The largest number that can be represented. Equal to 32767.

    -

    Static Readonly minValue

    minValue: number = -32768

    The lowest number that can be represented. Equal to -32768.

    -

    Methods

    [toPrimitive]

    toExponential

    Static Readonly minValue

    minValue: number = -32768

    The lowest number that can be represented. Equal to -32768.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -56,7 +56,7 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    toString

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.Int32.html b/docs/api/classes/Numbers.Int32.html index f65ebc4..de1ed1a 100644 --- a/docs/api/classes/Numbers.Int32.html +++ b/docs/api/classes/Numbers.Int32.html @@ -1,4 +1,4 @@ -Int32 | @michaelcoxon/utilities

    Class Int32

    Hierarchy

    • Number
      • Int32

    Implements

    Constructors

    constructor +Int32 | @michaelcoxon/utilities

    Class Int32

    Hierarchy

    • Number
      • Int32

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -25,7 +25,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -43,8 +43,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 2147483647

    The largest number that can be represented. Equal to 2,147,483,647.

    -

    Static Readonly minValue

    minValue: number = -2147483648

    The lowest number that can be represented. Equal to -2,147,483,648.

    -

    Methods

    [toPrimitive]

    toExponential

    Static Readonly minValue

    minValue: number = -2147483648

    The lowest number that can be represented. Equal to -2,147,483,648.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -58,7 +58,7 @@

        Parameters

        • Optional precision: number

          Number of significant digits. Must be in the range 1 - 21, inclusive.

        Returns string

    toString

    • Returns a string representation of an object.

      Parameters

      • Optional radix: number

        Specifies a radix for converting numeric values to strings. This value is only used for numbers.

        -

      Returns string

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.SignedByte.html b/docs/api/classes/Numbers.SignedByte.html index ad7f6a2..758427c 100644 --- a/docs/api/classes/Numbers.SignedByte.html +++ b/docs/api/classes/Numbers.SignedByte.html @@ -1,4 +1,4 @@ -SignedByte | @michaelcoxon/utilities

    Class SignedByte

    Hierarchy

    • Number
      • SignedByte

    Implements

    Constructors

    constructor +SignedByte | @michaelcoxon/utilities

    Class SignedByte

    Hierarchy

    • Number
      • SignedByte

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -25,7 +25,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -43,8 +43,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 127

    The largest number that can be represented. Equal to 127.

    -

    Static Readonly minValue

    minValue: number = -127

    The lowest number that can be represented. Equal to -127.

    -

    Methods

    [toPrimitive]

    toExponential

    Static Readonly minValue

    minValue: number = -127

    The lowest number that can be represented. Equal to -127.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -56,7 +56,7 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    toString

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.UnsignedInt16.html b/docs/api/classes/Numbers.UnsignedInt16.html index 6a4e27b..add8cab 100644 --- a/docs/api/classes/Numbers.UnsignedInt16.html +++ b/docs/api/classes/Numbers.UnsignedInt16.html @@ -1,4 +1,4 @@ -UnsignedInt16 | @michaelcoxon/utilities

    Class UnsignedInt16

    Hierarchy

    • Number
      • UnsignedInt16

    Implements

    Constructors

    constructor +UnsignedInt16 | @michaelcoxon/utilities

    Class UnsignedInt16

    Hierarchy

    • Number
      • UnsignedInt16

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -25,7 +25,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -43,8 +43,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 65535

    The largest number that can be represented. Equal to 65,535.

    -

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    -

    Methods

    [toPrimitive]

    toExponential

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -56,7 +56,7 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    toString

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Numbers.UnsignedInt32.html b/docs/api/classes/Numbers.UnsignedInt32.html index 6fef5c7..bd87279 100644 --- a/docs/api/classes/Numbers.UnsignedInt32.html +++ b/docs/api/classes/Numbers.UnsignedInt32.html @@ -1,4 +1,4 @@ -UnsignedInt32 | @michaelcoxon/utilities

    Class UnsignedInt32

    Hierarchy

    • Number
      • UnsignedInt32

    Implements

    Constructors

    constructor +UnsignedInt32 | @michaelcoxon/utilities

    Class UnsignedInt32

    Hierarchy

    • Number
      • UnsignedInt32

    Implements

    Constructors

    constructor

    Properties

    #value EPSILON MAX_SAFE_INTEGER @@ -25,7 +25,7 @@ parseFloat parseInt tryParse -

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 +

    Constructors

    constructor

    Properties

    Private Readonly #value

    #value: number

    Static Readonly EPSILON

    EPSILON: number

    The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

    Static Readonly MAX_SAFE_INTEGER

    MAX_SAFE_INTEGER: number

    The value of the largest integer n such that n and n + 1 are both exactly representable as @@ -43,8 +43,8 @@

    Static Readonly POSITIVE_INFINITY

    POSITIVE_INFINITY: number

    A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

    Static Readonly maxValue

    maxValue: number = 4294967295

    The largest number that can be represented. Equal to 4,294,967,295.

    -

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    -

    Methods

    [toPrimitive]

    toExponential

    Static Readonly minValue

    minValue: number = 0

    The lowest number that can be represented. Equal to 0.

    +

    Methods

    [toPrimitive]

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -56,7 +56,7 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Static isFinite

    • Returns true if passed value is finite. +

    Returns string

    toString

    valueOf

    Static isFinite

    Static isSafeInteger

    Static parse

    Static parseFloat

    Returns boolean

    Static parse

    Static parseFloat

    Static parseInt

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Static tryParse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Pipeline.Pipeline.html b/docs/api/classes/Pipeline.Pipeline.html index eb8200e..cc8264a 100644 --- a/docs/api/classes/Pipeline.Pipeline.html +++ b/docs/api/classes/Pipeline.Pipeline.html @@ -1,7 +1,7 @@ -Pipeline | @michaelcoxon/utilities

    Class Pipeline

    Hierarchy

    • Pipeline

    Implements

    Constructors

    constructor +Pipeline | @michaelcoxon/utilities

    Class Pipeline

    Hierarchy

    • Pipeline

    Implements

    Constructors

    constructor

    Properties

    #logger #queue

    Methods

    executeAsync start then -

    Constructors

    constructor

    Properties

    Private Readonly #logger

    #logger: ILogger

    Private Readonly #queue

    #queue: IPipelineTask[]

    Methods

    executeAsync

    start

    then

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #logger

    #logger: ILogger

    Private Readonly #queue

    #queue: IPipelineTask[]

    Methods

    executeAsync

    start

    then

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Promises.AsyncWrapper.html b/docs/api/classes/Promises.AsyncWrapper.html index c642c03..c76e78e 100644 --- a/docs/api/classes/Promises.AsyncWrapper.html +++ b/docs/api/classes/Promises.AsyncWrapper.html @@ -1,7 +1,7 @@ AsyncWrapper | @michaelcoxon/utilities

    Class AsyncWrapper<T>

    The AsyncWrapper is provided to monitor the state of a promise. You can use this to provide state feedback to the user of an awaitable method.

    -

    Type Parameters

    • T

    Hierarchy

    • AsyncWrapper

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    • AsyncWrapper

    Constructors

    constructor

    Properties

    #awaitable #callback #complete @@ -20,23 +20,23 @@

    Methods

    cancel update

    Constructors

    constructor

    Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    Type Parameters

    • T

    Parameters

    • promiseOrValue: Awaitable<T>

      can be a promise or a value

    • callback: ((asyncWrapper) => void)

      the callback that should be applied after the promise is resolved

      -
        • (asyncWrapper): void

        • Parameters

          Returns void

    Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    +
      • (asyncWrapper): void

      • Parameters

        Returns void

    • Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    Type Parameters

    • T

    Parameters

    • promiseFactory: (() => Awaitable<T>)

      can be a promise or a value factory that will be invoked immediately

      -

    Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    +

    • Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    Type Parameters

    Parameters

    Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    +

    • Returns AsyncWrapper<T>

  • Creates a new AsyncWrapper

    Type Parameters

    Parameters

    Returns AsyncWrapper<T>

    • Properties

    Private #awaitable

    #awaitable: Promise<any>

    Private Readonly #callback

    #callback: undefined | ((asyncWrapper) => void)

    Type declaration

      • (asyncWrapper): void

      • Parameters

        Returns void

    Private #complete

    #complete: boolean

    Private Readonly #completeEvent

    #completeEvent: SingleInvokeEvent<Undefinable<T>>

    Private #error

    #error: any

    Private Optional #promise

    #promise?: Promise<T>

    Private #promiseOrValueOrFactory

    #promiseOrValueOrFactory: undefined | Awaitable<T> | (() => Awaitable<T>)

    Type declaration

    Private #success

    #success: boolean

    Private #value

    #value: Undefinable<T>

    Accessors

    complete

    completeEvent

    error

    promise

    success

    value

    Methods

    cancel

    update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns AsyncWrapper<T>

    Properties

    Private #awaitable

    #awaitable: Promise<any>

    Private Readonly #callback

    #callback: undefined | ((asyncWrapper) => void)

    Type declaration

      • (asyncWrapper): void

      • Parameters

        Returns void

    Private #complete

    #complete: boolean

    Private Readonly #completeEvent

    #completeEvent: SingleInvokeEvent<Undefinable<T>>

    Private #error

    #error: any

    Private Optional #promise

    #promise?: Promise<T>

    Private #promiseOrValueOrFactory

    #promiseOrValueOrFactory: undefined | Awaitable<T> | (() => Awaitable<T>)

    Type declaration

    Private #success

    #success: boolean

    Private #value

    #value: Undefinable<T>

    Accessors

    complete

    completeEvent

    error

    promise

    success

    value

    Methods

    cancel

    update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Promises.CancellablePromise.html b/docs/api/classes/Promises.CancellablePromise.html index e31f93a..ba79237 100644 --- a/docs/api/classes/Promises.CancellablePromise.html +++ b/docs/api/classes/Promises.CancellablePromise.html @@ -1,4 +1,4 @@ -CancellablePromise | @michaelcoxon/utilities

    Class CancellablePromise<T>

    Type Parameters

    • T

    Hierarchy

    • CancellablePromise

    Implements

    • PromiseLike<T>

    Constructors

    constructor +CancellablePromise | @michaelcoxon/utilities

    Class CancellablePromise<T>

    Type Parameters

    • T

    Hierarchy

    • CancellablePromise

    Implements

    • PromiseLike<T>

    Constructors

    constructor

    Properties

    #cancellationTokenSource #finallyEvent #watcherPromise @@ -7,4 +7,4 @@ catch finally then -

    Constructors

    constructor

    Properties

    Private #cancellationTokenSource

    #cancellationTokenSource: CancellationTokenSource

    Private Readonly #finallyEvent

    #finallyEvent: SingleInvokeEvent<{
        cancelled: boolean;
        promise: PromiseLike<T>;
    }> = ...

    Type declaration

    • cancelled: boolean
    • promise: PromiseLike<T>

    Private #watcherPromise

    #watcherPromise: Promise<T>

    Accessors

    cancelled

    Methods

    cancel

    catch

    finally

    then

    • Type Parameters

      • TResult1 = T

      • TResult2 = never

      Parameters

      • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
      • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      Returns CancellablePromise<TResult1 | TResult2>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #cancellationTokenSource

    #cancellationTokenSource: CancellationTokenSource

    Private Readonly #finallyEvent

    #finallyEvent: SingleInvokeEvent<{
        cancelled: boolean;
        promise: PromiseLike<T>;
    }> = ...

    Type declaration

    • cancelled: boolean
    • promise: PromiseLike<T>

    Private #watcherPromise

    #watcherPromise: Promise<T>

    Accessors

    cancelled

    Methods

    cancel

    catch

    finally

    then

    • Type Parameters

      • TResult1 = T

      • TResult2 = never

      Parameters

      • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
      • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      Returns CancellablePromise<TResult1 | TResult2>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Promises.CancellationToken.html b/docs/api/classes/Promises.CancellationToken.html index 107ce5f..e74482d 100644 --- a/docs/api/classes/Promises.CancellationToken.html +++ b/docs/api/classes/Promises.CancellationToken.html @@ -1,7 +1,7 @@ -CancellationToken | @michaelcoxon/utilities

    Class CancellationToken

    Hierarchy

    • CancellationToken

    Constructors

    constructor +CancellationToken | @michaelcoxon/utilities

    Class CancellationToken

    Hierarchy

    • CancellationToken

    Constructors

    constructor

    Properties

    #cancelled #onCancelled default

    Accessors

    isCancellationRequested onCancelled -

    Constructors

    constructor

    Properties

    Private #cancelled

    #cancelled: boolean = false

    Private Readonly #onCancelled

    #onCancelled: SingleInvokeEvent<undefined> = ...

    Static default

    default: CancellationToken = ...

    Accessors

    isCancellationRequested

    onCancelled

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #cancelled

    #cancelled: boolean = false

    Private Readonly #onCancelled

    #onCancelled: SingleInvokeEvent<undefined> = ...

    Static default

    default: CancellationToken = ...

    Accessors

    isCancellationRequested

    onCancelled

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Promises.CancellationTokenSource.html b/docs/api/classes/Promises.CancellationTokenSource.html index 734e9bf..c109b61 100644 --- a/docs/api/classes/Promises.CancellationTokenSource.html +++ b/docs/api/classes/Promises.CancellationTokenSource.html @@ -1,4 +1,4 @@ -CancellationTokenSource | @michaelcoxon/utilities

    Class CancellationTokenSource

    Hierarchy

    • CancellationTokenSource

    Constructors

    constructor +CancellationTokenSource | @michaelcoxon/utilities

    Class CancellationTokenSource

    Hierarchy

    • CancellationTokenSource

    Constructors

    constructor

    Properties

    #cancelled #cancelledEvent #timeoutables @@ -6,4 +6,4 @@ token

    Methods

    cancel cancelAfter -

    Constructors

    constructor

    Properties

    Private #cancelled

    #cancelled: boolean = false

    Private Readonly #cancelledEvent

    #cancelledEvent: SingleInvokeEvent<undefined> = ...

    Private Readonly #timeoutables

    #timeoutables: any[] = []

    Accessors

    isCancellationRequested

    token

    Methods

    cancel

    cancelAfter

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #cancelled

    #cancelled: boolean = false

    Private Readonly #cancelledEvent

    #cancelledEvent: SingleInvokeEvent<undefined> = ...

    Private Readonly #timeoutables

    #timeoutables: any[] = []

    Accessors

    isCancellationRequested

    token

    Methods

    cancel

    cancelAfter

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/QueryStringCollection.html b/docs/api/classes/QueryStringCollection.html index daa652e..b4f6588 100644 --- a/docs/api/classes/QueryStringCollection.html +++ b/docs/api/classes/QueryStringCollection.html @@ -1,4 +1,4 @@ -QueryStringCollection | @michaelcoxon/utilities

    Class QueryStringCollection

    Hierarchy

    • QueryStringCollection

    Constructors

    constructor +QueryStringCollection | @michaelcoxon/utilities

    Class QueryStringCollection

    Hierarchy

    • QueryStringCollection

    Constructors

    constructor

    Properties

    #items

    Accessors

    items

    Methods

    item @@ -7,4 +7,4 @@ createFromObject createFromQueryString merge -

    Constructors

    constructor

    Properties

    Private Readonly #items

    #items: QueryStringItem[]

    Accessors

    items

    Methods

    item

    toObject

    toString

    Static createFromObject

    Static createFromQueryString

    Static merge

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #items

    #items: QueryStringItem[]

    Accessors

    items

    Methods

    item

    toObject

    toString

    Static createFromObject

    Static createFromQueryString

    Static merge

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Result.Result.html b/docs/api/classes/Result.Result.html index a3054c7..ca0f0cd 100644 --- a/docs/api/classes/Result.Result.html +++ b/docs/api/classes/Result.Result.html @@ -1,6 +1,6 @@ Result | @michaelcoxon/utilities

    Class Result<T, TPreviousResult>

    Encapsulates a value allowing for returning an envelope that contains the possible outcomes of a method.

    -

    Type Parameters

    • T = Record<string, any>

    • TPreviousResult extends IResultBase = never

    Hierarchy

    • Result

    Implements

    Constructors

    constructor +

    Type Parameters

    • T = Record<string, any>

    • TPreviousResult extends IResultBase = never

    Hierarchy

    • Result

    Implements

    Constructors

    constructor

    Properties

    #error? #previousResult? #success @@ -11,4 +11,4 @@ value

    Methods

    fail ok -

    Constructors

    constructor

    • Type Parameters

      • T = Record<string, any>

      • TPreviousResult extends IResultBase<never, TPreviousResult> = never

      Parameters

      • success: boolean
      • Optional value: T
      • Optional error: string
      • Optional previousResult: TPreviousResult

      Returns Result<T, TPreviousResult>

    Properties

    Private Optional Readonly #error

    #error?: string

    Private Optional Readonly #previousResult

    #previousResult?: TPreviousResult

    Private Readonly #success

    #success: boolean

    Private Optional Readonly #value

    #value?: T

    Accessors

    error

    previousResult

    success

    value

    Methods

    Static fail

    • Type Parameters

      • T

      • TPreviousResult extends IResultBase<never, TPreviousResult> = never

      Parameters

      • Optional error: string
      • Optional value: T
      • Optional previousResult: TPreviousResult

      Returns IResult<T, TPreviousResult>

    Static ok

    • Type Parameters

      • T

      • TPreviousResult extends IResultBase<never, TPreviousResult> = never

      Parameters

      • Optional value: T
      • Optional previousResult: TPreviousResult

      Returns IResult<T, TPreviousResult>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional Readonly #error

    #error?: string

    Private Optional Readonly #previousResult

    #previousResult?: TPreviousResult

    Private Readonly #success

    #success: boolean

    Private Optional Readonly #value

    #value?: T

    Accessors

    error

    previousResult

    success

    value

    Methods

    Static fail

    Static ok

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Storage.StorageRepository.html b/docs/api/classes/Storage.StorageRepository.html index 8c77b24..6453dc0 100644 --- a/docs/api/classes/Storage.StorageRepository.html +++ b/docs/api/classes/Storage.StorageRepository.html @@ -1,7 +1,7 @@ -StorageRepository | @michaelcoxon/utilities

    Class StorageRepository<T>

    Type Parameters

    • T

    Hierarchy

    • StorageRepository

    Implements

    Constructors

    constructor +StorageRepository | @michaelcoxon/utilities

    Class StorageRepository<T>

    Type Parameters

    • T

    Hierarchy

    • StorageRepository

    Implements

    Constructors

    constructor

    Properties

    #name #storage

    Methods

    deleteAsync getAsync setAsync -

    Constructors

    constructor

    Properties

    Private Readonly #name

    #name: string

    Private Readonly #storage

    #storage: Storage

    Methods

    deleteAsync

    getAsync

    setAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly #name

    #name: string

    Private Readonly #storage

    #storage: Storage

    Methods

    deleteAsync

    getAsync

    setAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Type.Type.html b/docs/api/classes/Type.Type.html index 8bf3cc4..ca9b6f2 100644 --- a/docs/api/classes/Type.Type.html +++ b/docs/api/classes/Type.Type.html @@ -1,4 +1,4 @@ -Type | @michaelcoxon/utilities

    Class Type

    Hierarchy

    • Type

    Constructors

    constructor +Type | @michaelcoxon/utilities

    Class Type

    Hierarchy

    • Type

    Constructors

    constructor

    Accessors

    typeResolvers

    Methods

    getType -

    Constructors

    constructor

    Accessors

    Static typeResolvers

    • get typeResolvers(): ((subject) => {
          success: boolean;
          type?: IType;
      })[]

    • Returns ((subject) => {
          success: boolean;
          type?: IType;
      })[]

    Methods

    Static getType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Accessors

    Static typeResolvers

    • get typeResolvers(): ((subject) => {
          success: boolean;
          type?: IType;
      })[]

    • Returns ((subject) => {
          success: boolean;
          type?: IType;
      })[]

    Methods

    Static getType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Type.TypeBuilder.html b/docs/api/classes/Type.TypeBuilder.html index 32c24de..4f90601 100644 --- a/docs/api/classes/Type.TypeBuilder.html +++ b/docs/api/classes/Type.TypeBuilder.html @@ -1,4 +1,4 @@ -TypeBuilder | @michaelcoxon/utilities

    Class TypeBuilder

    Hierarchy

    • TypeBuilder

    Constructors

    constructor +TypeBuilder | @michaelcoxon/utilities

    Class TypeBuilder

    Hierarchy

    • TypeBuilder

    Constructors

    constructor

    Properties

    #baseType #factory #isArray @@ -9,4 +9,4 @@ setName setNamespace

    Methods

    build -

    Constructors

    constructor

    Properties

    Private #baseType

    #baseType: IType = ...

    Private #factory

    #factory: ((...args) => any) = ...

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    Private #isArray

    #isArray: boolean = false

    Private #name

    #name: string = ''

    Private #namespace

    #namespace: string = ''

    deriveFrom

    deriveFrom: ((type) => TypeBuilder) = ...

    Type declaration

    Optional factory

    factory?: ((constructor) => TypeBuilder) = ...

    Type declaration

      • (constructor): TypeBuilder

      • Parameters

        • constructor: (new <T, TArgs>(...args) => T)
            • new <T, TArgs>(...args): T

            • Type Parameters

              • T

              • TArgs = keyof T

              Parameters

              • Rest ...args: TArgs[]

              Returns T

        Returns TypeBuilder

    setName

    setName: ((name) => TypeBuilder) = ...

    Type declaration

    setNamespace

    setNamespace: ((namespace) => TypeBuilder) = ...

    Type declaration

    Methods

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private #baseType

    #baseType: IType = ...

    Private #factory

    #factory: ((...args) => any) = ...

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    Private #isArray

    #isArray: boolean = false

    Private #name

    #name: string = ''

    Private #namespace

    #namespace: string = ''

    deriveFrom

    deriveFrom: ((type) => TypeBuilder) = ...

    Type declaration

    Optional factory

    factory?: ((constructor) => TypeBuilder) = ...

    Type declaration

      • (constructor): TypeBuilder

      • Parameters

        • constructor: (new <T, TArgs>(...args) => T)
            • new <T, TArgs>(...args): T

            • Type Parameters

              • T

              • TArgs = keyof T

              Parameters

              • Rest ...args: TArgs[]

              Returns T

        Returns TypeBuilder

    setName

    setName: ((name) => TypeBuilder) = ...

    Type declaration

    setNamespace

    setNamespace: ((namespace) => TypeBuilder) = ...

    Type declaration

    Methods

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/classes/Url.html b/docs/api/classes/Url.html index b9b81b3..1ac28fd 100644 --- a/docs/api/classes/Url.html +++ b/docs/api/classes/Url.html @@ -1,5 +1,5 @@ Url | @michaelcoxon/utilities

    Class Url

    Defines a Url

    -

    Hierarchy

    • Url

    Constructors

    constructor +

    Hierarchy

    • Url

    Constructors

    constructor

    Properties

    #query #url

    Accessors

    query @@ -8,6 +8,6 @@

    Constructors

    constructor

    • Creates a new Url

      Parameters

      • baseUrl: string | Url

        The Url to base this instance off of

      • Optional queryStringObject: Record<string, any>

        Query string items as a plain object to add/update on the base Url. Set an item to undefined | null to remove it.

        -

      Returns Url

    Properties

    Private #query

    #query: QueryStringCollection

    Private #url

    #url: string

    Accessors

    query

    Methods

    toString

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Url

    Properties

    Private #query

    #query: QueryStringCollection

    Private #url

    #url: string

    Accessors

    query

    Methods

    toString

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/enums/Logging.LogLevel.html b/docs/api/enums/Logging.LogLevel.html index e3b7e05..ad50453 100644 --- a/docs/api/enums/Logging.LogLevel.html +++ b/docs/api/enums/Logging.LogLevel.html @@ -1,12 +1,12 @@ LogLevel | @michaelcoxon/utilities

    Enumeration LogLevel

    The log level. Used for filtering and tagging logging events

    -

    Enumeration Members

    Debug +

    Enumeration Members

    Debug Error Info Trace Warn

    Enumeration Members

    Debug

    Debug: "DEBG"

    Debug. Should only be used for logging to help development

    -

    Error

    Error: "EROR"

    Error. Used to log out errors and exceptions

    -

    Info

    Info: "INFO"

    Informational. Used to provide runtime information

    -

    Trace

    Trace: "TRCE"

    Trace. Used to log program flow

    -

    Warn

    Warn: "WARN"

    Warning. Used to log errors and exceptions that do not break the program but need to be klnown about

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Error

    Error: "EROR"

    Error. Used to log out errors and exceptions

    +

    Info

    Info: "INFO"

    Informational. Used to provide runtime information

    +

    Trace

    Trace: "TRCE"

    Trace. Used to log program flow

    +

    Warn

    Warn: "WARN"

    Warning. Used to log errors and exceptions that do not break the program but need to be klnown about

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.all.html b/docs/api/functions/Arrays.all.html index 8ad87bd..bce9131 100644 --- a/docs/api/functions/Arrays.all.html +++ b/docs/api/functions/Arrays.all.html @@ -1 +1 @@ -all | @michaelcoxon/utilities

    Function all

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +all | @michaelcoxon/utilities

    Function all

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.any.html b/docs/api/functions/Arrays.any.html index 450fc65..ed8475f 100644 --- a/docs/api/functions/Arrays.any.html +++ b/docs/api/functions/Arrays.any.html @@ -1 +1 @@ -any | @michaelcoxon/utilities

    Function any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +any | @michaelcoxon/utilities

    Function any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.average.html b/docs/api/functions/Arrays.average.html index fbbb6df..8f9ce07 100644 --- a/docs/api/functions/Arrays.average.html +++ b/docs/api/functions/Arrays.average.html @@ -1,2 +1,2 @@ average | @michaelcoxon/utilities

    Function average

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns number

  • Type Parameters

    Parameters

    Returns number

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.contains.html b/docs/api/functions/Arrays.contains.html index 622616f..9719a40 100644 --- a/docs/api/functions/Arrays.contains.html +++ b/docs/api/functions/Arrays.contains.html @@ -1 +1 @@ -contains | @michaelcoxon/utilities

    Function contains

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +contains | @michaelcoxon/utilities

    Function contains

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.count.html b/docs/api/functions/Arrays.count.html index 954ff7c..e83fda9 100644 --- a/docs/api/functions/Arrays.count.html +++ b/docs/api/functions/Arrays.count.html @@ -1 +1 @@ -count | @michaelcoxon/utilities

    Function count

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +count | @michaelcoxon/utilities

    Function count

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.distinct.html b/docs/api/functions/Arrays.distinct.html index 7804aa9..f8e3899 100644 --- a/docs/api/functions/Arrays.distinct.html +++ b/docs/api/functions/Arrays.distinct.html @@ -1 +1 @@ -distinct | @michaelcoxon/utilities

    Function distinct

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +distinct | @michaelcoxon/utilities

    Function distinct

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.first.html b/docs/api/functions/Arrays.first.html index 828b524..355da15 100644 --- a/docs/api/functions/Arrays.first.html +++ b/docs/api/functions/Arrays.first.html @@ -1 +1 @@ -first | @michaelcoxon/utilities

    Function first

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +first | @michaelcoxon/utilities

    Function first

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.firstOrDefault.html b/docs/api/functions/Arrays.firstOrDefault.html index 58dedb6..28bbcab 100644 --- a/docs/api/functions/Arrays.firstOrDefault.html +++ b/docs/api/functions/Arrays.firstOrDefault.html @@ -1 +1 @@ -firstOrDefault | @michaelcoxon/utilities

    Function firstOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +firstOrDefault | @michaelcoxon/utilities

    Function firstOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.forEach.html b/docs/api/functions/Arrays.forEach.html index b6cc031..d0b5aae 100644 --- a/docs/api/functions/Arrays.forEach.html +++ b/docs/api/functions/Arrays.forEach.html @@ -1 +1 @@ -forEach | @michaelcoxon/utilities

    Function forEach

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +forEach | @michaelcoxon/utilities

    Function forEach

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.groupBy.html b/docs/api/functions/Arrays.groupBy.html index 5089828..c9fc775 100644 --- a/docs/api/functions/Arrays.groupBy.html +++ b/docs/api/functions/Arrays.groupBy.html @@ -1 +1 @@ -groupBy | @michaelcoxon/utilities

    Function groupBy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +groupBy | @michaelcoxon/utilities

    Function groupBy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.item.html b/docs/api/functions/Arrays.item.html index 77aedf1..daeab1a 100644 --- a/docs/api/functions/Arrays.item.html +++ b/docs/api/functions/Arrays.item.html @@ -1 +1 @@ -item | @michaelcoxon/utilities

    Function item

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +item | @michaelcoxon/utilities

    Function item

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.last.html b/docs/api/functions/Arrays.last.html index eea56bb..e1c3fd6 100644 --- a/docs/api/functions/Arrays.last.html +++ b/docs/api/functions/Arrays.last.html @@ -1 +1 @@ -last | @michaelcoxon/utilities

    Function last

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +last | @michaelcoxon/utilities

    Function last

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.lastOrDefault.html b/docs/api/functions/Arrays.lastOrDefault.html index 5c87e29..f8104d6 100644 --- a/docs/api/functions/Arrays.lastOrDefault.html +++ b/docs/api/functions/Arrays.lastOrDefault.html @@ -1 +1 @@ -lastOrDefault | @michaelcoxon/utilities

    Function lastOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +lastOrDefault | @michaelcoxon/utilities

    Function lastOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.max.html b/docs/api/functions/Arrays.max.html index db446b5..4617bb7 100644 --- a/docs/api/functions/Arrays.max.html +++ b/docs/api/functions/Arrays.max.html @@ -1 +1 @@ -max | @michaelcoxon/utilities

    Function max

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +max | @michaelcoxon/utilities

    Function max

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.min.html b/docs/api/functions/Arrays.min.html index 0167a23..4c00cd5 100644 --- a/docs/api/functions/Arrays.min.html +++ b/docs/api/functions/Arrays.min.html @@ -1 +1 @@ -min | @michaelcoxon/utilities

    Function min

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +min | @michaelcoxon/utilities

    Function min

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.ofType.html b/docs/api/functions/Arrays.ofType.html index 243ddcc..09a6cc7 100644 --- a/docs/api/functions/Arrays.ofType.html +++ b/docs/api/functions/Arrays.ofType.html @@ -1 +1 @@ -ofType | @michaelcoxon/utilities

    Function ofType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ofType | @michaelcoxon/utilities

    Function ofType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.orderBy.html b/docs/api/functions/Arrays.orderBy.html index e9f6281..33ca578 100644 --- a/docs/api/functions/Arrays.orderBy.html +++ b/docs/api/functions/Arrays.orderBy.html @@ -1 +1 @@ -orderBy | @michaelcoxon/utilities

    Function orderBy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +orderBy | @michaelcoxon/utilities

    Function orderBy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.orderByDescending.html b/docs/api/functions/Arrays.orderByDescending.html index 85692df..6e5c9ba 100644 --- a/docs/api/functions/Arrays.orderByDescending.html +++ b/docs/api/functions/Arrays.orderByDescending.html @@ -1 +1 @@ -orderByDescending | @michaelcoxon/utilities

    Function orderByDescending

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +orderByDescending | @michaelcoxon/utilities

    Function orderByDescending

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.range.html b/docs/api/functions/Arrays.range.html index 7f028ca..a1e971a 100644 --- a/docs/api/functions/Arrays.range.html +++ b/docs/api/functions/Arrays.range.html @@ -1,4 +1,4 @@ range | @michaelcoxon/utilities

    Function range

    • Returns an array of the range of numbers from the start number for the specified length

      Parameters

      • start: number

        the start number

      • length: number

        the specified length

        -

      Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.select.html b/docs/api/functions/Arrays.select.html index e5512da..2992c07 100644 --- a/docs/api/functions/Arrays.select.html +++ b/docs/api/functions/Arrays.select.html @@ -1 +1 @@ -select | @michaelcoxon/utilities

    Function select

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +select | @michaelcoxon/utilities

    Function select

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.selectMany.html b/docs/api/functions/Arrays.selectMany.html index 46829bb..67d1d54 100644 --- a/docs/api/functions/Arrays.selectMany.html +++ b/docs/api/functions/Arrays.selectMany.html @@ -1 +1 @@ -selectMany | @michaelcoxon/utilities

    Function selectMany

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +selectMany | @michaelcoxon/utilities

    Function selectMany

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.sequenceEqual.html b/docs/api/functions/Arrays.sequenceEqual.html index 4e70169..94326a8 100644 --- a/docs/api/functions/Arrays.sequenceEqual.html +++ b/docs/api/functions/Arrays.sequenceEqual.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.single.html b/docs/api/functions/Arrays.single.html index 735e8f8..019bf94 100644 --- a/docs/api/functions/Arrays.single.html +++ b/docs/api/functions/Arrays.single.html @@ -1 +1 @@ -single | @michaelcoxon/utilities

    Function single

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +single | @michaelcoxon/utilities

    Function single

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.singleOrDefault.html b/docs/api/functions/Arrays.singleOrDefault.html index 47509a2..e76ea33 100644 --- a/docs/api/functions/Arrays.singleOrDefault.html +++ b/docs/api/functions/Arrays.singleOrDefault.html @@ -1 +1 @@ -singleOrDefault | @michaelcoxon/utilities

    Function singleOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +singleOrDefault | @michaelcoxon/utilities

    Function singleOrDefault

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.skip.html b/docs/api/functions/Arrays.skip.html index 25241df..2cdb0f1 100644 --- a/docs/api/functions/Arrays.skip.html +++ b/docs/api/functions/Arrays.skip.html @@ -1 +1 @@ -skip | @michaelcoxon/utilities

    Function skip

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +skip | @michaelcoxon/utilities

    Function skip

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.sum.html b/docs/api/functions/Arrays.sum.html index 6029a4f..3150295 100644 --- a/docs/api/functions/Arrays.sum.html +++ b/docs/api/functions/Arrays.sum.html @@ -1,2 +1,2 @@ sum | @michaelcoxon/utilities

    Function sum

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns number

  • Type Parameters

    Parameters

    Returns number

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.take.html b/docs/api/functions/Arrays.take.html index c6a7e6e..f7d28fe 100644 --- a/docs/api/functions/Arrays.take.html +++ b/docs/api/functions/Arrays.take.html @@ -1 +1 @@ -take | @michaelcoxon/utilities

    Function take

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +take | @michaelcoxon/utilities

    Function take

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Arrays.where.html b/docs/api/functions/Arrays.where.html index 0f1570f..3bc371f 100644 --- a/docs/api/functions/Arrays.where.html +++ b/docs/api/functions/Arrays.where.html @@ -1 +1 @@ -where | @michaelcoxon/utilities

    Function where

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +where | @michaelcoxon/utilities

    Function where

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Booleans.parse.html b/docs/api/functions/Booleans.parse.html index 556d649..bec1f7e 100644 --- a/docs/api/functions/Booleans.parse.html +++ b/docs/api/functions/Booleans.parse.html @@ -1 +1 @@ -parse | @michaelcoxon/utilities

    Function parse

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +parse | @michaelcoxon/utilities

    Function parse

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Booleans.tryParse.html b/docs/api/functions/Booleans.tryParse.html index 3499d59..c96382a 100644 --- a/docs/api/functions/Booleans.tryParse.html +++ b/docs/api/functions/Booleans.tryParse.html @@ -1 +1 @@ -tryParse | @michaelcoxon/utilities

    Function tryParse

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +tryParse | @michaelcoxon/utilities

    Function tryParse

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Cache.expire-1.html b/docs/api/functions/Cache.expire-1.html index 1263205..0e6c42b 100644 --- a/docs/api/functions/Cache.expire-1.html +++ b/docs/api/functions/Cache.expire-1.html @@ -1 +1 @@ -expire | @michaelcoxon/utilities

    Function expire

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +expire | @michaelcoxon/utilities

    Function expire

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Configuration.parseKey.html b/docs/api/functions/Configuration.parseKey.html index d8351c7..b1c93da 100644 --- a/docs/api/functions/Configuration.parseKey.html +++ b/docs/api/functions/Configuration.parseKey.html @@ -1 +1 @@ -parseKey | @michaelcoxon/utilities

    Function parseKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +parseKey | @michaelcoxon/utilities

    Function parseKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.combine.html b/docs/api/functions/IO.combine.html index 20818b3..01f4469 100644 --- a/docs/api/functions/IO.combine.html +++ b/docs/api/functions/IO.combine.html @@ -1,2 +1,2 @@ combine | @michaelcoxon/utilities

    Function combine

    • Combines path segments into a path. Auto-senses 'slash' direction.

      -

      Parameters

      • Rest ...args: string[]

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.getDirectory.html b/docs/api/functions/IO.getDirectory.html index db2d68b..a043a8a 100644 --- a/docs/api/functions/IO.getDirectory.html +++ b/docs/api/functions/IO.getDirectory.html @@ -1,2 +1,2 @@ getDirectory | @michaelcoxon/utilities

    Function getDirectory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.getExtension.html b/docs/api/functions/IO.getExtension.html index 5fd6bd3..9b12cb7 100644 --- a/docs/api/functions/IO.getExtension.html +++ b/docs/api/functions/IO.getExtension.html @@ -1,2 +1,2 @@ getExtension | @michaelcoxon/utilities

    Function getExtension

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.getFileName.html b/docs/api/functions/IO.getFileName.html index 0cdecf0..ca6759b 100644 --- a/docs/api/functions/IO.getFileName.html +++ b/docs/api/functions/IO.getFileName.html @@ -1,2 +1,2 @@ getFileName | @michaelcoxon/utilities

    Function getFileName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.getFileNameWithoutExtension.html b/docs/api/functions/IO.getFileNameWithoutExtension.html index 12318fd..3e0c836 100644 --- a/docs/api/functions/IO.getFileNameWithoutExtension.html +++ b/docs/api/functions/IO.getFileNameWithoutExtension.html @@ -1,2 +1,2 @@ getFileNameWithoutExtension | @michaelcoxon/utilities

    Function getFileNameWithoutExtension

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/IO.toFriendlyUrl.html b/docs/api/functions/IO.toFriendlyUrl.html index a3a654e..01b78aa 100644 --- a/docs/api/functions/IO.toFriendlyUrl.html +++ b/docs/api/functions/IO.toFriendlyUrl.html @@ -1,6 +1,6 @@ toFriendlyUrl | @michaelcoxon/utilities

    Function toFriendlyUrl

    • convert a string into a url friendly version

      -

      Parameters

      • str: string

      Returns string

    • convert a string into a url friendly version

      +

      Parameters

      • str: string

      Returns string

    • convert a string into a url friendly version

      Parameters

      • str: string
      • noTrim: boolean

        if true, it will leave hyphens (-) on the start and end of the url. You probably will never want this.

        -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Logging.getDefaultLogger.html b/docs/api/functions/Logging.getDefaultLogger.html index aa00254..e7452e0 100644 --- a/docs/api/functions/Logging.getDefaultLogger.html +++ b/docs/api/functions/Logging.getDefaultLogger.html @@ -1 +1 @@ -getDefaultLogger | @michaelcoxon/utilities

    Function getDefaultLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getDefaultLogger | @michaelcoxon/utilities

    Function getDefaultLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Logging.loggerScope.html b/docs/api/functions/Logging.loggerScope.html index e41fc05..1db4173 100644 --- a/docs/api/functions/Logging.loggerScope.html +++ b/docs/api/functions/Logging.loggerScope.html @@ -1,2 +1,2 @@ loggerScope | @michaelcoxon/utilities

    Function loggerScope

    • Decorator for setting the logger scope of an ILogger instance

      -

      Parameters

      • name: string

      Returns ((target, key) => void)

        • (target, key): void

        • Parameters

          • target: Record<string, any>
          • key: string

          Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns ((target, key) => void)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Logging.setDefaultLogger.html b/docs/api/functions/Logging.setDefaultLogger.html index fcbefca..dfecc79 100644 --- a/docs/api/functions/Logging.setDefaultLogger.html +++ b/docs/api/functions/Logging.setDefaultLogger.html @@ -1 +1 @@ -setDefaultLogger | @michaelcoxon/utilities

    Function setDefaultLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +setDefaultLogger | @michaelcoxon/utilities

    Function setDefaultLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Logging.testLogVerbosity.html b/docs/api/functions/Logging.testLogVerbosity.html index 1f08f34..3e414dc 100644 --- a/docs/api/functions/Logging.testLogVerbosity.html +++ b/docs/api/functions/Logging.testLogVerbosity.html @@ -1,4 +1,4 @@ testLogVerbosity | @michaelcoxon/utilities

    Function testLogVerbosity

    • Returns true if the desired log level is valid for the currently configured logging verbosity

      Parameters

      • desiredLevel: LogLevel

        The log level you want to log at

      • loggingVerbosity: LogLevel

        The cut off for when logging should be hidden

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asByte.html b/docs/api/functions/Numbers.asByte.html index 9647715..b9b4a62 100644 --- a/docs/api/functions/Numbers.asByte.html +++ b/docs/api/functions/Numbers.asByte.html @@ -1 +1 @@ -asByte | @michaelcoxon/utilities

    Function asByte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asByte | @michaelcoxon/utilities

    Function asByte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asInt16.html b/docs/api/functions/Numbers.asInt16.html index cb0127b..cac8d0b 100644 --- a/docs/api/functions/Numbers.asInt16.html +++ b/docs/api/functions/Numbers.asInt16.html @@ -1 +1 @@ -asInt16 | @michaelcoxon/utilities

    Function asInt16

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asInt16 | @michaelcoxon/utilities

    Function asInt16

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asInt32.html b/docs/api/functions/Numbers.asInt32.html index a95cbac..9d48560 100644 --- a/docs/api/functions/Numbers.asInt32.html +++ b/docs/api/functions/Numbers.asInt32.html @@ -1 +1 @@ -asInt32 | @michaelcoxon/utilities

    Function asInt32

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asInt32 | @michaelcoxon/utilities

    Function asInt32

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asSignedByte.html b/docs/api/functions/Numbers.asSignedByte.html index a9a009f..55e3a99 100644 --- a/docs/api/functions/Numbers.asSignedByte.html +++ b/docs/api/functions/Numbers.asSignedByte.html @@ -1 +1 @@ -asSignedByte | @michaelcoxon/utilities

    Function asSignedByte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asSignedByte | @michaelcoxon/utilities

    Function asSignedByte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asUnsignedInt16.html b/docs/api/functions/Numbers.asUnsignedInt16.html index f8000dd..0a52d58 100644 --- a/docs/api/functions/Numbers.asUnsignedInt16.html +++ b/docs/api/functions/Numbers.asUnsignedInt16.html @@ -1 +1 @@ -asUnsignedInt16 | @michaelcoxon/utilities

    Function asUnsignedInt16

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asUnsignedInt16 | @michaelcoxon/utilities

    Function asUnsignedInt16

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.asUnsignedInt32.html b/docs/api/functions/Numbers.asUnsignedInt32.html index 24accb3..8c4e046 100644 --- a/docs/api/functions/Numbers.asUnsignedInt32.html +++ b/docs/api/functions/Numbers.asUnsignedInt32.html @@ -1 +1 @@ -asUnsignedInt32 | @michaelcoxon/utilities

    Function asUnsignedInt32

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asUnsignedInt32 | @michaelcoxon/utilities

    Function asUnsignedInt32

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.isEven.html b/docs/api/functions/Numbers.isEven.html index 0c8f1ed..4c14842 100644 --- a/docs/api/functions/Numbers.isEven.html +++ b/docs/api/functions/Numbers.isEven.html @@ -1 +1 @@ -isEven | @michaelcoxon/utilities

    Function isEven

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isEven | @michaelcoxon/utilities

    Function isEven

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.isMultipleOf.html b/docs/api/functions/Numbers.isMultipleOf.html index 3a0a3f8..1589efe 100644 --- a/docs/api/functions/Numbers.isMultipleOf.html +++ b/docs/api/functions/Numbers.isMultipleOf.html @@ -1 +1 @@ -isMultipleOf | @michaelcoxon/utilities

    Function isMultipleOf

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isMultipleOf | @michaelcoxon/utilities

    Function isMultipleOf

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Numbers.isOdd.html b/docs/api/functions/Numbers.isOdd.html index d8efcff..15b017f 100644 --- a/docs/api/functions/Numbers.isOdd.html +++ b/docs/api/functions/Numbers.isOdd.html @@ -1 +1 @@ -isOdd | @michaelcoxon/utilities

    Function isOdd

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isOdd | @michaelcoxon/utilities

    Function isOdd

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Promises.create.html b/docs/api/functions/Promises.create.html index 0d24ca3..259a0c3 100644 --- a/docs/api/functions/Promises.create.html +++ b/docs/api/functions/Promises.create.html @@ -1,5 +1,5 @@ create | @michaelcoxon/utilities

    Function create

    • Creates a promise from an action

      -

      Parameters

      • action: (() => void)
          • (): void

          • Returns void

      Returns Promise<void>

    • Creates a promise from a promise factory

      -

      Parameters

      • promiseFactory: (() => Promise<void>)
          • (): Promise<void>

          • Returns Promise<void>

      Returns Promise<void>

    • Creates a promise from a factory

      -

      Type Parameters

      • T

      Parameters

      • factory: (() => T)
          • (): T

          • Returns T

      Returns Promise<T>

    • Creates a promise from a promise factory

      -

      Type Parameters

      • T

      Parameters

      • promiseFactory: (() => Promise<T>)
          • (): Promise<T>

          • Returns Promise<T>

      Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

  • Creates a promise from a promise factory

    +

    Parameters

    Returns Promise<void>

  • Creates a promise from a factory

    +

    Type Parameters

    Parameters

    Returns Promise<T>

  • Creates a promise from a promise factory

    +

    Type Parameters

    Parameters

    Returns Promise<T>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Promises.delay.html b/docs/api/functions/Promises.delay.html index 5500cd8..0531db3 100644 --- a/docs/api/functions/Promises.delay.html +++ b/docs/api/functions/Promises.delay.html @@ -1,2 +1,2 @@ delay | @michaelcoxon/utilities

    Function delay

    • Delays for the number of milliseconds

      -

      Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Promises.ensurePromise.html b/docs/api/functions/Promises.ensurePromise.html index 965bc30..0e2e69f 100644 --- a/docs/api/functions/Promises.ensurePromise.html +++ b/docs/api/functions/Promises.ensurePromise.html @@ -1,3 +1,3 @@ ensurePromise | @michaelcoxon/utilities

    Function ensurePromise

    • Wraps a value in a promise

      -

      Type Parameters

      • T

      Parameters

      • value: T

      Returns Promise<T>

    • Ensures a PromiseLike thing is a promise

      -

      Type Parameters

      • T

      Parameters

      • promise: PromiseLike<T>

      Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<T>

  • Ensures a PromiseLike thing is a promise

    +

    Type Parameters

    Parameters

    Returns Promise<T>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.escapeRegExp.html b/docs/api/functions/Strings.escapeRegExp.html index b0c1567..fce831a 100644 --- a/docs/api/functions/Strings.escapeRegExp.html +++ b/docs/api/functions/Strings.escapeRegExp.html @@ -1 +1 @@ -escapeRegExp | @michaelcoxon/utilities

    Function escapeRegExp

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +escapeRegExp | @michaelcoxon/utilities

    Function escapeRegExp

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.firstCharToLowerCase.html b/docs/api/functions/Strings.firstCharToLowerCase.html index ebb358e..4d339b4 100644 --- a/docs/api/functions/Strings.firstCharToLowerCase.html +++ b/docs/api/functions/Strings.firstCharToLowerCase.html @@ -1 +1 @@ -firstCharToLowerCase | @michaelcoxon/utilities

    Function firstCharToLowerCase

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +firstCharToLowerCase | @michaelcoxon/utilities

    Function firstCharToLowerCase

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.firstCharToUpperCase.html b/docs/api/functions/Strings.firstCharToUpperCase.html index fd10f89..35c8ed1 100644 --- a/docs/api/functions/Strings.firstCharToUpperCase.html +++ b/docs/api/functions/Strings.firstCharToUpperCase.html @@ -1 +1 @@ -firstCharToUpperCase | @michaelcoxon/utilities

    Function firstCharToUpperCase

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +firstCharToUpperCase | @michaelcoxon/utilities

    Function firstCharToUpperCase

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.format.html b/docs/api/functions/Strings.format.html index 3b817a3..24e4e27 100644 --- a/docs/api/functions/Strings.format.html +++ b/docs/api/functions/Strings.format.html @@ -1 +1 @@ -format | @michaelcoxon/utilities

    Function format

    • Parameters

      • format: string
      • Rest ...args: any[]

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +format | @michaelcoxon/utilities

    Function format

    • Parameters

      • format: string
      • Rest ...args: any[]

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.isNullOrWhitespace.html b/docs/api/functions/Strings.isNullOrWhitespace.html index 4da4e64..bb6b18a 100644 --- a/docs/api/functions/Strings.isNullOrWhitespace.html +++ b/docs/api/functions/Strings.isNullOrWhitespace.html @@ -1,2 +1,2 @@ isNullOrWhitespace | @michaelcoxon/utilities

    Function isNullOrWhitespace

    • Returns true if the string is undefined, null or whitespace

      -

      Parameters

      • Optional str: null | string

      Returns str is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns str is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.padLeft.html b/docs/api/functions/Strings.padLeft.html index 0d02ac4..b9731bd 100644 --- a/docs/api/functions/Strings.padLeft.html +++ b/docs/api/functions/Strings.padLeft.html @@ -1 +1 @@ -padLeft | @michaelcoxon/utilities

    Function padLeft

    • Parameters

      • str: string
      • length: number
      • padding: string

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +padLeft | @michaelcoxon/utilities

    Function padLeft

    • Parameters

      • str: string
      • length: number
      • padding: string

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.toCharArray.html b/docs/api/functions/Strings.toCharArray.html index 2eaf049..e982c94 100644 --- a/docs/api/functions/Strings.toCharArray.html +++ b/docs/api/functions/Strings.toCharArray.html @@ -1,2 +1,2 @@ toCharArray | @michaelcoxon/utilities

    Function toCharArray

    • Returns all characters in the string as an array.

      -

      Parameters

      • str: string

      Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.trim.html b/docs/api/functions/Strings.trim.html index 0feae2f..75e12fa 100644 --- a/docs/api/functions/Strings.trim.html +++ b/docs/api/functions/Strings.trim.html @@ -1,8 +1,8 @@ trim | @michaelcoxon/utilities

    Function trim

    • Trims the whitespace from the start and end of a string

      Parameters

      • str: string

        The string to trim

        -

      Returns string

    • Trims the specified characters from the start and end of a string

      +

    Returns string

  • Trims the specified characters from the start and end of a string

    Parameters

    • str: string

      The string to trim

    • chars: string

      The set of characters to trim. This treats the characters individually and it will not work if you need to trim a specific string from the start/end.

      -

    Returns string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.trimEnd.html b/docs/api/functions/Strings.trimEnd.html index ace1774..cd9d03e 100644 --- a/docs/api/functions/Strings.trimEnd.html +++ b/docs/api/functions/Strings.trimEnd.html @@ -1,8 +1,8 @@ trimEnd | @michaelcoxon/utilities

    Function trimEnd

    • Trims the whitespace from the end of a string

      Parameters

      • str: string

        The string to trim

        -

      Returns string

    • Trims the specified characters from the end of a string

      +

    Returns string

  • Trims the specified characters from the end of a string

    Parameters

    • str: string

      The string to trim

    • chars: string

      The set of characters to trim. This treats the characters individually and it will not work if you need to trim a specific string from the start/end.

      -

    Returns string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/Strings.trimStart.html b/docs/api/functions/Strings.trimStart.html index 1d46a05..2c17dc5 100644 --- a/docs/api/functions/Strings.trimStart.html +++ b/docs/api/functions/Strings.trimStart.html @@ -1,6 +1,6 @@ -trimStart | @michaelcoxon/utilities

    Function trimStart

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/convertToString.html b/docs/api/functions/convertToString.html index 70c7772..479632e 100644 --- a/docs/api/functions/convertToString.html +++ b/docs/api/functions/convertToString.html @@ -1 +1 @@ -convertToString | @michaelcoxon/utilities

    Function convertToString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +convertToString | @michaelcoxon/utilities

    Function convertToString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/createSelector.html b/docs/api/functions/createSelector.html index b6cbba0..99bec1d 100644 --- a/docs/api/functions/createSelector.html +++ b/docs/api/functions/createSelector.html @@ -1,2 +1,2 @@ createSelector | @michaelcoxon/utilities

    Function createSelector

    • Returns a Selector for the given type.

      -

      Type Parameters

      • T

      • R = T

      • K extends string | number | symbol = keyof T

      Parameters

      • propertyNameOrSelector: K | Selector<T, R>

      Returns Selector<T, R | T[K]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Selector<T, R | T[K]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/ensure.html b/docs/api/functions/ensure.html index 8edc000..703fc75 100644 --- a/docs/api/functions/ensure.html +++ b/docs/api/functions/ensure.html @@ -1,4 +1,4 @@ ensure | @michaelcoxon/utilities

    Function ensure

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns StringArgumentAssertionBuilder

  • Parameters

    Returns GuidArgumentAssertionBuilder

  • Type Parameters

    Parameters

    Returns ArrayLikeArgumentAssertionBuilder<TElement>

  • Type Parameters

    Parameters

    Returns ArgumentAssertionBuilder<T>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/equals.html b/docs/api/functions/equals.html index 758d249..bf81329 100644 --- a/docs/api/functions/equals.html +++ b/docs/api/functions/equals.html @@ -1,7 +1,7 @@ equals | @michaelcoxon/utilities

    Function equals

    • returns true if the two objects are equal but not the same object. (compares public keys)

      -

      Type Parameters

      • T

      Parameters

      • obj1: T
      • obj2: T

      Returns boolean

    • returns true if the two objects are equal but not the same object. (compares public keys)

      +

      Type Parameters

      • T

      Parameters

      • obj1: T
      • obj2: T

      Returns boolean

    • returns true if the two objects are equal but not the same object. (compares public keys)

      Type Parameters

      • T

      Parameters

      • obj1: T
      • obj2: T
      • forceJSON: boolean

        converts the objects to JSON and compares the two strings.

        -

      Returns boolean

    • returns true if the two objects are equal but not the same object. (compares public keys)

      +

    Returns boolean

  • returns true if the two objects are equal but not the same object. (compares public keys)

    Type Parameters

    • T

    Parameters

    • obj1: T
    • obj2: T
    • forceJSON: boolean

      converts the objects to JSON and compares the two strings.

    • deep: boolean

      Does a deep compare. forceJSON must be false

      -

    Returns boolean

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/equivilentToByJSON.html b/docs/api/functions/equivilentToByJSON.html index a59103a..fb8391b 100644 --- a/docs/api/functions/equivilentToByJSON.html +++ b/docs/api/functions/equivilentToByJSON.html @@ -1,2 +1,2 @@ equivilentToByJSON | @michaelcoxon/utilities

    Function equivilentToByJSON

    • returns true if the two objects are equal but not the same object. (compares the JSON equilient of each object).. should be faster.. should..

      -

      Type Parameters

      • T

      Parameters

      • obj1: T
      • obj2: T

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/errorToLogMessage.html b/docs/api/functions/errorToLogMessage.html index 7f2b574..6aa30b0 100644 --- a/docs/api/functions/errorToLogMessage.html +++ b/docs/api/functions/errorToLogMessage.html @@ -1 +1 @@ -errorToLogMessage | @michaelcoxon/utilities

    Function errorToLogMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +errorToLogMessage | @michaelcoxon/utilities

    Function errorToLogMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/getHash.html b/docs/api/functions/getHash.html index 37d38ec..7aa6ccf 100644 --- a/docs/api/functions/getHash.html +++ b/docs/api/functions/getHash.html @@ -1,2 +1,2 @@ getHash | @michaelcoxon/utilities

    Function getHash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/getType.html b/docs/api/functions/getType.html index 85bfcad..423a55b 100644 --- a/docs/api/functions/getType.html +++ b/docs/api/functions/getType.html @@ -1 +1 @@ -getType | @michaelcoxon/utilities

    Function getType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getType | @michaelcoxon/utilities

    Function getType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/hashString.html b/docs/api/functions/hashString.html index 8c7e817..4eea21b 100644 --- a/docs/api/functions/hashString.html +++ b/docs/api/functions/hashString.html @@ -1 +1 @@ -hashString | @michaelcoxon/utilities

    Function hashString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +hashString | @michaelcoxon/utilities

    Function hashString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isBoolean.html b/docs/api/functions/isBoolean.html index 0078087..2f31c4b 100644 --- a/docs/api/functions/isBoolean.html +++ b/docs/api/functions/isBoolean.html @@ -1,2 +1,2 @@ isBoolean | @michaelcoxon/utilities

    Function isBoolean

    • Returns true if the subject is a boolean

      -

      Type Parameters

      • T

      Parameters

      • subject: boolean | T

      Returns subject is boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isComparable.html b/docs/api/functions/isComparable.html index 434ff7b..c6dcd85 100644 --- a/docs/api/functions/isComparable.html +++ b/docs/api/functions/isComparable.html @@ -1 +1 @@ -isComparable | @michaelcoxon/utilities

    Function isComparable

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isComparable | @michaelcoxon/utilities

    Function isComparable

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isDate.html b/docs/api/functions/isDate.html index 2539b4a..8d3ec14 100644 --- a/docs/api/functions/isDate.html +++ b/docs/api/functions/isDate.html @@ -1,2 +1,2 @@ isDate | @michaelcoxon/utilities

    Function isDate

    • Returns true if the subject is a date

      -

      Type Parameters

      • T

      Parameters

      • subject: T | Date

      Returns subject is Date

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is Date

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isFunction.html b/docs/api/functions/isFunction.html index fa4efe5..f3a8a2d 100644 --- a/docs/api/functions/isFunction.html +++ b/docs/api/functions/isFunction.html @@ -1,2 +1,2 @@ isFunction | @michaelcoxon/utilities

    Function isFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is AnyFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isNull.html b/docs/api/functions/isNull.html index 8029eee..85a2649 100644 --- a/docs/api/functions/isNull.html +++ b/docs/api/functions/isNull.html @@ -1,2 +1,2 @@ isNull | @michaelcoxon/utilities

    Function isNull

    • Returns true if the subject is null

      -

      Type Parameters

      • T

      Parameters

      • subject: null | T

      Returns subject is null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isNullOrEmpty.html b/docs/api/functions/isNullOrEmpty.html index e2c5fe4..850da16 100644 --- a/docs/api/functions/isNullOrEmpty.html +++ b/docs/api/functions/isNullOrEmpty.html @@ -1,3 +1,3 @@ isNullOrEmpty | @michaelcoxon/utilities

    Function isNullOrEmpty

    • Returns true if the value is undefined, null or empty.

      NOTE: if you need empty, do this seperately

      -

      Parameters

      • Optional subject: NullOrEmptyableType

      Returns subject is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns subject is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isNumber.html b/docs/api/functions/isNumber.html index 84dcce1..10d26fd 100644 --- a/docs/api/functions/isNumber.html +++ b/docs/api/functions/isNumber.html @@ -1,2 +1,2 @@ isNumber | @michaelcoxon/utilities

    Function isNumber

    • Returns true if the subject is a number

      -

      Type Parameters

      • T

      Parameters

      • subject: number | T

      Returns subject is number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isObject.html b/docs/api/functions/isObject.html index 3da23b7..232ddf7 100644 --- a/docs/api/functions/isObject.html +++ b/docs/api/functions/isObject.html @@ -1,2 +1,2 @@ isObject | @michaelcoxon/utilities

    Function isObject

    • Returns true if the subject is a number

      -

      Type Parameters

      • T

      Parameters

      • subject: Record<string, any> | T

      Returns subject is Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isString.html b/docs/api/functions/isString.html index c22396a..e188f4a 100644 --- a/docs/api/functions/isString.html +++ b/docs/api/functions/isString.html @@ -1,2 +1,2 @@ isString | @michaelcoxon/utilities

    Function isString

    • Returns true if the subject is a string

      -

      Type Parameters

      • T

      Parameters

      • subject: string | T

      Returns subject is string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isUndefined.html b/docs/api/functions/isUndefined.html index eb8bb14..645c300 100644 --- a/docs/api/functions/isUndefined.html +++ b/docs/api/functions/isUndefined.html @@ -1,2 +1,2 @@ isUndefined | @michaelcoxon/utilities

    Function isUndefined

    • Returns true if the subject is undefined

      -

      Type Parameters

      • T

      Parameters

      • subject: undefined | T

      Returns subject is undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns subject is undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/isUndefinedOrNull.html b/docs/api/functions/isUndefinedOrNull.html index 7060905..ab5d52c 100644 --- a/docs/api/functions/isUndefinedOrNull.html +++ b/docs/api/functions/isUndefinedOrNull.html @@ -1 +1 @@ -isUndefinedOrNull | @michaelcoxon/utilities

    Function isUndefinedOrNull

    • Type Parameters

      • T

      Parameters

      • subject: undefined | null | T

      Returns subject is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isUndefinedOrNull | @michaelcoxon/utilities

    Function isUndefinedOrNull

    • Type Parameters

      • T

      Parameters

      • subject: undefined | null | T

      Returns subject is undefined | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/noop.html b/docs/api/functions/noop.html index b3d3974..6ff9f9d 100644 --- a/docs/api/functions/noop.html +++ b/docs/api/functions/noop.html @@ -1 +1 @@ -noop | @michaelcoxon/utilities

    Function noop

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +noop | @michaelcoxon/utilities

    Function noop

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/serializeError.html b/docs/api/functions/serializeError.html index 5eec933..a5df358 100644 --- a/docs/api/functions/serializeError.html +++ b/docs/api/functions/serializeError.html @@ -1,3 +1,3 @@ serializeError | @michaelcoxon/utilities

    Function serializeError

    • Serializes an error to JSON.

      Parameters

      • error: Error

        The error to serialize.

        -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/stringOrUrlToUrl.html b/docs/api/functions/stringOrUrlToUrl.html index 6875a9b..7849884 100644 --- a/docs/api/functions/stringOrUrlToUrl.html +++ b/docs/api/functions/stringOrUrlToUrl.html @@ -1,2 +1,2 @@ stringOrUrlToUrl | @michaelcoxon/utilities

    Function stringOrUrlToUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Url

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/using.html b/docs/api/functions/using.html index 7295a21..90525ee 100644 --- a/docs/api/functions/using.html +++ b/docs/api/functions/using.html @@ -1,3 +1,3 @@ using | @michaelcoxon/utilities

    Function using

    • Creates a disposable object then cleans it up after inner has finished execution. DO NOT USE ON PROMISES!!! use usingAsync instead.

      -

      Type Parameters

      Parameters

      • disposableObjectFactory: (() => T)
          • (): T

          • Returns T

      • inner: ((disposableObject) => TResult)
          • (disposableObject): TResult

          • Parameters

            • disposableObject: T

            Returns TResult

      Returns TResult

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns TResult

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/functions/usingAsync.html b/docs/api/functions/usingAsync.html index e7966ea..695bdb0 100644 --- a/docs/api/functions/usingAsync.html +++ b/docs/api/functions/usingAsync.html @@ -1,2 +1,2 @@ usingAsync | @michaelcoxon/utilities

    Function usingAsync

    • creates a disposable object then cleans it up after inner has resolved.

      -

      Type Parameters

      Parameters

      • disposableObjectFactory: (() => T)
          • (): T

          • Returns T

      • inner: ((disposableObject) => Promise<TResult>)
          • (disposableObject): Promise<TResult>

          • Parameters

            • disposableObject: T

            Returns Promise<TResult>

      Returns Promise<TResult>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<TResult>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Cache.IAsyncCacheItem.html b/docs/api/interfaces/Cache.IAsyncCacheItem.html index 5c3816b..b4ad79f 100644 --- a/docs/api/interfaces/Cache.IAsyncCacheItem.html +++ b/docs/api/interfaces/Cache.IAsyncCacheItem.html @@ -1,3 +1,3 @@ -IAsyncCacheItem | @michaelcoxon/utilities

    Interface IAsyncCacheItem<T>

    Type Parameters

    • T

    Hierarchy

    • IAsyncCacheItem

    Implemented by

    Properties

    expiredAsync +IAsyncCacheItem | @michaelcoxon/utilities

    Interface IAsyncCacheItem<T>

    Type Parameters

    • T

    Hierarchy

    • IAsyncCacheItem

    Implemented by

    Properties

    expiredAsync valueAsync -

    Properties

    Readonly expiredAsync

    expiredAsync: Promise<boolean>

    Readonly valueAsync

    valueAsync: Promise<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly expiredAsync

    expiredAsync: Promise<boolean>

    Readonly valueAsync

    valueAsync: Promise<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Cache.ICache.html b/docs/api/interfaces/Cache.ICache.html index 39b6b73..29a6533 100644 --- a/docs/api/interfaces/Cache.ICache.html +++ b/docs/api/interfaces/Cache.ICache.html @@ -1,8 +1,8 @@ -ICache | @michaelcoxon/utilities

    Interface ICache<TKey>

    Type Parameters

    • TKey

    Hierarchy

    • ICache

    Implemented by

    Methods

    add +ICache | @michaelcoxon/utilities

    Interface ICache<TKey>

    Type Parameters

    • TKey

    Hierarchy

    • ICache

    Implemented by

    Methods

    add addOrGetAsync addOrReplace cleanAsync getAsync replace tryGetAsync -

    Methods

    add

    addOrGetAsync

    addOrReplace

    cleanAsync

    getAsync

    • Type Parameters

      • T

      Parameters

      • key: TKey

      Returns Promise<T>

    replace

    tryGetAsync

    • Type Parameters

      • T

      Parameters

      • key: TKey

      Returns Promise<{
          success: boolean;
          value?: Promise<T>;
      }>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    add

    addOrGetAsync

    addOrReplace

    cleanAsync

    getAsync

    • Type Parameters

      • T

      Parameters

      • key: TKey

      Returns Promise<T>

    replace

    tryGetAsync

    • Type Parameters

      • T

      Parameters

      • key: TKey

      Returns Promise<{
          success: boolean;
          value?: Promise<T>;
      }>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Comparers.IComparable.html b/docs/api/interfaces/Comparers.IComparable.html index bb6658f..38968fd 100644 --- a/docs/api/interfaces/Comparers.IComparable.html +++ b/docs/api/interfaces/Comparers.IComparable.html @@ -1,2 +1,2 @@ -IComparable | @michaelcoxon/utilities

    Interface IComparable

    Hierarchy

    • IComparable

    Methods

    valueOf -

    Methods

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IComparable | @michaelcoxon/utilities

    Interface IComparable

    Hierarchy

    • IComparable

    Methods

    valueOf +

    Methods

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Comparers.IComparer.html b/docs/api/interfaces/Comparers.IComparer.html index 514f73e..21978b0 100644 --- a/docs/api/interfaces/Comparers.IComparer.html +++ b/docs/api/interfaces/Comparers.IComparer.html @@ -1,4 +1,4 @@ -IComparer | @michaelcoxon/utilities

    Interface IComparer<T>

    Type Parameters

    • T

    Hierarchy

    • IComparer

    Implemented by

    Methods

    compare +IComparer | @michaelcoxon/utilities

    Interface IComparer<T>

    Type Parameters

    • T

    Hierarchy

    • IComparer

    Implemented by

    Methods

    compare equals greaterThan greaterThanOrEqual @@ -10,9 +10,9 @@
  • x == y : return 0
  • x > y : return >0
    • -

    Parameters

    • x: T
    • y: T

    Returns number

    equals

    greaterThan

    • Returns true if 'x' is greater than 'y'.

      -

      Parameters

      • x: T
      • y: T

      Returns boolean

    greaterThanOrEqual

    • Returns true if 'x' is greater than or equal to 'y'.

      -

      Parameters

      • x: T
      • y: T

      Returns boolean

    lessThan

    • Returns true if 'x' is les than 'y'.

      -

      Parameters

      • x: T
      • y: T

      Returns boolean

    lessThanOrEqual

    • Returns true if 'x' is less than or equal to 'y'.

      -

      Parameters

      • x: T
      • y: T

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • x: T
    • y: T

    Returns number

    equals

    greaterThan

    • Returns true if 'x' is greater than 'y'.

      +

      Parameters

      • x: T
      • y: T

      Returns boolean

    greaterThanOrEqual

    • Returns true if 'x' is greater than or equal to 'y'.

      +

      Parameters

      • x: T
      • y: T

      Returns boolean

    lessThan

    • Returns true if 'x' is les than 'y'.

      +

      Parameters

      • x: T
      • y: T

      Returns boolean

    lessThanOrEqual

    • Returns true if 'x' is less than or equal to 'y'.

      +

      Parameters

      • x: T
      • y: T

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Comparers.IEqualityComparer.html b/docs/api/interfaces/Comparers.IEqualityComparer.html index a4406b2..c35ac78 100644 --- a/docs/api/interfaces/Comparers.IEqualityComparer.html +++ b/docs/api/interfaces/Comparers.IEqualityComparer.html @@ -1,2 +1,2 @@ -IEqualityComparer | @michaelcoxon/utilities

    Interface IEqualityComparer<T>

    Type Parameters

    • T

    Hierarchy

    • IEqualityComparer

    Implemented by

    Methods

    equals -

    Methods

    equals

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IEqualityComparer | @michaelcoxon/utilities

    Interface IEqualityComparer<T>

    Type Parameters

    • T

    Hierarchy

    • IEqualityComparer

    Implemented by

    Methods

    equals +

    Methods

    equals

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Configuration.IConfiguration.html b/docs/api/interfaces/Configuration.IConfiguration.html index 69b599e..2bb302d 100644 --- a/docs/api/interfaces/Configuration.IConfiguration.html +++ b/docs/api/interfaces/Configuration.IConfiguration.html @@ -1,4 +1,4 @@ -IConfiguration | @michaelcoxon/utilities

    Interface IConfiguration

    Hierarchy

    Properties

    root +IConfiguration | @michaelcoxon/utilities

    Interface IConfiguration

    Hierarchy

    Properties

    root

    Methods

    get getSection -

    Properties

    root

    root: IConfigurationSection

    Methods

    get

    getSection

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    root

    root: IConfigurationSection

    Methods

    get

    getSection

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Configuration.IConfigurationBuilder.html b/docs/api/interfaces/Configuration.IConfigurationBuilder.html index f3ba5f9..8dd7136 100644 --- a/docs/api/interfaces/Configuration.IConfigurationBuilder.html +++ b/docs/api/interfaces/Configuration.IConfigurationBuilder.html @@ -1,2 +1,2 @@ -IConfigurationBuilder | @michaelcoxon/utilities

    Interface IConfigurationBuilder

    Hierarchy

    • IConfigurationBuilder

    Implemented by

    Methods

    build -

    Methods

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IConfigurationBuilder | @michaelcoxon/utilities

    Interface IConfigurationBuilder

    Hierarchy

    • IConfigurationBuilder

    Implemented by

    Methods

    build +

    Methods

    build

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Configuration.IConfigurationSection.html b/docs/api/interfaces/Configuration.IConfigurationSection.html index 6bba198..b5690b9 100644 --- a/docs/api/interfaces/Configuration.IConfigurationSection.html +++ b/docs/api/interfaces/Configuration.IConfigurationSection.html @@ -1,3 +1,3 @@ -IConfigurationSection | @michaelcoxon/utilities

    Interface IConfigurationSection

    Hierarchy

    Methods

    get +IConfigurationSection | @michaelcoxon/utilities

    Interface IConfigurationSection

    Hierarchy

    Methods

    get getSection -

    Methods

    get

    getSection

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    get

    getSection

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.ICollection.html b/docs/api/interfaces/Enumerables.ICollection.html index 13906aa..4845791 100644 --- a/docs/api/interfaces/Enumerables.ICollection.html +++ b/docs/api/interfaces/Enumerables.ICollection.html @@ -1,4 +1,4 @@ -ICollection | @michaelcoxon/utilities

    Interface ICollection<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly +ICollection | @michaelcoxon/utilities

    Interface ICollection<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly length

    Methods

    [iterator] add @@ -40,71 +40,71 @@ toList where

    Properties

    Readonly isReadOnly

    isReadOnly: boolean

    Gets a value indicating whether the ICollection is read-only.

    -

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    -

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    +

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    • Adds an item to the ICollection.

      Parameters

      • item: T

        The object to add to the ICollection.

        -

      Returns void

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      +

    Returns boolean

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      Parameters

      • array: T[]

        The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

      • arrayIndex: number

        The zero-based index in array at which copying begins.

        -

      Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    • Returns the item at the specified index

      +

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    remove

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.IDictionary.html b/docs/api/interfaces/Enumerables.IDictionary.html index e5368b7..ca917cc 100644 --- a/docs/api/interfaces/Enumerables.IDictionary.html +++ b/docs/api/interfaces/Enumerables.IDictionary.html @@ -1,4 +1,4 @@ -IDictionary | @michaelcoxon/utilities

    Interface IDictionary<TKey, TValue>

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implemented by

    Properties

    isReadOnly +IDictionary | @michaelcoxon/utilities

    Interface IDictionary<TKey, TValue>

    Type Parameters

    • TKey

    • TValue

    Hierarchy

    Implemented by

    Properties

    isReadOnly keys length values @@ -47,71 +47,71 @@ tryGetValue where

    Properties

    Readonly isReadOnly

    isReadOnly: boolean

    Gets a value indicating whether the ICollection is read-only.

    -

    Readonly keys

    keys: TKey[]

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    -

    Readonly values

    values: TValue[]

    Methods

    [iterator]

    • [iterator](): Iterator<KeyValuePair<TKey, TValue>, any, undefined>

    • Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>

    add

    Readonly keys

    keys: TKey[]

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    +

    Readonly values

    values: TValue[]

    Methods

    [iterator]

    • [iterator](): Iterator<KeyValuePair<TKey, TValue>, any, undefined>

    • Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>

    add

    addKeyValue

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    addKeyValue

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    containsKey

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      +

    Returns boolean

    containsKey

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      Parameters

      • array: KeyValuePair<TKey, TValue>[]

        The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

      • arrayIndex: number

        The zero-based index in array at which copying begins.

        -

      Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    itemByKey

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<KeyValuePair<TKey, TValue>>

    itemByKey

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    remove

    removeByKey

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    remove

    removeByKey

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    tryGetValue

    where

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    toArray

    toDictionary

    toList

    tryGetValue

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<KeyValuePair<TKey, TValue>>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.IEnumerable.html b/docs/api/interfaces/Enumerables.IEnumerable.html index 1858352..5767b53 100644 --- a/docs/api/interfaces/Enumerables.IEnumerable.html +++ b/docs/api/interfaces/Enumerables.IEnumerable.html @@ -1,4 +1,4 @@ -IEnumerable | @michaelcoxon/utilities

    Interface IEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    [iterator] +IEnumerable | @michaelcoxon/utilities

    Interface IEnumerable<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    [iterator] all any append @@ -34,62 +34,62 @@ toList where

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    all

    any

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    • Determines whether a sequence contains a specified element.

      Parameters

      • item: T

        The value to locate in the sequence.

        -

      Returns boolean

    count

    distinct

    first

    firstOrDefault

    • Returns the first item in the enumerable or null

      -

      Returns null | T

    • Returns the first item in the enumerable that matches the predicate or null

      -

      Parameters

      Returns null | T

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    • Returns the first item in the enumerable or null

      +

      Returns null | T

    • Returns the first item in the enumerable that matches the predicate or null

      +

      Parameters

      Returns null | T

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      +

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    • Returns an enumerable of items that match the type

      +

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    • Returns a single element only if there is one element in the enumerable

      +

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.IEnumerableGroup.html b/docs/api/interfaces/Enumerables.IEnumerableGroup.html index 77e1904..6206599 100644 --- a/docs/api/interfaces/Enumerables.IEnumerableGroup.html +++ b/docs/api/interfaces/Enumerables.IEnumerableGroup.html @@ -1,4 +1,4 @@ -IEnumerableGroup | @michaelcoxon/utilities

    Interface IEnumerableGroup<T, TKey>

    Type Parameters

    • T

    • TKey

    Hierarchy

    Properties

    key +IEnumerableGroup | @michaelcoxon/utilities

    Interface IEnumerableGroup<T, TKey>

    Type Parameters

    • T

    • TKey

    Hierarchy

    Properties

    key

    Methods

    [iterator] all any @@ -34,63 +34,63 @@ toDictionary toList where -

    Properties

    Readonly key

    key: TKey

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Properties

    Readonly key

    key: TKey

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.IList.html b/docs/api/interfaces/Enumerables.IList.html index 9881aa1..d31560a 100644 --- a/docs/api/interfaces/Enumerables.IList.html +++ b/docs/api/interfaces/Enumerables.IList.html @@ -1,4 +1,4 @@ -IList | @michaelcoxon/utilities

    Interface IList<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly +IList | @michaelcoxon/utilities

    Interface IList<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly length

    Methods

    [iterator] add @@ -46,71 +46,71 @@ toList where

    Properties

    Readonly isReadOnly

    isReadOnly: boolean

    Gets a value indicating whether the ICollection is read-only.

    -

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    -

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    +

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    addRange

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    addRange

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      +

    Returns boolean

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      Parameters

      • array: T[]

        The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

      • arrayIndex: number

        The zero-based index in array at which copying begins.

        -

      Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    indexOf

    insert

    item

    • Returns the item at the specified index

      +

    Returns void

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    indexOf

    insert

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    prependRange

    remove

    removeAt

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    prependRange

    remove

    removeAt

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    sort

    split

    sum

    Returns IEnumerable<T>

    sort

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.IReadOnlyCollection.html b/docs/api/interfaces/Enumerables.IReadOnlyCollection.html index e875f71..ef5d951 100644 --- a/docs/api/interfaces/Enumerables.IReadOnlyCollection.html +++ b/docs/api/interfaces/Enumerables.IReadOnlyCollection.html @@ -1,4 +1,4 @@ -IReadOnlyCollection | @michaelcoxon/utilities

    Interface IReadOnlyCollection<T>

    Type Parameters

    • T

    Hierarchy

    Properties

    length +IReadOnlyCollection | @michaelcoxon/utilities

    Interface IReadOnlyCollection<T>

    Type Parameters

    • T

    Hierarchy

    Properties

    length

    Methods

    [iterator] all any @@ -34,63 +34,63 @@ toDictionary toList where -

    Properties

    Readonly length

    length: number

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Properties

    Readonly length

    length: number

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    concat

    contains

    append

    average

    concat

    contains

    count

    distinct

    first

    firstOrDefault

    forEach

    • Iterates over the enumerable and performs the callback on each item. Return false to break.

      -

      Parameters

      • callback: ((value, index) => boolean | void)
          • (value, index): boolean | void

          • Parameters

            • value: T
            • index: number

            Returns boolean | void

      Returns void

    getEnumerator

    groupBy

    item

    • Returns the item at the specified index

      +

    Returns boolean

    count

    distinct

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    prepend

    select

    selectMany

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    take

    Returns number

    take

    toArray

    toDictionary

    toList

    where

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.ISet.html b/docs/api/interfaces/Enumerables.ISet.html index 19cdd8f..7f2b158 100644 --- a/docs/api/interfaces/Enumerables.ISet.html +++ b/docs/api/interfaces/Enumerables.ISet.html @@ -1,4 +1,4 @@ -ISet | @michaelcoxon/utilities

    Interface ISet<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly +ISet | @michaelcoxon/utilities

    Interface ISet<T>

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Properties

    isReadOnly length

    Methods

    [iterator] add @@ -48,91 +48,91 @@ unionWith where

    Properties

    Readonly isReadOnly

    isReadOnly: boolean

    Gets a value indicating whether the ICollection is read-only.

    -

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    -

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    Readonly length

    length: number

    Gets the number of elements contained in the ICollection.

    +

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns Iterator<T, any, undefined>

    add

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      +

    Returns void

    all

    any

    • Returns true if any of the items match the predicate, otherwise false

      Parameters

      Returns boolean

      Example

      if (myEnumerable.any()) {
          // do something because the enumerable has elements
      }
 
      let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
      if (myEnumerable.any((i) => i == 2)) {
          // the enumerable contains a '2'
      }
      -

    append

    average

    clear

    concat

    contains

    append

    average

    clear

    concat

    contains

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      +

    Returns boolean

    copyTo

    • Copies the elements of the ICollection to an Array, starting at a particular Array index.

      Parameters

      • array: T[]

        The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

      • arrayIndex: number

        The zero-based index in array at which copying begins.

        -

      Returns void

    count

    distinct

    exceptWith

    • Removes all elements in the specified collection from the current set.

      +

    Returns void

    count

    distinct

    exceptWith

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    intersectWith

    Returns void

    first

    firstOrDefault

    forEach

    getEnumerator

    groupBy

    intersectWith

    isSubsetOf

    Returns void

    isSubsetOf

    isSupersetOf

    isSupersetOf

    item

    item

    last

    lastOrDefault

    max

    min

    ofType

    Returns Undefinable<T>

    last

    lastOrDefault

    max

    min

    ofType

    orderBy

    orderByDescending

    overlaps

    Returns IEnumerable<N>

    orderBy

    orderByDescending

    overlaps

    prepend

    remove

    select

    selectMany

    setEquals

    prepend

    remove

    select

    selectMany

    setEquals

    single

    single

    singleOrDefault

    singleOrDefault

    skip

    skip

    split

    sum

    Returns IEnumerable<T>

    split

    sum

    symmetricExceptWith

    Returns number

    symmetricExceptWith

    take

    Returns void

    take

    toArray

    toDictionary

    toList

    unionWith

    Returns IEnumerable<T>

    toArray

    toDictionary

    toList

    unionWith

    where

    Returns void

    where

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns IEnumerable<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerables.LinkedListItem.html b/docs/api/interfaces/Enumerables.LinkedListItem.html index a6d9aa9..61dab8f 100644 --- a/docs/api/interfaces/Enumerables.LinkedListItem.html +++ b/docs/api/interfaces/Enumerables.LinkedListItem.html @@ -1,3 +1,3 @@ -LinkedListItem | @michaelcoxon/utilities

    Interface LinkedListItem<T>

    Type Parameters

    • T

    Hierarchy

    • LinkedListItem

    Properties

    next? +LinkedListItem | @michaelcoxon/utilities

    Interface LinkedListItem<T>

    Type Parameters

    • T

    Hierarchy

    • LinkedListItem

    Properties

    next? value -

    Properties

    Optional next

    next?: LinkedListItem<T>

    value

    value: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional next

    next?: LinkedListItem<T>

    value

    value: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerators.IAsyncEnumerator.html b/docs/api/interfaces/Enumerators.IAsyncEnumerator.html index afef03c..6b42ba7 100644 --- a/docs/api/interfaces/Enumerators.IAsyncEnumerator.html +++ b/docs/api/interfaces/Enumerators.IAsyncEnumerator.html @@ -1,5 +1,5 @@ -IAsyncEnumerator | @michaelcoxon/utilities

    Interface IAsyncEnumerator<T>

    Type Parameters

    • T

    Hierarchy

    • IAsyncEnumerator

    Implemented by

    Properties

    current +IAsyncEnumerator | @michaelcoxon/utilities

    Interface IAsyncEnumerator<T>

    Type Parameters

    • T

    Hierarchy

    • IAsyncEnumerator

    Implemented by

    Properties

    current

    Methods

    moveNextAsync

    Properties

    Readonly current

    current: T

    value of the current element

    -

    Methods

    moveNextAsync

    • move to the next element. Returns false if there is no next element

      -

      Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    moveNextAsync

    • move to the next element. Returns false if there is no next element

      +

      Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Enumerators.IEnumerator.html b/docs/api/interfaces/Enumerators.IEnumerator.html index cfaac46..44e60fe 100644 --- a/docs/api/interfaces/Enumerators.IEnumerator.html +++ b/docs/api/interfaces/Enumerators.IEnumerator.html @@ -1,5 +1,5 @@ IEnumerator | @michaelcoxon/utilities

    Interface IEnumerator<T>

    Enumrates an object source for values.

    -

    Type Parameters

    • T

    Hierarchy

    • Iterator<T>
      • IEnumerator

    Implemented by

    Properties

    current +

    Type Parameters

    • T

    Hierarchy

    • Iterator<T>
      • IEnumerator

    Implemented by

    Properties

    current

    Methods

    moveNext next peek @@ -7,7 +7,7 @@ return? throw?

    Properties

    Readonly current

    current: T

    value of the current element

    -

    Methods

    moveNext

    • move to the next element. Returns false if there is no next element

      -

      Returns boolean

    next

    • Parameters

      • Rest ...args: [] | [undefined]

      Returns IteratorResult<T, any>

    peek

    reset

    Optional return

    • Parameters

      • Optional value: any

      Returns IteratorResult<T, any>

    Optional throw

    • Parameters

      • Optional e: any

      Returns IteratorResult<T, any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    moveNext

    next

    peek

    reset

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Events.IEvent.html b/docs/api/interfaces/Events.IEvent.html index 22fb8c9..e8f1a6d 100644 --- a/docs/api/interfaces/Events.IEvent.html +++ b/docs/api/interfaces/Events.IEvent.html @@ -1,4 +1,4 @@ IEvent | @michaelcoxon/utilities

    Interface IEvent<TEventArgs>

    An interface to expose an event publicly

    -

    Type Parameters

    • TEventArgs

    Hierarchy

    • IEvent

    Implemented by

    Methods

    addHandler +

    Type Parameters

    • TEventArgs

    Hierarchy

    • IEvent

    Implemented by

    Methods

    addHandler removeHandler -

    Methods

    addHandler

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    addHandler

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Formatters.IDateFormatterConfiguration.html b/docs/api/interfaces/Formatters.IDateFormatterConfiguration.html index de9e17c..28ddefa 100644 --- a/docs/api/interfaces/Formatters.IDateFormatterConfiguration.html +++ b/docs/api/interfaces/Formatters.IDateFormatterConfiguration.html @@ -1,4 +1,4 @@ -IDateFormatterConfiguration | @michaelcoxon/utilities

    Interface IDateFormatterConfiguration

    Hierarchy

    • IDateFormatterConfiguration

    Properties

    am +IDateFormatterConfiguration | @michaelcoxon/utilities

    Interface IDateFormatterConfiguration

    Hierarchy

    • IDateFormatterConfiguration

    Properties

    am dateSeparator daysOfWeek_Long daysOfWeek_Short @@ -6,4 +6,4 @@ months_Short pm timeSeparator -

    Properties

    am

    am: string

    dateSeparator

    dateSeparator: string

    daysOfWeek_Long

    daysOfWeek_Long: string[]

    daysOfWeek_Short

    daysOfWeek_Short: string[]

    months_Long

    months_Long: string[]

    months_Short

    months_Short: string[]

    pm

    pm: string

    timeSeparator

    timeSeparator: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    am

    am: string

    dateSeparator

    dateSeparator: string

    daysOfWeek_Long

    daysOfWeek_Long: string[]

    daysOfWeek_Short

    daysOfWeek_Short: string[]

    months_Long

    months_Long: string[]

    months_Short

    months_Short: string[]

    pm

    pm: string

    timeSeparator

    timeSeparator: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Formatters.IFormatter.html b/docs/api/interfaces/Formatters.IFormatter.html index 80d769e..923e832 100644 --- a/docs/api/interfaces/Formatters.IFormatter.html +++ b/docs/api/interfaces/Formatters.IFormatter.html @@ -1,2 +1,2 @@ -IFormatter | @michaelcoxon/utilities

    Interface IFormatter<T>

    Type Parameters

    • T

    Hierarchy

    • IFormatter

    Implemented by

    Methods

    format -

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IFormatter | @michaelcoxon/utilities

    Interface IFormatter<T>

    Type Parameters

    • T

    Hierarchy

    • IFormatter

    Implemented by

    Methods

    format +

    Methods

    format

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Formatters.INumberFormatterConfiguration.html b/docs/api/interfaces/Formatters.INumberFormatterConfiguration.html index 21c88f1..d530bdd 100644 --- a/docs/api/interfaces/Formatters.INumberFormatterConfiguration.html +++ b/docs/api/interfaces/Formatters.INumberFormatterConfiguration.html @@ -1,5 +1,5 @@ -INumberFormatterConfiguration | @michaelcoxon/utilities

    Interface INumberFormatterConfiguration

    Hierarchy

    • INumberFormatterConfiguration

    Properties

    currencyDecimalDigits +INumberFormatterConfiguration | @michaelcoxon/utilities

    Interface INumberFormatterConfiguration

    Hierarchy

    • INumberFormatterConfiguration

    Properties

    currencyDecimalDigits currencyFormat numberDecimalDigits percentDecimalDigits -

    Properties

    currencyDecimalDigits

    currencyDecimalDigits: number

    currencyFormat

    currencyFormat: string

    numberDecimalDigits

    numberDecimalDigits: number

    percentDecimalDigits

    percentDecimalDigits: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    currencyDecimalDigits

    currencyDecimalDigits: number

    currencyFormat

    currencyFormat: string

    numberDecimalDigits

    numberDecimalDigits: number

    percentDecimalDigits

    percentDecimalDigits: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/IDisposable.html b/docs/api/interfaces/IDisposable.html index 1f4d018..304d2bb 100644 --- a/docs/api/interfaces/IDisposable.html +++ b/docs/api/interfaces/IDisposable.html @@ -1,3 +1,3 @@ IDisposable | @michaelcoxon/utilities

    Interface IDisposable

    interface for disposable objects

    -

    Hierarchy

    • IDisposable

    Implemented by

    Methods

    dispose -

    Methods

    dispose

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Implemented by

    Methods

    dispose +

    Methods

    dispose

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/IO.IIndentedStringBuilder.html b/docs/api/interfaces/IO.IIndentedStringBuilder.html index 7f06fa6..18796df 100644 --- a/docs/api/interfaces/IO.IIndentedStringBuilder.html +++ b/docs/api/interfaces/IO.IIndentedStringBuilder.html @@ -1,11 +1,11 @@ -IIndentedStringBuilder | @michaelcoxon/utilities

    Interface IIndentedStringBuilder

    Hierarchy

    • IIndentedStringBuilder

    Implemented by

    Methods

    appendLine +IIndentedStringBuilder | @michaelcoxon/utilities

    Interface IIndentedStringBuilder

    Hierarchy

    • IIndentedStringBuilder

    Implemented by

    Methods

    appendLine clear indent toString unindent

    Methods

    appendLine

    • Appends the value to the builder with a new line afterwards.

      -

      Parameters

      • value: string

      Returns void

    clear

    • Clears all values from the StringBuilder.

      -

      Returns void

    indent

    toString

    • Returns a string representation of the StringBuilder.

      -

      Returns string

    unindent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • value: string

    Returns void

    clear

    • Clears all values from the StringBuilder.

      +

      Returns void

    indent

    toString

    • Returns a string representation of the StringBuilder.

      +

      Returns string

    unindent

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/IO.IStringBuilder.html b/docs/api/interfaces/IO.IStringBuilder.html index 3cf9fab..5676553 100644 --- a/docs/api/interfaces/IO.IStringBuilder.html +++ b/docs/api/interfaces/IO.IStringBuilder.html @@ -1,9 +1,9 @@ -IStringBuilder | @michaelcoxon/utilities

    Interface IStringBuilder

    Hierarchy

    • IStringBuilder

    Implemented by

    Methods

    append +IStringBuilder | @michaelcoxon/utilities

    Interface IStringBuilder

    Hierarchy

    • IStringBuilder

    Implemented by

    Methods

    append appendLine clear toString

    Methods

    append

    • Append the value to the builder

      -

      Parameters

      • value: string

      Returns void

    appendLine

    • Appends the value to the builder with a new line afterwards.

      -

      Parameters

      • value: string

      Returns void

    clear

    • Clears all values from the StringBuilder.

      -

      Returns void

    toString

    • Returns a string representation of the StringBuilder.

      -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • value: string

    Returns void

    appendLine

    • Appends the value to the builder with a new line afterwards.

      +

      Parameters

      • value: string

      Returns void

    clear

    • Clears all values from the StringBuilder.

      +

      Returns void

    toString

    • Returns a string representation of the StringBuilder.

      +

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Logging.IConsoleLoggerConfig.html b/docs/api/interfaces/Logging.IConsoleLoggerConfig.html index 8bfecfe..4234c72 100644 --- a/docs/api/interfaces/Logging.IConsoleLoggerConfig.html +++ b/docs/api/interfaces/Logging.IConsoleLoggerConfig.html @@ -1,5 +1,5 @@ -IConsoleLoggerConfig | @michaelcoxon/utilities

    Interface IConsoleLoggerConfig

    Hierarchy

    Properties

    loggingVerbosity +IConsoleLoggerConfig | @michaelcoxon/utilities

    Interface IConsoleLoggerConfig

    Hierarchy

    Properties

    loggingVerbosity useTraceMethodForTraceLogLevel

    Properties

    loggingVerbosity

    loggingVerbosity: LogLevel

    the logging verbosity to filter on

    -

    useTraceMethodForTraceLogLevel

    useTraceMethodForTraceLogLevel: boolean

    some browsers support the 'console.trace' method. this method gives out more info on trace logs.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    useTraceMethodForTraceLogLevel

    useTraceMethodForTraceLogLevel: boolean

    some browsers support the 'console.trace' method. this method gives out more info on trace logs.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Logging.ILogger.html b/docs/api/interfaces/Logging.ILogger.html index 2e876e7..3af1798 100644 --- a/docs/api/interfaces/Logging.ILogger.html +++ b/docs/api/interfaces/Logging.ILogger.html @@ -1,5 +1,5 @@ ILogger | @michaelcoxon/utilities

    Interface ILogger

    ILogger interface for all logging implementations

    -

    Hierarchy

    • ILogger

    Implemented by

    Methods

    debug +

    Hierarchy

    • ILogger

    Implemented by

    Methods

    debug debugError error errorError @@ -11,22 +11,22 @@ warn warnError

    Methods

    debug

    • Log a message flagged at the Debug log level

      -

      Parameters

      • msg: string

      Returns void

    debugError

    • Log an error flagged at the Debug log level

      -

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Debug log level

      -

      Parameters

      • err: Error
      • msg: string

      Returns void

    error

    • Log a message flagged at the Error log level

      -

      Parameters

      • msg: string

      Returns void

    errorError

    • Log an error flagged at the Error log level

      -

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Error log level

      -

      Parameters

      • err: Error
      • msg: string

      Returns void

    info

    • Log a message flagged at the Informational log level

      -

      Parameters

      • msg: string

      Returns void

    infoError

    • Log an error flagged at the Informational log level

      -

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Informational log level

      -

      Parameters

      • err: Error
      • msg: string

      Returns void

    scope

    debugError

    • Log an error flagged at the Debug log level

      +

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Debug log level

      +

      Parameters

      • err: Error
      • msg: string

      Returns void

    error

    • Log a message flagged at the Error log level

      +

      Parameters

      • msg: string

      Returns void

    errorError

    • Log an error flagged at the Error log level

      +

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Error log level

      +

      Parameters

      • err: Error
      • msg: string

      Returns void

    info

    • Log a message flagged at the Informational log level

      +

      Parameters

      • msg: string

      Returns void

    infoError

    • Log an error flagged at the Informational log level

      +

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Informational log level

      +

      Parameters

      • err: Error
      • msg: string

      Returns void

    scope

    • Rescope the logger with the provided name. Used for tagging the logger.

      Parameters

      • name: string

        The tag the logger should be given

      Returns ILogger & IDisposable

      Example

      Use the scope tool inside a 'using' to scope logging to a specific method.
      return using(() => logger.scope("theNameOfMyScope"), logger =>
       {
           logger.debug("Log something here");
       });
      -

    trace

    • Log a message flagged at the Trace log level

      -

      Parameters

      • msg: string

      Returns void

    traceError

    • Log an error flagged at the Trace log level

      -

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Trace log level

      -

      Parameters

      • err: Error
      • msg: string

      Returns void

    warn

    • Log a message flagged at the Warning log level

      -

      Parameters

      • msg: string

      Returns void

    warnError

    • Log an error flagged at the Warning log level

      -

      Parameters

      • err: Error

      Returns void

    • Log an error and a message flagged at the Warning log level

      -

      Parameters

      • err: Error
      • msg: string

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    trace

    traceError

    warn

    warnError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Logging.ILoggerConfig.html b/docs/api/interfaces/Logging.ILoggerConfig.html index 096c257..2342dca 100644 --- a/docs/api/interfaces/Logging.ILoggerConfig.html +++ b/docs/api/interfaces/Logging.ILoggerConfig.html @@ -1,3 +1,3 @@ -ILoggerConfig | @michaelcoxon/utilities

    Interface ILoggerConfig

    Hierarchy

    Properties

    loggingVerbosity +ILoggerConfig | @michaelcoxon/utilities

    Interface ILoggerConfig

    Hierarchy

    Properties

    loggingVerbosity

    Properties

    loggingVerbosity

    loggingVerbosity: LogLevel

    the logging verbosity to filter on

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Numbers.INumberValue.html b/docs/api/interfaces/Numbers.INumberValue.html index d1af766..502d377 100644 --- a/docs/api/interfaces/Numbers.INumberValue.html +++ b/docs/api/interfaces/Numbers.INumberValue.html @@ -1,11 +1,11 @@ -INumberValue | @michaelcoxon/utilities

    Interface INumberValue

    Hierarchy

    • Number
      • INumberValue

    Implemented by

    Properties

    [toPrimitive] +INumberValue | @michaelcoxon/utilities

    Interface INumberValue

    Hierarchy

    • Number
      • INumberValue

    Implemented by

    Properties

    [toPrimitive]

    Methods

    toExponential toFixed toLocaleString toPrecision toString valueOf -

    Properties

    [toPrimitive]

    [toPrimitive]: ((hint) => number)

    Type declaration

      • (hint): number

      • Parameters

        • hint: string

        Returns number

    Methods

    toExponential

    • Returns a string containing a number represented in exponential notation.

      +

    Properties

    [toPrimitive]

    [toPrimitive]: ((hint) => number)

    Type declaration

      • (hint): number

      • Parameters

        • hint: string

        Returns number

    Methods

    toExponential

    • Returns a string containing a number represented in exponential notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

      Returns string

    toFixed

    • Returns a string representing a number in fixed-point notation.

      Parameters

      • Optional fractionDigits: number

        Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

        @@ -17,4 +17,4 @@
      • Optional options: NumberFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    toPrecision

    • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

      Parameters

      • Optional precision: number

        Number of significant digits. Must be in the range 1 - 21, inclusive.

        -

      Returns string

    toString

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    toString

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Pipeline.IContext.html b/docs/api/interfaces/Pipeline.IContext.html index f005cc4..bffed9e 100644 --- a/docs/api/interfaces/Pipeline.IContext.html +++ b/docs/api/interfaces/Pipeline.IContext.html @@ -1,2 +1,2 @@ -IContext | @michaelcoxon/utilities

    Interface IContext<T>

    Type Parameters

    • T = any

    Hierarchy

    • IContext

    Properties

    data -

    Properties

    Readonly data

    data: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IContext | @michaelcoxon/utilities

    Interface IContext<T>

    Type Parameters

    • T = any

    Hierarchy

    • IContext

    Properties

    data +

    Properties

    Readonly data

    data: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Pipeline.IPipelineTask.html b/docs/api/interfaces/Pipeline.IPipelineTask.html index dbf5014..c7f1d86 100644 --- a/docs/api/interfaces/Pipeline.IPipelineTask.html +++ b/docs/api/interfaces/Pipeline.IPipelineTask.html @@ -1,3 +1,3 @@ -IPipelineTask | @michaelcoxon/utilities

    Interface IPipelineTask

    Hierarchy

    • IPipelineTask

    Properties

    name +IPipelineTask | @michaelcoxon/utilities

    Interface IPipelineTask

    Hierarchy

    • IPipelineTask

    Properties

    name

    Methods

    executeAsync -

    Properties

    Readonly name

    name: string

    Methods

    executeAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly name

    name: string

    Methods

    executeAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Pipeline.IPipelineTaskQueue.html b/docs/api/interfaces/Pipeline.IPipelineTaskQueue.html index a063e03..3a3eb31 100644 --- a/docs/api/interfaces/Pipeline.IPipelineTaskQueue.html +++ b/docs/api/interfaces/Pipeline.IPipelineTaskQueue.html @@ -1,2 +1,2 @@ -IPipelineTaskQueue | @michaelcoxon/utilities

    Interface IPipelineTaskQueue

    Hierarchy

    • IPipelineTaskQueue

    Implemented by

    Methods

    then -

    Methods

    then

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IPipelineTaskQueue | @michaelcoxon/utilities

    Interface IPipelineTaskQueue

    Hierarchy

    • IPipelineTaskQueue

    Implemented by

    Methods

    then +

    Methods

    then

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Result.IResult.html b/docs/api/interfaces/Result.IResult.html index ed19260..5ac28c9 100644 --- a/docs/api/interfaces/Result.IResult.html +++ b/docs/api/interfaces/Result.IResult.html @@ -1,5 +1,5 @@ -IResult | @michaelcoxon/utilities

    Interface IResult<T, TPreviousResult>

    Type Parameters

    Hierarchy

    Implemented by

    Properties

    error? +IResult | @michaelcoxon/utilities

    Interface IResult<T, TPreviousResult>

    Type Parameters

    Hierarchy

    Implemented by

    Properties

    error? previousResult? success value? -

    Properties

    Optional Readonly error

    error?: string

    Optional Readonly previousResult

    previousResult?: TPreviousResult

    Readonly success

    success: boolean

    Optional Readonly value

    value?: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly error

    error?: string

    Optional Readonly previousResult

    previousResult?: TPreviousResult

    Readonly success

    success: boolean

    Optional Readonly value

    value?: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Result.IResultBase.html b/docs/api/interfaces/Result.IResultBase.html index 55e0892..df7d540 100644 --- a/docs/api/interfaces/Result.IResultBase.html +++ b/docs/api/interfaces/Result.IResultBase.html @@ -1,4 +1,4 @@ -IResultBase | @michaelcoxon/utilities

    Interface IResultBase<TPreviousResult>

    Type Parameters

    Hierarchy

    Properties

    error? +IResultBase | @michaelcoxon/utilities

    Interface IResultBase<TPreviousResult>

    Type Parameters

    Hierarchy

    Properties

    error? previousResult? success -

    Properties

    Optional Readonly error

    error?: string

    Optional Readonly previousResult

    previousResult?: TPreviousResult

    Readonly success

    success: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly error

    error?: string

    Optional Readonly previousResult

    previousResult?: TPreviousResult

    Readonly success

    success: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Storage.IStorageRepository.html b/docs/api/interfaces/Storage.IStorageRepository.html index d9d1d94..1b18825 100644 --- a/docs/api/interfaces/Storage.IStorageRepository.html +++ b/docs/api/interfaces/Storage.IStorageRepository.html @@ -1,4 +1,4 @@ -IStorageRepository | @michaelcoxon/utilities

    Interface IStorageRepository<TKey, T>

    Type Parameters

    • TKey

    • T

    Hierarchy

    • IStorageRepository

    Implemented by

    Methods

    deleteAsync +IStorageRepository | @michaelcoxon/utilities

    Interface IStorageRepository<TKey, T>

    Type Parameters

    • TKey

    • T

    Hierarchy

    • IStorageRepository

    Implemented by

    Methods

    deleteAsync getAsync setAsync -

    Methods

    deleteAsync

    getAsync

    setAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    deleteAsync

    getAsync

    setAsync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/interfaces/Type.IType.html b/docs/api/interfaces/Type.IType.html index c05e7a4..26e2202 100644 --- a/docs/api/interfaces/Type.IType.html +++ b/docs/api/interfaces/Type.IType.html @@ -1,7 +1,7 @@ -IType | @michaelcoxon/utilities

    Interface IType

    Hierarchy

    • IType

    Properties

    baseType +IType | @michaelcoxon/utilities

    Interface IType

    Hierarchy

    • IType

    Properties

    baseType fullName isArray name namespace

    Methods

    factory -

    Properties

    Readonly baseType

    baseType: IType

    Readonly fullName

    fullName: string

    Readonly isArray

    isArray: boolean

    Readonly name

    name: string

    Readonly namespace

    namespace: string

    Methods

    factory

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly baseType

    baseType: IType

    Readonly fullName

    fullName: string

    Readonly isArray

    isArray: boolean

    Readonly name

    name: string

    Readonly namespace

    namespace: string

    Methods

    factory

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/modules/Arrays.html b/docs/api/modules/Arrays.html index 9c3f2f1..41a773b 100644 --- a/docs/api/modules/Arrays.html +++ b/docs/api/modules/Arrays.html @@ -1,4 +1,4 @@ -Arrays | @michaelcoxon/utilities

    Namespace Arrays

    Index

    Functions

    all +Arrays | @michaelcoxon/utilities

    Namespace Arrays

    Index

    Functions

    all any average contains diff --git a/docs/api/modules/Assertions.html b/docs/api/modules/Assertions.html index ded1ad3..c40c1ff 100644 --- a/docs/api/modules/Assertions.html +++ b/docs/api/modules/Assertions.html @@ -1,4 +1,4 @@ -Assertions | @michaelcoxon/utilities

    Namespace Assertions

    Index

    Classes

    ArgumentAssertionBuilder +Assertions | @michaelcoxon/utilities

    Namespace Assertions

    Index

    Classes

    ArgumentAssertionBuilder ArrayLikeArgumentAssertionBuilder CompareAssertionBuilder GuidArgumentAssertionBuilder diff --git a/docs/api/modules/Booleans.html b/docs/api/modules/Booleans.html index a487a59..5be91fd 100644 --- a/docs/api/modules/Booleans.html +++ b/docs/api/modules/Booleans.html @@ -1,4 +1,4 @@ -Booleans | @michaelcoxon/utilities

    Namespace Booleans

    Index

    Variables

    _caseInsensitiveFalseString +Booleans | @michaelcoxon/utilities

    Namespace Booleans

    Index

    Variables

    _caseInsensitiveFalseString _caseInsensitiveTrueString falseString trueString diff --git a/docs/api/modules/Cache.expire.html b/docs/api/modules/Cache.expire.html index 9b626ec..adcee1a 100644 --- a/docs/api/modules/Cache.expire.html +++ b/docs/api/modules/Cache.expire.html @@ -1,4 +1,4 @@ -expire | @michaelcoxon/utilities

    Namespace expire

    Index

    Variables

    at +expire | @michaelcoxon/utilities

    Namespace expire

    Index

    Variables

    at in inDays inHours diff --git a/docs/api/modules/Cache.html b/docs/api/modules/Cache.html index 7c0e88a..7a07042 100644 --- a/docs/api/modules/Cache.html +++ b/docs/api/modules/Cache.html @@ -1,4 +1,4 @@ -Cache | @michaelcoxon/utilities

    Namespace Cache

    Index

    Namespaces

    expire +Cache | @michaelcoxon/utilities

    Namespace Cache

    Index

    Namespaces

    expire

    Classes

    AsyncCacheItem CacheExpiredException MemoryCache diff --git a/docs/api/modules/Comparers.html b/docs/api/modules/Comparers.html index 1531e58..a5dd411 100644 --- a/docs/api/modules/Comparers.html +++ b/docs/api/modules/Comparers.html @@ -1,4 +1,4 @@ -Comparers | @michaelcoxon/utilities

    Namespace Comparers

    Index

    Classes

    CaseInsensitiveStringComparer +Comparers | @michaelcoxon/utilities

    Namespace Comparers

    Index

    Classes

    CaseInsensitiveStringComparer CustomComparer MapComparer ReverseComparer diff --git a/docs/api/modules/Configuration.html b/docs/api/modules/Configuration.html index 8ad7887..7f5c1a2 100644 --- a/docs/api/modules/Configuration.html +++ b/docs/api/modules/Configuration.html @@ -1,4 +1,4 @@ -Configuration | @michaelcoxon/utilities

    Namespace Configuration

    Index

    Classes

    JsonConfigurationBuilder +Configuration | @michaelcoxon/utilities

    Namespace Configuration

    Index

    Classes

    JsonConfigurationBuilder

    Interfaces

    IConfiguration IConfigurationBuilder IConfigurationSection diff --git a/docs/api/modules/Enumerables.html b/docs/api/modules/Enumerables.html index 9cbc0c8..1f5cdd9 100644 --- a/docs/api/modules/Enumerables.html +++ b/docs/api/modules/Enumerables.html @@ -1,4 +1,4 @@ -Enumerables | @michaelcoxon/utilities

    Namespace Enumerables

    Index

    Classes

    ArrayEnumerable +Enumerables | @michaelcoxon/utilities

    Namespace Enumerables

    Index

    Classes

    ArrayEnumerable Collection Dictionary Enumerable diff --git a/docs/api/modules/Enumerators.html b/docs/api/modules/Enumerators.html index 0c69229..ed364ce 100644 --- a/docs/api/modules/Enumerators.html +++ b/docs/api/modules/Enumerators.html @@ -1,4 +1,4 @@ -Enumerators | @michaelcoxon/utilities

    Namespace Enumerators

    Index

    Classes

    AggregateEnumerator +Enumerators | @michaelcoxon/utilities

    Namespace Enumerators

    Index

    Classes

    AggregateEnumerator AppendEnumerator ArrayEnumerator AsyncEnumerator diff --git a/docs/api/modules/Events.html b/docs/api/modules/Events.html index 42de28d..92c3866 100644 --- a/docs/api/modules/Events.html +++ b/docs/api/modules/Events.html @@ -1,4 +1,4 @@ -Events | @michaelcoxon/utilities

    Namespace Events

    Index

    Classes

    Event +Events | @michaelcoxon/utilities

    Namespace Events

    Index

    Classes

    Event SingleInvokeEvent

    Interfaces

    IEvent

    Type Aliases

    EventHandler diff --git a/docs/api/modules/Exceptions.html b/docs/api/modules/Exceptions.html index bb023ec..617cf4c 100644 --- a/docs/api/modules/Exceptions.html +++ b/docs/api/modules/Exceptions.html @@ -1,4 +1,4 @@ -Exceptions | @michaelcoxon/utilities

    Namespace Exceptions

    Index

    Classes

    AlreadyDisposedException +Exceptions | @michaelcoxon/utilities

    Namespace Exceptions

    Index

    Classes

    AlreadyDisposedException ArgumentException ArgumentNullException ArgumentUndefinedException diff --git a/docs/api/modules/Formatters.html b/docs/api/modules/Formatters.html index 0498cad..81b1809 100644 --- a/docs/api/modules/Formatters.html +++ b/docs/api/modules/Formatters.html @@ -1,4 +1,4 @@ -Formatters | @michaelcoxon/utilities

    Namespace Formatters

    Index

    Classes

    DateFormatter +Formatters | @michaelcoxon/utilities

    Namespace Formatters

    Index

    Classes

    DateFormatter NumberFormatter NumberFormatterDelegates StringFormatter diff --git a/docs/api/modules/IO.html b/docs/api/modules/IO.html index 62862f7..97e3851 100644 --- a/docs/api/modules/IO.html +++ b/docs/api/modules/IO.html @@ -1,4 +1,4 @@ -IO | @michaelcoxon/utilities

    Namespace IO

    Index

    Classes

    IndentedStringBuilder +IO | @michaelcoxon/utilities

    Namespace IO

    Index

    Classes

    IndentedStringBuilder StringBuilder

    Interfaces

    IIndentedStringBuilder IStringBuilder diff --git a/docs/api/modules/Logging.html b/docs/api/modules/Logging.html index 013ce55..7b15185 100644 --- a/docs/api/modules/Logging.html +++ b/docs/api/modules/Logging.html @@ -1,4 +1,4 @@ -Logging | @michaelcoxon/utilities

    Namespace Logging

    Index

    Enumerations

    LogLevel +Logging | @michaelcoxon/utilities

    Namespace Logging

    Index

    Enumerations

    LogLevel

    Classes

    AggregateLogger ConsoleLogger Logger diff --git a/docs/api/modules/ModelState.html b/docs/api/modules/ModelState.html index 1c8e14d..c668486 100644 --- a/docs/api/modules/ModelState.html +++ b/docs/api/modules/ModelState.html @@ -1,4 +1,4 @@ -ModelState | @michaelcoxon/utilities

    Namespace ModelState

    Index

    Classes

    BaseModelState +ModelState | @michaelcoxon/utilities

    Namespace ModelState

    Index

    Classes

    BaseModelState FactoryModelState ModelState PollingModelState diff --git a/docs/api/modules/Numbers.html b/docs/api/modules/Numbers.html index 27ce910..2e3c821 100644 --- a/docs/api/modules/Numbers.html +++ b/docs/api/modules/Numbers.html @@ -1,4 +1,4 @@ -Numbers | @michaelcoxon/utilities

    Namespace Numbers

    Index

    Classes

    Byte +Numbers | @michaelcoxon/utilities

    Namespace Numbers

    Index

    Classes

    Byte Int16 Int32 SignedByte diff --git a/docs/api/modules/Pipeline.html b/docs/api/modules/Pipeline.html index 3211b04..dd382ac 100644 --- a/docs/api/modules/Pipeline.html +++ b/docs/api/modules/Pipeline.html @@ -1,4 +1,4 @@ -Pipeline | @michaelcoxon/utilities

    Namespace Pipeline

    Index

    Classes

    Pipeline +Pipeline | @michaelcoxon/utilities

    Namespace Pipeline

    Index

    Classes

    Pipeline

    Interfaces

    IContext IPipelineTask IPipelineTaskQueue diff --git a/docs/api/modules/Promises.html b/docs/api/modules/Promises.html index 792c0ac..de136e8 100644 --- a/docs/api/modules/Promises.html +++ b/docs/api/modules/Promises.html @@ -1,4 +1,4 @@ -Promises | @michaelcoxon/utilities

    Namespace Promises

    Index

    Classes

    AsyncWrapper +Promises | @michaelcoxon/utilities

    Namespace Promises

    Index

    Classes

    AsyncWrapper CancellablePromise CancellationToken CancellationTokenSource diff --git a/docs/api/modules/Result.html b/docs/api/modules/Result.html index 0700ce6..e790be4 100644 --- a/docs/api/modules/Result.html +++ b/docs/api/modules/Result.html @@ -1,4 +1,4 @@ -Result | @michaelcoxon/utilities

    Namespace Result

    Index

    Classes

    Result +Result | @michaelcoxon/utilities

    Namespace Result

    Index

    Classes

    Result

    Interfaces

    IResult IResultBase

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/modules/Storage.html b/docs/api/modules/Storage.html index f2024c6..b568203 100644 --- a/docs/api/modules/Storage.html +++ b/docs/api/modules/Storage.html @@ -1,3 +1,3 @@ -Storage | @michaelcoxon/utilities

    Namespace Storage

    Index

    Classes

    StorageRepository +Storage | @michaelcoxon/utilities

    Namespace Storage

    Index

    Classes

    StorageRepository

    Interfaces

    IStorageRepository

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/modules/Strings.html b/docs/api/modules/Strings.html index b6f60ca..7376af5 100644 --- a/docs/api/modules/Strings.html +++ b/docs/api/modules/Strings.html @@ -1,4 +1,4 @@ -Strings | @michaelcoxon/utilities

    Namespace Strings

    Index

    Variables

    ESCAPE_REGEX_SEARCH +Strings | @michaelcoxon/utilities

    Namespace Strings

    Index

    Variables

    ESCAPE_REGEX_SEARCH FORMAT_REGEX KEY_VALUE_SEPARATOR KEY_WORD_SEPARATOR diff --git a/docs/api/modules/Type.html b/docs/api/modules/Type.html index df7931f..7e06f4a 100644 --- a/docs/api/modules/Type.html +++ b/docs/api/modules/Type.html @@ -1,4 +1,4 @@ -Type | @michaelcoxon/utilities

    Namespace Type

    Index

    Classes

    Type +Type | @michaelcoxon/utilities

    Namespace Type

    Index

    Classes

    Type TypeBuilder

    Interfaces

    IType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Action.html b/docs/api/types/Action.html index 01806a4..52ce968 100644 --- a/docs/api/types/Action.html +++ b/docs/api/types/Action.html @@ -1,2 +1,2 @@ Action | @michaelcoxon/utilities

    Type alias Action<T>

    Action<T>: (() => T)

    Type Parameters

    • T

    Type declaration

      • (): T

      • Shortcut for () => T

        -

        Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/AnyFunction.html b/docs/api/types/AnyFunction.html index dbe3b32..84cb68d 100644 --- a/docs/api/types/AnyFunction.html +++ b/docs/api/types/AnyFunction.html @@ -1,2 +1,2 @@ AnyFunction | @michaelcoxon/utilities

    Type alias AnyFunction

    AnyFunction: ((...args) => any)

    Type declaration

      • (...args): any

      • Represents any function

        -

        Parameters

        • Rest ...args: any[]

        Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Rest ...args: any[]

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Awaitable.html b/docs/api/types/Awaitable.html index 486d0e7..e218ce4 100644 --- a/docs/api/types/Awaitable.html +++ b/docs/api/types/Awaitable.html @@ -1,2 +1,2 @@ Awaitable | @michaelcoxon/utilities

    Type alias Awaitable<T>

    Awaitable<T>: T | PromiseLike<T>

    Shortcut for T | Promise

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Cache.IExpiryPolicyDelegate.html b/docs/api/types/Cache.IExpiryPolicyDelegate.html index 8039bb7..5972c2d 100644 --- a/docs/api/types/Cache.IExpiryPolicyDelegate.html +++ b/docs/api/types/Cache.IExpiryPolicyDelegate.html @@ -1,3 +1,3 @@ IExpiryPolicyDelegate | @michaelcoxon/utilities

    Type alias IExpiryPolicyDelegate<T, TAsyncCacheItem>

    IExpiryPolicyDelegate<T, TAsyncCacheItem>: ((value) => boolean)

    Type Parameters

    Type declaration

      • (value): boolean

      • A function that returns true if the value is expired.

        Parameters

        • value: TAsyncCacheItem

        Returns boolean

        Argument

        value the value to evaluate.

        -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Comparison.html b/docs/api/types/Comparison.html index a6e270f..02f57ed 100644 --- a/docs/api/types/Comparison.html +++ b/docs/api/types/Comparison.html @@ -1,2 +1,2 @@ Comparison | @michaelcoxon/utilities

    Type alias Comparison<T>

    Comparison<T>: ((a, y) => number)

    Type Parameters

    • T

    Type declaration

      • (a, y): number

      • Represents a comparision between two items of the same type. Should return 0 if they are the same, >0 if a > b, <0 if a < b.

        -

        Parameters

        • a: T
        • y: T

        Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • a: T
    • y: T

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Configuration.ConfigValue.html b/docs/api/types/Configuration.ConfigValue.html index d845595..bd081ad 100644 --- a/docs/api/types/Configuration.ConfigValue.html +++ b/docs/api/types/Configuration.ConfigValue.html @@ -1 +1 @@ -ConfigValue | @michaelcoxon/utilities

    Type alias ConfigValue

    ConfigValue: any[] | Record<string, any> | string | number | boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigValue | @michaelcoxon/utilities

    Type alias ConfigValue

    ConfigValue: any[] | Record<string, any> | string | number | boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/ConstructorFor.html b/docs/api/types/ConstructorFor.html index 69d41f3..ad8a751 100644 --- a/docs/api/types/ConstructorFor.html +++ b/docs/api/types/ConstructorFor.html @@ -1,2 +1,2 @@ ConstructorFor | @michaelcoxon/utilities

    Type alias ConstructorFor<T>

    ConstructorFor<T>: (new (...args) => T)

    Type Parameters

    • T

    Type declaration

      • new (...args): T

      • Helper type for representing constructors

        -

        Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Rest ...args: any[]

    Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Enumerables.IEnumerableOrArray.html b/docs/api/types/Enumerables.IEnumerableOrArray.html index 3fa06da..6a0cea7 100644 --- a/docs/api/types/Enumerables.IEnumerableOrArray.html +++ b/docs/api/types/Enumerables.IEnumerableOrArray.html @@ -1,2 +1,2 @@ IEnumerableOrArray | @michaelcoxon/utilities

    Type alias IEnumerableOrArray<T>

    IEnumerableOrArray<T>: T[] | IEnumerable<T>

    A type that is either an array or an enumerable

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Events.EventHandler.html b/docs/api/types/Events.EventHandler.html index 8b240a6..7ddc763 100644 --- a/docs/api/types/Events.EventHandler.html +++ b/docs/api/types/Events.EventHandler.html @@ -1,2 +1,2 @@ EventHandler | @michaelcoxon/utilities

    Type alias EventHandler<TEventArgs>

    EventHandler<TEventArgs>: ((sender, args) => void)

    Type Parameters

    • TEventArgs

    Type declaration

      • (sender, args): void

      • The event handler type

        -

        Parameters

        • sender: any
        • args: TEventArgs

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • sender: any
    • args: TEventArgs

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func1.html b/docs/api/types/Func1.html index 72b48eb..2eec1d9 100644 --- a/docs/api/types/Func1.html +++ b/docs/api/types/Func1.html @@ -1,2 +1,2 @@ Func1 | @michaelcoxon/utilities

    Type alias Func1<Tin, Tout>

    Func1<Tin, Tout>: ((arg1) => Tout)

    Type Parameters

    • Tin

    • Tout

    Type declaration

      • (arg1): Tout

      • Shortcut for (arg1: Tin) => Tout

        -

        Parameters

        • arg1: Tin

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func2.html b/docs/api/types/Func2.html index a94998a..8ab21f7 100644 --- a/docs/api/types/Func2.html +++ b/docs/api/types/Func2.html @@ -1,2 +1,2 @@ Func2 | @michaelcoxon/utilities

    Type alias Func2<Tin1, Tin2, Tout>

    Func2<Tin1, Tin2, Tout>: ((arg1, arg2) => Tout)

    Type Parameters

    • Tin1

    • Tin2

    • Tout

    Type declaration

      • (arg1, arg2): Tout

      • Shortcut for (arg1: Tin1, arg2: Tin2) => Tout

        -

        Parameters

        • arg1: Tin1
        • arg2: Tin2

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin1
    • arg2: Tin2

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func3.html b/docs/api/types/Func3.html index 1975cbc..43e54c5 100644 --- a/docs/api/types/Func3.html +++ b/docs/api/types/Func3.html @@ -1,2 +1,2 @@ Func3 | @michaelcoxon/utilities

    Type alias Func3<Tin1, Tin2, Tin3, Tout>

    Func3<Tin1, Tin2, Tin3, Tout>: ((arg1, arg2, arg3) => Tout)

    Type Parameters

    • Tin1

    • Tin2

    • Tin3

    • Tout

    Type declaration

      • (arg1, arg2, arg3): Tout

      • Shortcut for (arg1: Tin1, arg2: Tin2, arg3: Tin3) => Tout

        -

        Parameters

        • arg1: Tin1
        • arg2: Tin2
        • arg3: Tin3

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin1
    • arg2: Tin2
    • arg3: Tin3

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func4.html b/docs/api/types/Func4.html index e07a8db..288b31a 100644 --- a/docs/api/types/Func4.html +++ b/docs/api/types/Func4.html @@ -1,2 +1,2 @@ Func4 | @michaelcoxon/utilities

    Type alias Func4<Tin1, Tin2, Tin3, Tin4, Tout>

    Func4<Tin1, Tin2, Tin3, Tin4, Tout>: ((arg1, arg2, arg3, arg4) => Tout)

    Type Parameters

    • Tin1

    • Tin2

    • Tin3

    • Tin4

    • Tout

    Type declaration

      • (arg1, arg2, arg3, arg4): Tout

      • Shortcut for (arg1: Tin1, arg2: Tin2, arg3: Tin3, arg4: Tin4) => Tout

        -

        Parameters

        • arg1: Tin1
        • arg2: Tin2
        • arg3: Tin3
        • arg4: Tin4

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin1
    • arg2: Tin2
    • arg3: Tin3
    • arg4: Tin4

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func5.html b/docs/api/types/Func5.html index 97676d6..8d5a009 100644 --- a/docs/api/types/Func5.html +++ b/docs/api/types/Func5.html @@ -1,2 +1,2 @@ Func5 | @michaelcoxon/utilities

    Type alias Func5<Tin1, Tin2, Tin3, Tin4, Tin5, Tout>

    Func5<Tin1, Tin2, Tin3, Tin4, Tin5, Tout>: ((arg1, arg2, arg3, arg4, arg5) => Tout)

    Type Parameters

    • Tin1

    • Tin2

    • Tin3

    • Tin4

    • Tin5

    • Tout

    Type declaration

      • (arg1, arg2, arg3, arg4, arg5): Tout

      • Shortcut for (arg1: Tin1, arg2: Tin2, arg3: Tin3, arg4: Tin4, arg5: Tin5) => Tout

        -

        Parameters

        • arg1: Tin1
        • arg2: Tin2
        • arg3: Tin3
        • arg4: Tin4
        • arg5: Tin5

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin1
    • arg2: Tin2
    • arg3: Tin3
    • arg4: Tin4
    • arg5: Tin5

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Func6.html b/docs/api/types/Func6.html index 5959c49..d58c2cb 100644 --- a/docs/api/types/Func6.html +++ b/docs/api/types/Func6.html @@ -1,2 +1,2 @@ Func6 | @michaelcoxon/utilities

    Type alias Func6<Tin1, Tin2, Tin3, Tin4, Tin5, Tin6, Tout>

    Func6<Tin1, Tin2, Tin3, Tin4, Tin5, Tin6, Tout>: ((arg1, arg2, arg3, arg4, arg5, arg6) => Tout)

    Type Parameters

    • Tin1

    • Tin2

    • Tin3

    • Tin4

    • Tin5

    • Tin6

    • Tout

    Type declaration

      • (arg1, arg2, arg3, arg4, arg5, arg6): Tout

      • Shortcut for (arg1: Tin1, arg2: Tin2, arg3: Tin3, arg4: Tin4, arg5: Tin5, arg6: Tin6) => Tout

        -

        Parameters

        • arg1: Tin1
        • arg2: Tin2
        • arg3: Tin3
        • arg4: Tin4
        • arg5: Tin5
        • arg6: Tin6

        Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • arg1: Tin1
    • arg2: Tin2
    • arg3: Tin3
    • arg4: Tin4
    • arg5: Tin5
    • arg6: Tin6

    Returns Tout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/KeySelector.html b/docs/api/types/KeySelector.html index 5b17ee3..bf70322 100644 --- a/docs/api/types/KeySelector.html +++ b/docs/api/types/KeySelector.html @@ -1,2 +1,2 @@ KeySelector | @michaelcoxon/utilities

    Type alias KeySelector<T, K>

    KeySelector<T, K>: ((propertyName) => T[K])

    Type Parameters

    • T

    • K extends keyof T

    Type declaration

      • (propertyName): T[K]

      • A function that returns the value of the key

        -

        Parameters

        • propertyName: K

        Returns T[K]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • propertyName: K

    Returns T[K]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/KeyValuePair.html b/docs/api/types/KeyValuePair.html index 8105edc..5b61880 100644 --- a/docs/api/types/KeyValuePair.html +++ b/docs/api/types/KeyValuePair.html @@ -1,2 +1,2 @@ KeyValuePair | @michaelcoxon/utilities

    Type alias KeyValuePair<TKey, TValue>

    KeyValuePair<TKey, TValue>: {
        key: TKey;
        value: TValue;
    }

    A key and value pair

    -

    Type Parameters

    • TKey

    • TValue

    Type declaration

    • Readonly key: TKey
    • Readonly value: TValue

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TKey

    • TValue

    Type declaration

    • Readonly key: TKey
    • Readonly value: TValue

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Nullable.html b/docs/api/types/Nullable.html index 8152a55..43cb93a 100644 --- a/docs/api/types/Nullable.html +++ b/docs/api/types/Nullable.html @@ -1,2 +1,2 @@ Nullable | @michaelcoxon/utilities

    Type alias Nullable<T>

    Nullable<T>: T | null

    Shortcut for T | null

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Predicate.html b/docs/api/types/Predicate.html index adbf7b5..5eff410 100644 --- a/docs/api/types/Predicate.html +++ b/docs/api/types/Predicate.html @@ -1,2 +1,2 @@ Predicate | @michaelcoxon/utilities

    Type alias Predicate<T>

    Predicate<T>: ((item) => boolean)

    Type Parameters

    • T

    Type declaration

      • (item): boolean

      • Takes an item and return a boolean value from an assertion on the item

        -

        Parameters

        • item: T

        Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • item: T

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/QueryStringItem.html b/docs/api/types/QueryStringItem.html index f822f42..f523057 100644 --- a/docs/api/types/QueryStringItem.html +++ b/docs/api/types/QueryStringItem.html @@ -1,2 +1,2 @@ QueryStringItem | @michaelcoxon/utilities

    Type alias QueryStringItem

    QueryStringItem: {
        name: string;
        value: string | number | boolean;
    }

    Element in a QueryStringCollection

    -

    Type declaration

    • name: string
    • value: string | number | boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • name: string
    • value: string | number | boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Selector.html b/docs/api/types/Selector.html index 4baa599..13785c3 100644 --- a/docs/api/types/Selector.html +++ b/docs/api/types/Selector.html @@ -1,2 +1,2 @@ Selector | @michaelcoxon/utilities

    Type alias Selector<T, TReturn>

    Selector<T, TReturn>: ((item) => TReturn)

    Type Parameters

    • T

    • TReturn

    Type declaration

      • (item): TReturn

      • Takes an item and maps it to TReturn

        -

        Parameters

        • item: T

        Returns TReturn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • item: T

    Returns TReturn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/types/Undefinable.html b/docs/api/types/Undefinable.html index 4fc1fea..2b0fe06 100644 --- a/docs/api/types/Undefinable.html +++ b/docs/api/types/Undefinable.html @@ -1,2 +1,2 @@ Undefinable | @michaelcoxon/utilities

    Type alias Undefinable<T>

    Undefinable<T>: T | undefined

    Shortcut for T | undefined

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Booleans._caseInsensitiveFalseString.html b/docs/api/variables/Booleans._caseInsensitiveFalseString.html index 44e5e54..db28720 100644 --- a/docs/api/variables/Booleans._caseInsensitiveFalseString.html +++ b/docs/api/variables/Booleans._caseInsensitiveFalseString.html @@ -1 +1 @@ -_caseInsensitiveFalseString | @michaelcoxon/utilities

    Variable _caseInsensitiveFalseStringConst

    _caseInsensitiveFalseString: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +_caseInsensitiveFalseString | @michaelcoxon/utilities

    Variable _caseInsensitiveFalseStringConst

    _caseInsensitiveFalseString: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Booleans._caseInsensitiveTrueString.html b/docs/api/variables/Booleans._caseInsensitiveTrueString.html index 7ff1149..36a899c 100644 --- a/docs/api/variables/Booleans._caseInsensitiveTrueString.html +++ b/docs/api/variables/Booleans._caseInsensitiveTrueString.html @@ -1 +1 @@ -_caseInsensitiveTrueString | @michaelcoxon/utilities

    Variable _caseInsensitiveTrueStringConst

    _caseInsensitiveTrueString: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +_caseInsensitiveTrueString | @michaelcoxon/utilities

    Variable _caseInsensitiveTrueStringConst

    _caseInsensitiveTrueString: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Booleans.falseString.html b/docs/api/variables/Booleans.falseString.html index 03b8cef..b4eb655 100644 --- a/docs/api/variables/Booleans.falseString.html +++ b/docs/api/variables/Booleans.falseString.html @@ -1 +1 @@ -falseString | @michaelcoxon/utilities

    Variable falseStringConst

    falseString: string = FALSE_STRING

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +falseString | @michaelcoxon/utilities

    Variable falseStringConst

    falseString: string = FALSE_STRING

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Booleans.trueString.html b/docs/api/variables/Booleans.trueString.html index 853953b..e869696 100644 --- a/docs/api/variables/Booleans.trueString.html +++ b/docs/api/variables/Booleans.trueString.html @@ -1 +1 @@ -trueString | @michaelcoxon/utilities

    Variable trueStringConst

    trueString: string = TRUE_STRING

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +trueString | @michaelcoxon/utilities

    Variable trueStringConst

    trueString: string = TRUE_STRING

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.at.html b/docs/api/variables/Cache.expire.at.html index e4d6b5d..5f34fac 100644 --- a/docs/api/variables/Cache.expire.at.html +++ b/docs/api/variables/Cache.expire.at.html @@ -1 +1 @@ -at | @michaelcoxon/utilities

    Variable at

    at: ((date) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +at | @michaelcoxon/utilities

    Variable at

    at: ((date) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.in.html b/docs/api/variables/Cache.expire.in.html index 98945ef..86667df 100644 --- a/docs/api/variables/Cache.expire.in.html +++ b/docs/api/variables/Cache.expire.in.html @@ -1 +1 @@ -in | @michaelcoxon/utilities

    Variable in

    in: ((time) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +in | @michaelcoxon/utilities

    Variable in

    in: ((time) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inDays.html b/docs/api/variables/Cache.expire.inDays.html index d6c6f3a..b12c3ee 100644 --- a/docs/api/variables/Cache.expire.inDays.html +++ b/docs/api/variables/Cache.expire.inDays.html @@ -1 +1 @@ -inDays | @michaelcoxon/utilities

    Variable inDays

    inDays: ((days) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inDays | @michaelcoxon/utilities

    Variable inDays

    inDays: ((days) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inHours.html b/docs/api/variables/Cache.expire.inHours.html index 6d58a85..cecd402 100644 --- a/docs/api/variables/Cache.expire.inHours.html +++ b/docs/api/variables/Cache.expire.inHours.html @@ -1 +1 @@ -inHours | @michaelcoxon/utilities

    Variable inHours

    inHours: ((hours) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inHours | @michaelcoxon/utilities

    Variable inHours

    inHours: ((hours) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inMinutes.html b/docs/api/variables/Cache.expire.inMinutes.html index b9d9f64..aa7ca09 100644 --- a/docs/api/variables/Cache.expire.inMinutes.html +++ b/docs/api/variables/Cache.expire.inMinutes.html @@ -1 +1 @@ -inMinutes | @michaelcoxon/utilities

    Variable inMinutes

    inMinutes: ((minutes) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inMinutes | @michaelcoxon/utilities

    Variable inMinutes

    inMinutes: ((minutes) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inMonths.html b/docs/api/variables/Cache.expire.inMonths.html index 4d223eb..8758760 100644 --- a/docs/api/variables/Cache.expire.inMonths.html +++ b/docs/api/variables/Cache.expire.inMonths.html @@ -1 +1 @@ -inMonths | @michaelcoxon/utilities

    Variable inMonths

    inMonths: ((months) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inMonths | @michaelcoxon/utilities

    Variable inMonths

    inMonths: ((months) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inSeconds.html b/docs/api/variables/Cache.expire.inSeconds.html index 743c68c..306126d 100644 --- a/docs/api/variables/Cache.expire.inSeconds.html +++ b/docs/api/variables/Cache.expire.inSeconds.html @@ -1 +1 @@ -inSeconds | @michaelcoxon/utilities

    Variable inSeconds

    inSeconds: ((seconds) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inSeconds | @michaelcoxon/utilities

    Variable inSeconds

    inSeconds: ((seconds) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.inYears.html b/docs/api/variables/Cache.expire.inYears.html index e31672e..47a3f04 100644 --- a/docs/api/variables/Cache.expire.inYears.html +++ b/docs/api/variables/Cache.expire.inYears.html @@ -1 +1 @@ -inYears | @michaelcoxon/utilities

    Variable inYears

    inYears: ((years) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +inYears | @michaelcoxon/utilities

    Variable inYears

    inYears: ((years) => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.now.html b/docs/api/variables/Cache.expire.now.html index 83135e8..542d282 100644 --- a/docs/api/variables/Cache.expire.now.html +++ b/docs/api/variables/Cache.expire.now.html @@ -1 +1 @@ -now | @michaelcoxon/utilities

    Variable now

    now: (() => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +now | @michaelcoxon/utilities

    Variable now

    now: (() => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.tomorrow.html b/docs/api/variables/Cache.expire.tomorrow.html index 820558a..3071e86 100644 --- a/docs/api/variables/Cache.expire.tomorrow.html +++ b/docs/api/variables/Cache.expire.tomorrow.html @@ -1 +1 @@ -tomorrow | @michaelcoxon/utilities

    Variable tomorrow

    tomorrow: (() => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +tomorrow | @michaelcoxon/utilities

    Variable tomorrow

    tomorrow: (() => IExpiryPolicyDelegate<unknown, IAsyncCacheItem<unknown>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Cache.expire.when.html b/docs/api/variables/Cache.expire.when.html index ac9ce85..662dccc 100644 --- a/docs/api/variables/Cache.expire.when.html +++ b/docs/api/variables/Cache.expire.when.html @@ -1 +1 @@ -when | @michaelcoxon/utilities

    Variable when

    when: (<T>(predicate) => IExpiryPolicyDelegate<T, IAsyncCacheItem<T>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +when | @michaelcoxon/utilities

    Variable when

    when: (<T>(predicate) => IExpiryPolicyDelegate<T, IAsyncCacheItem<T>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Comparers.DefaultComparers.html b/docs/api/variables/Comparers.DefaultComparers.html index 54df78a..2885e16 100644 --- a/docs/api/variables/Comparers.DefaultComparers.html +++ b/docs/api/variables/Comparers.DefaultComparers.html @@ -1 +1 @@ -DefaultComparers | @michaelcoxon/utilities

    Variable DefaultComparersConst

    DefaultComparers: {
        DefaultComparer: DefaultComparer<any>;
        NumberComparer: default;
        ObjectComparer: default<any>;
        StringComparer: default;
    } = ...

    Type declaration

    • DefaultComparer: DefaultComparer<any>
    • NumberComparer: default
    • ObjectComparer: default<any>
    • StringComparer: default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DefaultComparers | @michaelcoxon/utilities

    Variable DefaultComparersConst

    DefaultComparers: {
        DefaultComparer: DefaultComparer<any>;
        NumberComparer: default;
        ObjectComparer: default<any>;
        StringComparer: default;
    } = ...

    Type declaration

    • DefaultComparer: DefaultComparer<any>
    • NumberComparer: default
    • ObjectComparer: default<any>
    • StringComparer: default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Logging.NullLogger.html b/docs/api/variables/Logging.NullLogger.html index 38781ae..3351941 100644 --- a/docs/api/variables/Logging.NullLogger.html +++ b/docs/api/variables/Logging.NullLogger.html @@ -1 +1 @@ -NullLogger | @michaelcoxon/utilities

    Variable NullLoggerConst

    NullLogger: ILogger = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NullLogger | @michaelcoxon/utilities

    Variable NullLoggerConst

    NullLogger: ILogger = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.ESCAPE_REGEX_SEARCH.html b/docs/api/variables/Strings.ESCAPE_REGEX_SEARCH.html index 3d9e709..7d205aa 100644 --- a/docs/api/variables/Strings.ESCAPE_REGEX_SEARCH.html +++ b/docs/api/variables/Strings.ESCAPE_REGEX_SEARCH.html @@ -1 +1 @@ -ESCAPE_REGEX_SEARCH | @michaelcoxon/utilities

    Variable ESCAPE_REGEX_SEARCHConst

    ESCAPE_REGEX_SEARCH: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ESCAPE_REGEX_SEARCH | @michaelcoxon/utilities

    Variable ESCAPE_REGEX_SEARCHConst

    ESCAPE_REGEX_SEARCH: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.FORMAT_REGEX.html b/docs/api/variables/Strings.FORMAT_REGEX.html index bb6793c..2931287 100644 --- a/docs/api/variables/Strings.FORMAT_REGEX.html +++ b/docs/api/variables/Strings.FORMAT_REGEX.html @@ -1 +1 @@ -FORMAT_REGEX | @michaelcoxon/utilities

    Variable FORMAT_REGEXConst

    FORMAT_REGEX: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FORMAT_REGEX | @michaelcoxon/utilities

    Variable FORMAT_REGEXConst

    FORMAT_REGEX: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.KEY_VALUE_SEPARATOR.html b/docs/api/variables/Strings.KEY_VALUE_SEPARATOR.html index 37bef77..e289d02 100644 --- a/docs/api/variables/Strings.KEY_VALUE_SEPARATOR.html +++ b/docs/api/variables/Strings.KEY_VALUE_SEPARATOR.html @@ -1 +1 @@ -KEY_VALUE_SEPARATOR | @michaelcoxon/utilities

    Variable KEY_VALUE_SEPARATORConst

    KEY_VALUE_SEPARATOR: ":" = ":"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KEY_VALUE_SEPARATOR | @michaelcoxon/utilities

    Variable KEY_VALUE_SEPARATORConst

    KEY_VALUE_SEPARATOR: ":" = ":"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.KEY_WORD_SEPARATOR.html b/docs/api/variables/Strings.KEY_WORD_SEPARATOR.html index 3eec48e..84618ae 100644 --- a/docs/api/variables/Strings.KEY_WORD_SEPARATOR.html +++ b/docs/api/variables/Strings.KEY_WORD_SEPARATOR.html @@ -1 +1 @@ -KEY_WORD_SEPARATOR | @michaelcoxon/utilities

    Variable KEY_WORD_SEPARATORConst

    KEY_WORD_SEPARATOR: "__" = '__'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KEY_WORD_SEPARATOR | @michaelcoxon/utilities

    Variable KEY_WORD_SEPARATORConst

    KEY_WORD_SEPARATOR: "__" = '__'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.WHITESPACE.html b/docs/api/variables/Strings.WHITESPACE.html index 1358275..040e87e 100644 --- a/docs/api/variables/Strings.WHITESPACE.html +++ b/docs/api/variables/Strings.WHITESPACE.html @@ -1 +1 @@ -WHITESPACE | @michaelcoxon/utilities

    Variable WHITESPACEConst

    WHITESPACE: "\\s\\uFEFF\\xA0" = "\\s\\uFEFF\\xA0"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WHITESPACE | @michaelcoxon/utilities

    Variable WHITESPACEConst

    WHITESPACE: "\\s\\uFEFF\\xA0" = "\\s\\uFEFF\\xA0"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.empty.html b/docs/api/variables/Strings.empty.html index 5dbe0f4..e1b8aee 100644 --- a/docs/api/variables/Strings.empty.html +++ b/docs/api/variables/Strings.empty.html @@ -1 +1 @@ -empty | @michaelcoxon/utilities

    Variable emptyConst

    empty: string = emptyImpl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +empty | @michaelcoxon/utilities

    Variable emptyConst

    empty: string = emptyImpl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/Strings.newLine.html b/docs/api/variables/Strings.newLine.html index e7e1a5a..bae0da4 100644 --- a/docs/api/variables/Strings.newLine.html +++ b/docs/api/variables/Strings.newLine.html @@ -1 +1 @@ -newLine | @michaelcoxon/utilities

    Variable newLineConst

    newLine: "\n" = "\n"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newLine | @michaelcoxon/utilities

    Variable newLineConst

    newLine: "\n" = "\n"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/variables/empty.html b/docs/api/variables/empty.html index cdb1706..db4fc21 100644 --- a/docs/api/variables/empty.html +++ b/docs/api/variables/empty.html @@ -1 +1 @@ -empty | @michaelcoxon/utilities

    Variable emptyConst

    empty: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +empty | @michaelcoxon/utilities

    Variable emptyConst

    empty: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file