From c5ae6c0bb30e91608f3fbb924f51cd45940a4b7a Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Wed, 12 Jun 2024 21:53:26 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- functions/asArray.html | 4 ++-- functions/asBoolean.html | 4 ++-- functions/asDictionary.html | 4 ++-- functions/asFunction.html | 4 ++-- functions/asInstance.html | 4 ++-- functions/asJsonArray.html | 4 ++-- functions/asJsonMap.html | 4 ++-- functions/asNumber.html | 4 ++-- functions/asObject.html | 4 ++-- functions/asPlainObject.html | 4 ++-- functions/asString.html | 4 ++-- functions/assert.html | 2 +- functions/assertAnyJson.html | 2 +- functions/assertArray.html | 2 +- functions/assertBoolean.html | 2 +- functions/assertDictionary.html | 2 +- functions/assertFunction.html | 2 +- functions/assertInstance.html | 2 +- functions/assertJsonArray.html | 2 +- functions/assertJsonMap.html | 2 +- functions/assertNonNull.html | 2 +- functions/assertNumber.html | 2 +- functions/assertObject.html | 2 +- functions/assertPlainObject.html | 2 +- functions/assertString.html | 2 +- functions/coerceAnyJson.html | 4 ++-- functions/coerceJsonArray.html | 4 ++-- functions/coerceJsonMap.html | 4 ++-- functions/definiteEntriesOf.html | 2 +- functions/definiteKeysOf.html | 2 +- functions/definiteValuesOf.html | 2 +- functions/ensure.html | 2 +- functions/ensureAnyJson.html | 2 +- functions/ensureArray.html | 2 +- functions/ensureBoolean.html | 2 +- functions/ensureDictionary.html | 2 +- functions/ensureFunction.html | 2 +- functions/ensureInstance.html | 2 +- functions/ensureJsonArray.html | 2 +- functions/ensureJsonMap.html | 2 +- functions/ensureNumber.html | 2 +- functions/ensureObject.html | 2 +- functions/ensurePlainObject.html | 2 +- functions/ensureString.html | 2 +- functions/entriesOf.html | 2 +- functions/get.html | 2 +- functions/getAnyJson.html | 4 ++-- functions/getArray.html | 4 ++-- functions/getBoolean.html | 4 ++-- functions/getDictionary.html | 4 ++-- functions/getFunction.html | 4 ++-- functions/getInstance.html | 4 ++-- functions/getJsonArray.html | 4 ++-- functions/getJsonMap.html | 4 ++-- functions/getNumber.html | 4 ++-- functions/getObject.html | 4 ++-- functions/getPlainObject.html | 4 ++-- functions/getString.html | 4 ++-- functions/has.html | 2 +- functions/hasAnyJson.html | 2 +- functions/hasArray.html | 2 +- functions/hasBoolean.html | 2 +- functions/hasDictionary.html | 2 +- functions/hasFunction.html | 2 +- functions/hasInstance.html | 2 +- functions/hasJsonArray.html | 2 +- functions/hasJsonMap.html | 2 +- functions/hasNumber.html | 2 +- functions/hasObject.html | 2 +- functions/hasPlainObject.html | 2 +- functions/hasString.html | 2 +- functions/isAnyJson.html | 2 +- functions/isArray.html | 2 +- functions/isArrayLike.html | 2 +- functions/isBoolean.html | 2 +- functions/isClassAssignableTo.html | 2 +- functions/isDictionary.html | 2 +- functions/isFunction.html | 2 +- functions/isInstance.html | 2 +- functions/isJsonArray.html | 2 +- functions/isJsonMap.html | 2 +- functions/isKeyOf.html | 2 +- functions/isNumber.html | 2 +- functions/isObject.html | 2 +- functions/isPlainObject.html | 2 +- functions/isString.html | 2 +- functions/keysOf.html | 2 +- functions/toAnyJson.html | 4 ++-- functions/toJsonArray.html | 6 +++--- functions/toJsonMap.html | 6 +++--- functions/valuesOf.html | 2 +- interfaces/JsonMap.html | 2 +- types/AnyArray.html | 2 +- types/AnyArrayLike.html | 2 +- types/AnyConstructor.html | 2 +- types/AnyFunction.html | 2 +- types/AnyJson.html | 2 +- types/Dictionary.html | 2 +- types/JsonArray.html | 2 +- types/JsonCollection.html | 2 +- types/JsonPrimitive.html | 2 +- types/KeyOf.html | 2 +- types/KeyValue.html | 2 +- types/Literals.html | 2 +- types/LiteralsRecord.html | 2 +- types/Many.html | 2 +- types/NonOptional.html | 2 +- types/Nullable.html | 2 +- types/Omit.html | 2 +- types/Optional.html | 2 +- types/Overwrite.html | 2 +- types/ReadWrite.html | 2 +- types/RequiredNonNullable.html | 2 +- types/RequiredNonOptional.html | 2 +- types/View.html | 2 +- 115 files changed, 146 insertions(+), 146 deletions(-) diff --git a/functions/asArray.html b/functions/asArray.html index e22e832c..a98c7616 100644 --- a/functions/asArray.html +++ b/functions/asArray.html @@ -1,6 +1,6 @@ asArray | @salesforce/ts-types

Function asArray

  • asArray<T>(value): Optional<T[]>

  • Narrows an unknown value to an Array if it is type-compatible, or returns undefined otherwise.

    Type Parameters

    • T = unknown

    Parameters

    • value: unknown

      The value to test.

      -

    Returns Optional<T[]>

  • asArray<T>(value, defaultValue): T[]

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    +

Returns Optional<T[]>

  • asArray<T>(value, defaultValue): T[]

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T = unknown

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T[]

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T[]

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asBoolean.html b/functions/asBoolean.html index 6c09ccb6..c93133a0 100644 --- a/functions/asBoolean.html +++ b/functions/asBoolean.html @@ -1,6 +1,6 @@ asBoolean | @salesforce/ts-types

    Function asBoolean

    • asBoolean(value): Optional<boolean>

    • Narrows an unknown value to a boolean if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<boolean>

    • asBoolean(value, defaultValue): boolean

    • Narrows an unknown value to a boolean if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<boolean>

  • asBoolean(value, defaultValue): boolean

  • Narrows an unknown value to a boolean if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: boolean

      The default to return if value was undefined or of the incorrect type.

      -

    Returns boolean

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asDictionary.html b/functions/asDictionary.html index de3e9651..e870758a 100644 --- a/functions/asDictionary.html +++ b/functions/asDictionary.html @@ -1,6 +1,6 @@ asDictionary | @salesforce/ts-types

    Function asDictionary

    • asDictionary<T>(value): Optional<Dictionary<T>>

    • Narrows an unknown value to a Dictionary<T> if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      • T = unknown

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<Dictionary<T>>

    • asDictionary<T>(value, defaultValue): Dictionary<T>

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<Dictionary<T>>

  • asDictionary<T>(value, defaultValue): Dictionary<T>

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T = unknown

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: Dictionary<T>

      The default to return if value was undefined or of the incorrect type.

      -

    Returns Dictionary<T>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asFunction.html b/functions/asFunction.html index 4765f86a..063a3e63 100644 --- a/functions/asFunction.html +++ b/functions/asFunction.html @@ -1,6 +1,6 @@ asFunction | @salesforce/ts-types

    Function asFunction

    • asFunction(value): Optional<AnyFunction>

    • Narrows an unknown value to an AnyFunction if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<AnyFunction>

    • asFunction(value, defaultValue): AnyFunction

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<AnyFunction>

  • asFunction(value, defaultValue): AnyFunction

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: AnyFunction

      The default to return if value was undefined or of the incorrect type.

      -

    Returns AnyFunction

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyFunction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asInstance.html b/functions/asInstance.html index 3d689fb0..084e7f2e 100644 --- a/functions/asInstance.html +++ b/functions/asInstance.html @@ -1,7 +1,7 @@ asInstance | @salesforce/ts-types

    Function asInstance

    • asInstance<C>(value, ctor): Optional<InstanceType<C>>

    • Narrows an unknown value to an instance of constructor type T if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -
      • ctor: C

      Returns Optional<InstanceType<C>>

    • asInstance<C>(value, ctor, defaultValue): InstanceType<C>

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +
    • ctor: C

    Returns Optional<InstanceType<C>>

  • asInstance<C>(value, ctor, defaultValue): InstanceType<C>

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    Parameters

    • value: unknown

      The value to test.

    • ctor: C
    • defaultValue: InstanceType<C>

      The default to return if value was undefined or of the incorrect type.

      -

    Returns InstanceType<C>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asJsonArray.html b/functions/asJsonArray.html index 64971b04..16d0fd02 100644 --- a/functions/asJsonArray.html +++ b/functions/asJsonArray.html @@ -1,6 +1,6 @@ asJsonArray | @salesforce/ts-types

    Function asJsonArray

    • asJsonArray(value): Optional<JsonArray>

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns undefined otherwise.

      Parameters

      Returns Optional<JsonArray>

    • asJsonArray(value, defaultValue): JsonArray

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<JsonArray>

  • asJsonArray(value, defaultValue): JsonArray

  • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: Optional<AnyJson>

      The value to test.

    • defaultValue: JsonArray

      The default to return if the value was undefined or of the incorrect type.

      -

    Returns JsonArray

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asJsonMap.html b/functions/asJsonMap.html index 260e35bf..a4093986 100644 --- a/functions/asJsonMap.html +++ b/functions/asJsonMap.html @@ -1,6 +1,6 @@ asJsonMap | @salesforce/ts-types

    Function asJsonMap

    • asJsonMap(value): Optional<JsonMap>

    • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns undefined otherwise.

      Parameters

      Returns Optional<JsonMap>

    • asJsonMap(value, defaultValue): JsonMap

    • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<JsonMap>

  • asJsonMap(value, defaultValue): JsonMap

  • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: Optional<AnyJson>

      The value to test.

    • defaultValue: JsonMap

      The default to return if value was undefined or of the incorrect type.

      -

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asNumber.html b/functions/asNumber.html index ced51f32..38164008 100644 --- a/functions/asNumber.html +++ b/functions/asNumber.html @@ -1,6 +1,6 @@ asNumber | @salesforce/ts-types

    Function asNumber

    • asNumber(value): Optional<number>

    • Narrows an unknown value to a number if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<number>

    • asNumber(value, defaultValue): number

    • Narrows an unknown value to a number if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<number>

  • asNumber(value, defaultValue): number

  • Narrows an unknown value to a number if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: number

      The default to return if value was undefined or of the incorrect type.

      -

    Returns number

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asObject.html b/functions/asObject.html index 77d2cae0..17fd229d 100644 --- a/functions/asObject.html +++ b/functions/asObject.html @@ -1,6 +1,6 @@ asObject | @salesforce/ts-types

    Function asObject

    • asObject<T>(value): Optional<T>

    • Narrows an unknown value to an object if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      • T extends object = object

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<T>

    • asObject<T>(value, defaultValue): T

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<T>

  • asObject<T>(value, defaultValue): T

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T extends object = object

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asPlainObject.html b/functions/asPlainObject.html index f618e718..5843704a 100644 --- a/functions/asPlainObject.html +++ b/functions/asPlainObject.html @@ -1,6 +1,6 @@ asPlainObject | @salesforce/ts-types

    Function asPlainObject

    • asPlainObject<T>(value): Optional<T>

    • Narrows an unknown value to a plain object if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      • T extends object = object

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<T>

    • asPlainObject<T>(value, defaultValue): T

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<T>

  • asPlainObject<T>(value, defaultValue): T

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T extends object = object

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asString.html b/functions/asString.html index 7153bfbf..3e30777c 100644 --- a/functions/asString.html +++ b/functions/asString.html @@ -1,6 +1,6 @@ asString | @salesforce/ts-types

    Function asString

    • asString(value): Optional<string>

    • Narrows an unknown value to a string if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<string>

    • asString(value, defaultValue): string

    • Narrows an unknown value to a string if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<string>

  • asString(value, defaultValue): string

  • Narrows an unknown value to a string if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: string

      The default to return if value was undefined or of the incorrect type.

      -

    Returns string

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assert.html b/functions/assert.html index 60333b2c..2978b25f 100644 --- a/functions/assert.html +++ b/functions/assert.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts condition

    Throws

    AssertionFailedError If the assertion failed.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertAnyJson.html b/functions/assertAnyJson.html index e882d4ff..d48c845e 100644 --- a/functions/assertAnyJson.html +++ b/functions/assertAnyJson.html @@ -3,4 +3,4 @@

    Parameters

    Returns asserts value is AnyJson

    Throws

    AssertionFailedError If the value was not a JSON value type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertArray.html b/functions/assertArray.html index 83a1590e..26847a8d 100644 --- a/functions/assertArray.html +++ b/functions/assertArray.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is AnyArray

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertBoolean.html b/functions/assertBoolean.html index be3b96e5..c4991692 100644 --- a/functions/assertBoolean.html +++ b/functions/assertBoolean.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is boolean

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertDictionary.html b/functions/assertDictionary.html index de23c6de..611fe01e 100644 --- a/functions/assertDictionary.html +++ b/functions/assertDictionary.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns asserts value is Dictionary<T>

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertFunction.html b/functions/assertFunction.html index 7527b419..cedc7a3b 100644 --- a/functions/assertFunction.html +++ b/functions/assertFunction.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is AnyFunction

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertInstance.html b/functions/assertInstance.html index 1e0e0059..5635a96c 100644 --- a/functions/assertInstance.html +++ b/functions/assertInstance.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns asserts value is InstanceType<C>

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertJsonArray.html b/functions/assertJsonArray.html index 92c628cc..5d8d548e 100644 --- a/functions/assertJsonArray.html +++ b/functions/assertJsonArray.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is JsonArray

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertJsonMap.html b/functions/assertJsonMap.html index 777ff287..f5273c78 100644 --- a/functions/assertJsonMap.html +++ b/functions/assertJsonMap.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is JsonMap

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertNonNull.html b/functions/assertNonNull.html index 126bb924..d1140538 100644 --- a/functions/assertNonNull.html +++ b/functions/assertNonNull.html @@ -9,4 +9,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertNumber.html b/functions/assertNumber.html index 5f59b548..e0486e87 100644 --- a/functions/assertNumber.html +++ b/functions/assertNumber.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is number

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertObject.html b/functions/assertObject.html index 81d00388..f54d0c43 100644 --- a/functions/assertObject.html +++ b/functions/assertObject.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertPlainObject.html b/functions/assertPlainObject.html index d67ab88f..5cd57cc1 100644 --- a/functions/assertPlainObject.html +++ b/functions/assertPlainObject.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertString.html b/functions/assertString.html index 67edb5b0..24b9e353 100644 --- a/functions/assertString.html +++ b/functions/assertString.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is string

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceAnyJson.html b/functions/coerceAnyJson.html index aa28b91c..ab903a41 100644 --- a/functions/coerceAnyJson.html +++ b/functions/coerceAnyJson.html @@ -4,7 +4,7 @@ function, it's the responsibility of the caller to understand the risks of making such a shallow type assertion over the value data.

    Parameters

    Returns Optional<AnyJson>

  • coerceAnyJson(value, defaultValue): AnyJson

  • Narrows an unknown value to an AnyJson if it is type-compatible, or returns the provided default otherwise.

    +

    • Returns Optional<AnyJson>

  • coerceAnyJson(value, defaultValue): AnyJson

  • Narrows an unknown value to an AnyJson if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: AnyJson

      The default to return if value was undefined or of the incorrect type.

      -

    Returns AnyJson

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceJsonArray.html b/functions/coerceJsonArray.html index cdda2a42..7038e4b4 100644 --- a/functions/coerceJsonArray.html +++ b/functions/coerceJsonArray.html @@ -3,10 +3,10 @@ instead when the value array cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonArray(coerceAnyJson(value)).

    Type Parameters

    Parameters

    Returns Optional<JsonArray>

  • coerceJsonArray<T>(value, defaultValue): JsonArray

  • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of +

    • Returns Optional<JsonArray>

  • coerceJsonArray<T>(value, defaultValue): JsonArray

  • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of the array is known to be JSON-compatible and you want simple type coercion to a JsonArray. Use toJsonArray instead when the value array cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonArray(coerceAnyJson(value)) ?? defaultValue.

    Type Parameters

    • T

    Parameters

    • value: Nullable<T[]>

      The array to coerce.

    • defaultValue: JsonArray

      The default to return if value was not defined.

      -

    Returns JsonArray

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceJsonMap.html b/functions/coerceJsonMap.html index 8d58a903..b5a129b6 100644 --- a/functions/coerceJsonMap.html +++ b/functions/coerceJsonMap.html @@ -3,10 +3,10 @@ instead when the value object cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonMap(coerceAnyJson(value)).

    Type Parameters

    Parameters

    Returns Optional<JsonMap>

  • coerceJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap using a shallow type-compatibility check. Use this when the source of +

    • Returns Optional<JsonMap>

  • coerceJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap using a shallow type-compatibility check. Use this when the source of the object is known to be JSON-compatible and you want simple type coercion to a JsonMap. Use toJsonMap instead when the value object cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonMap(coerceAnyJson(value)) ?? defaultValue.

    Type Parameters

    • T extends object

    Parameters

    • value: Nullable<T>

      The object to coerce.

    • defaultValue: JsonMap

      The default to return if value was not defined.

      -

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteEntriesOf.html b/functions/definiteEntriesOf.html index f9d6bcaa..09467680 100644 --- a/functions/definiteEntriesOf.html +++ b/functions/definiteEntriesOf.html @@ -4,4 +4,4 @@ null values.

    See also caveats outlined in entriesOf.

    Type Parameters

    Parameters

    Returns [K, V][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns [K, V][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteKeysOf.html b/functions/definiteKeysOf.html index 8b4aa7c9..8a89de2e 100644 --- a/functions/definiteKeysOf.html +++ b/functions/definiteKeysOf.html @@ -2,4 +2,4 @@ This can be convenient for enumerating the keys of definitely assigned properties in an object or Dictionary.

    See also caveats outlined in keysOf.

    Type Parameters

    Parameters

    Returns KeyOf<T>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns KeyOf<T>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteValuesOf.html b/functions/definiteValuesOf.html index 9ba03be4..64bf3250 100644 --- a/functions/definiteValuesOf.html +++ b/functions/definiteValuesOf.html @@ -2,4 +2,4 @@ This can be convenient for enumerating the values of unknown objects with optional properties (including Dictionarys) without worrying about performing checks against possibly undefined or null values.

    Type Parameters

    Parameters

    Returns NonNullable<T[KeyOf<T>]>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns NonNullable<T[KeyOf<T>]>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensure.html b/functions/ensure.html index bb62fce5..0ee6aca3 100644 --- a/functions/ensure.html +++ b/functions/ensure.html @@ -9,4 +9,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureAnyJson.html b/functions/ensureAnyJson.html index be5f1975..fef84983 100644 --- a/functions/ensureAnyJson.html +++ b/functions/ensureAnyJson.html @@ -3,4 +3,4 @@

    Parameters

    Returns AnyJson

    Throws

    UnexpectedValueTypeError If the value was not a JSON value type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureArray.html b/functions/ensureArray.html index 54fcce85..a94c7018 100644 --- a/functions/ensureArray.html +++ b/functions/ensureArray.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns T[]

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureBoolean.html b/functions/ensureBoolean.html index dbaf19ad..b1491f27 100644 --- a/functions/ensureBoolean.html +++ b/functions/ensureBoolean.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureDictionary.html b/functions/ensureDictionary.html index f1c1164f..c5292f3f 100644 --- a/functions/ensureDictionary.html +++ b/functions/ensureDictionary.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns Dictionary<T>

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureFunction.html b/functions/ensureFunction.html index 7bb52b21..42b5926b 100644 --- a/functions/ensureFunction.html +++ b/functions/ensureFunction.html @@ -2,4 +2,4 @@

    Parameters

    Returns AnyFunction

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureInstance.html b/functions/ensureInstance.html index 3b535ae2..deff9383 100644 --- a/functions/ensureInstance.html +++ b/functions/ensureInstance.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns InstanceType<C>

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureJsonArray.html b/functions/ensureJsonArray.html index b761808a..614188a0 100644 --- a/functions/ensureJsonArray.html +++ b/functions/ensureJsonArray.html @@ -2,4 +2,4 @@

    Parameters

    Returns JsonArray

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureJsonMap.html b/functions/ensureJsonMap.html index a2bb34b3..3126d933 100644 --- a/functions/ensureJsonMap.html +++ b/functions/ensureJsonMap.html @@ -2,4 +2,4 @@

    Parameters

    Returns JsonMap

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureNumber.html b/functions/ensureNumber.html index 1426e8b8..85e9d29c 100644 --- a/functions/ensureNumber.html +++ b/functions/ensureNumber.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureObject.html b/functions/ensureObject.html index 968be93d..a4039dba 100644 --- a/functions/ensureObject.html +++ b/functions/ensureObject.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensurePlainObject.html b/functions/ensurePlainObject.html index 82f8bcbc..52ed9440 100644 --- a/functions/ensurePlainObject.html +++ b/functions/ensurePlainObject.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureString.html b/functions/ensureString.html index 90ba44f5..9136b9dd 100644 --- a/functions/ensureString.html +++ b/functions/ensureString.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/entriesOf.html b/functions/entriesOf.html index 171c14c8..79b8e2c6 100644 --- a/functions/entriesOf.html +++ b/functions/entriesOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    // type of entries -> ['x' | 'y', number][]
    const entries = entriesOf(point);
    for (const entry of entries) {
      console.log(entry[0], entry[1]);
    }
    // x 1
    // y 2

    Type Parameters

    Parameters

    Returns [K, T[K]][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns [K, T[K]][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/get.html b/functions/get.html index b09d9a9c..9b8d9b95 100644 --- a/functions/get.html +++ b/functions/get.html @@ -4,4 +4,4 @@

    Parameters

    Returns unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getAnyJson.html b/functions/getAnyJson.html index 5c0fca82..bd9a250e 100644 --- a/functions/getAnyJson.html +++ b/functions/getAnyJson.html @@ -5,11 +5,11 @@

    Parameters

    Returns Optional<AnyJson>

  • getAnyJson(from, path, defaultValue): AnyJson

  • Given a deep-search query path, returns an object property or array value of a JsonCollection as an +

    • Returns Optional<AnyJson>

  • getAnyJson(from, path, defaultValue): AnyJson

  • Given a deep-search query path, returns an object property or array value of a JsonCollection as an AnyJson, or the given default if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ a: 'b' }] } };
    const value = getAnyJson(obj, 'foo.bar[1]', { c: 'd' });
    // type of value -> AnyJson; value -> { c: 'd' }

    Parameters

    • from: Optional<AnyJson>

      The JSON value to query.

    • path: string

      The query path.

    • defaultValue: AnyJson

      The default to return if the query result was not defined.

      -

    Returns AnyJson

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getArray.html b/functions/getArray.html index 651f8d50..08545759 100644 --- a/functions/getArray.html +++ b/functions/getArray.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<AnyArray>

  • getArray(from, path, defaultValue): AnyArray

  • Given a deep-search query path, returns an object property or array value of an object or array as an +

    • Returns Nullable<AnyArray>

  • getArray(from, path, defaultValue): AnyArray

  • Given a deep-search query path, returns an object property or array value of an object or array as an AnyArray, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [1, 2, 3] } };
    const value = getArray(obj, 'foo.baz', [4, 5, 6]);
    // type of value -> AnyArray; value -> [4, 5, 6]

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: AnyArray

      The default to return if the query result was not defined.

      -

    Returns AnyArray

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getBoolean.html b/functions/getBoolean.html index 1860622b..cac5e8ea 100644 --- a/functions/getBoolean.html +++ b/functions/getBoolean.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<boolean>

  • getBoolean(from, path, defaultValue): boolean

  • Given a deep-search query path, returns an object property or array value of an object or array as a boolean, or +

    • Returns Nullable<boolean>

  • getBoolean(from, path, defaultValue): boolean

  • Given a deep-search query path, returns an object property or array value of an object or array as a boolean, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [true] } };
    const value = getBoolean(obj, 'foo.bar[1]', false);
    // type of value -> boolean; value -> false

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: boolean

      The default to return if the query result was not defined.

      -

    Returns boolean

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getDictionary.html b/functions/getDictionary.html index d40ec349..08c8aa7a 100644 --- a/functions/getDictionary.html +++ b/functions/getDictionary.html @@ -4,11 +4,11 @@

    Type Parameters

    Parameters

    Returns Nullable<Dictionary<T>>

  • getDictionary<T>(from, path, defaultValue): Dictionary<T>

  • Given a deep-search query path, returns an object property or array value of an object or array as an Dictionary<T>, or +

    • Returns Nullable<Dictionary<T>>

  • getDictionary<T>(from, path, defaultValue): Dictionary<T>

  • Given a deep-search query path, returns an object property or array value of an object or array as an Dictionary<T>, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ name: 'baz' }] } };
    const value = getDictionary<string>(obj, 'foo.bar[1]', { name: 'buzz' });
    // type of value -> Dictionary<string>; value -> { name: 'buzz' }

    Type Parameters

    • T = unknown

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: Dictionary<T>

      The default to return if the query result was not defined.

      -

    Returns Dictionary<T>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getFunction.html b/functions/getFunction.html index 84b8a450..3b6d7b1e 100644 --- a/functions/getFunction.html +++ b/functions/getFunction.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<AnyFunction>

  • getFunction(from, path, defaultValue): AnyFunction

  • Given a deep-search query path, returns an object property or array value of an object or array as an +

    • Returns Nullable<AnyFunction>

  • getFunction(from, path, defaultValue): AnyFunction

  • Given a deep-search query path, returns an object property or array value of an object or array as an AnyFunction, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [(arg: string) => `Hi, ${arg}`] } };
    const value = getFunction(obj, 'foo.bar[1]', (arg: string) => `Bye, ${arg}`);
    // type of value -> AnyArray; value -> (arg: string) => `Bye, ${arg}`)

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: AnyFunction

      The default to return if the query result was not defined.

      -

    Returns AnyFunction

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyFunction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getInstance.html b/functions/getInstance.html index a5ea5bd9..8a802658 100644 --- a/functions/getInstance.html +++ b/functions/getInstance.html @@ -4,11 +4,11 @@

    Type Parameters

    Parameters

    Returns Nullable<InstanceType<C>>

  • getInstance<C>(from, path, ctor, defaultValue): InstanceType<C>

  • Given a deep-search query path, returns an object property or array value of an object or array as an instance of +

  • ctor: C

    • Returns Nullable<InstanceType<C>>

  • getInstance<C>(from, path, ctor, defaultValue): InstanceType<C>

  • Given a deep-search query path, returns an object property or array value of an object or array as an instance of class type C, or undefined if a value was not found or was not type-compatible.

    class Example { ... }
    const obj = { foo: { bar: [new Example()] } };
    const value = getInstance(obj, 'foo.bar[0]', Example);
    // type of value -> Example; value -> new Example()

    Type Parameters

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • ctor: C
    • defaultValue: InstanceType<C>

      The default to return if the query result was not defined.

      -

    Returns InstanceType<C>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getJsonArray.html b/functions/getJsonArray.html index 5cb32996..0225e2a8 100644 --- a/functions/getJsonArray.html +++ b/functions/getJsonArray.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<JsonArray>

  • getJsonArray(from, path, defaultValue): JsonArray

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a +

    • Returns Nullable<JsonArray>

  • getJsonArray(from, path, defaultValue): JsonArray

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a JsonArray, or the given default if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [1, 2, 3] } };
    const value = getJsonArray(obj, 'foo.baz', [4, 5, 6]);
    // type of value -> JsonArray; value -> [4, 5, 6]

    Parameters

    • from: Optional<AnyJson>

      The JSON value to query.

    • path: string

      The query path.

    • defaultValue: JsonArray

      The default to return if the query result was not defined.

      -

    Returns JsonArray

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getJsonMap.html b/functions/getJsonMap.html index 0b56d777..adeb2244 100644 --- a/functions/getJsonMap.html +++ b/functions/getJsonMap.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<JsonMap>

  • getJsonMap(from, path, defaultValue): JsonMap

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a +

    • Returns Nullable<JsonMap>

  • getJsonMap(from, path, defaultValue): JsonMap

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a JsonMap, or the given default if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ a: 'b' }] } };
    const value = getJsonMap(obj, 'foo.bar[1]', { c: 'd' });
    // type of value -> JsonMap; value -> { c: 'd' }

    Parameters

    • from: Optional<AnyJson>

      The JSON value to query.

    • path: string

      The query path.

    • defaultValue: JsonMap

      The default to return if the query result was not defined.

      -

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getNumber.html b/functions/getNumber.html index f3ec8232..16bcc98a 100644 --- a/functions/getNumber.html +++ b/functions/getNumber.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<number>

  • getNumber(from, path, defaultValue): number

  • Given a deep-search query path, returns an object property or array value of an object or array as a number, or +

    • Returns Nullable<number>

  • getNumber(from, path, defaultValue): number

  • Given a deep-search query path, returns an object property or array value of an object or array as a number, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [1] } };
    const value = getNumber(obj, 'foo.bar[1]', 2);
    // type of value -> number; value -> 2

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: number

      The default to return if the query result was not defined.

      -

    Returns number

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getObject.html b/functions/getObject.html index b6b8cd4c..271ad19f 100644 --- a/functions/getObject.html +++ b/functions/getObject.html @@ -4,11 +4,11 @@

    Type Parameters

    Parameters

    Returns Nullable<T>

  • getObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or +

    • Returns Nullable<T>

  • getObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ name: 'baz' }] } };
    const value = getObject(obj, 'foo.bar[1]', { name: 'buzz' });
    // type of value -> object; value -> { name: 'buzz' }

    Type Parameters

    • T extends object = object

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: T

      The default to return if the query result was not defined.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getPlainObject.html b/functions/getPlainObject.html index adb6974d..a63f6149 100644 --- a/functions/getPlainObject.html +++ b/functions/getPlainObject.html @@ -5,7 +5,7 @@

    Type Parameters

    Parameters

    Returns Nullable<T>

  • getPlainObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or +

    • Returns Nullable<T>

  • getPlainObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or undefined if a value was not found or was not type-compatible. This differs from getObject by way of testing for the property value type compatibility using isPlainObject instead of isObject.

    const obj = { foo: { bar: [{ name: 'baz' }] } };
    const value = getPlainObject(obj, 'foo.bar[1]', { name: 'buzz' });
    // type of value -> object; value -> { name: 'buzz' }
@@ -13,4 +13,4 @@

    Type Parameters

    • T extends object = object

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: T

      The default to return if the query result was not defined.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getString.html b/functions/getString.html index 28b14d4f..3f1bd4de 100644 --- a/functions/getString.html +++ b/functions/getString.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<string>

  • getString(from, path, defaultValue): string

  • Given a deep-search query path, returns an object property or array value of an object or array as a string, or +

    • Returns Nullable<string>

  • getString(from, path, defaultValue): string

  • Given a deep-search query path, returns an object property or array value of an object or array as a string, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: ['baz'] } };
    const value = getString(obj, 'foo.bar[1]', 'default');
    // type of value -> string; value -> 'default'

    Parameters

    • from: unknown

      Any value to query.

    • path: string

      The query path.

    • defaultValue: string

      The default to return if the query result was not defined.

      -

    Returns string

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/has.html b/functions/has.html index 0f7ff6a0..55b4e319 100644 --- a/functions/has.html +++ b/functions/has.html @@ -6,4 +6,4 @@

    Type Parameters

    Parameters

    Returns value is T & object & View<K>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T & object & View<K>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasAnyJson.html b/functions/hasAnyJson.html index c3082359..e7c72239 100644 --- a/functions/hasAnyJson.html +++ b/functions/hasAnyJson.html @@ -6,4 +6,4 @@ 
    // type of obj -> unknown
    if (hasAnyJson(obj, 'body')) {
      // type of obj -> { body: AnyJson }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, AnyJson>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, AnyJson>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasArray.html b/functions/hasArray.html index 6b2e8528..daaf8dfa 100644 --- a/functions/hasArray.html +++ b/functions/hasArray.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'offset')) {
      // type of obj -> { offset: number }
      if (hasNumber(obj, 'page') && hasArray(obj, 'items')) {
        // type of obj -> { offset: number } & { page: number } & { items: AnyArray }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, AnyArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, AnyArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasBoolean.html b/functions/hasBoolean.html index b292a5e0..9b033340 100644 --- a/functions/hasBoolean.html +++ b/functions/hasBoolean.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasBoolean(obj, 'enabled')) {
      // type of obj -> { enabled: boolean }
      if (hasBoolean(obj, 'hidden')) {
        // type of obj -> { enabled: boolean } & { hidden: boolean }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasDictionary.html b/functions/hasDictionary.html index 01d14f0c..025f9a07 100644 --- a/functions/hasDictionary.html +++ b/functions/hasDictionary.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasDictionary(obj, 'data')) {
        // type of obj -> { status: number } & { data: Dictionary }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, Dictionary<V>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, Dictionary<V>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasFunction.html b/functions/hasFunction.html index bf7d8fc5..e1725f7c 100644 --- a/functions/hasFunction.html +++ b/functions/hasFunction.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasFunction(obj, 'callback')) {
      // type of obj -> { callback: AnyFunction }
      obj.callback(response);
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, AnyFunction>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, AnyFunction>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasInstance.html b/functions/hasInstance.html index f82c0644..ac00f371 100644 --- a/functions/hasInstance.html +++ b/functions/hasInstance.html @@ -5,4 +5,4 @@ 
    class ServerResponse { ... }
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasInstance(obj, 'data', ServerResponse)) {
        // type of obj -> { status: number } & { data: ServerResponse }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & View<K, InstanceType<C>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K
  • ctor: C

    • Returns value is T & View<K, InstanceType<C>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasJsonArray.html b/functions/hasJsonArray.html index 953e0c4a..7f0fce89 100644 --- a/functions/hasJsonArray.html +++ b/functions/hasJsonArray.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasJsonArray(obj, 'body')) {
      // type of obj -> { body: JsonArray }
    }

    Type Parameters

    Parameters

    Returns value is T & JsonMap & View<K, JsonArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & JsonMap & View<K, JsonArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasJsonMap.html b/functions/hasJsonMap.html index 9f8000b2..15a45607 100644 --- a/functions/hasJsonMap.html +++ b/functions/hasJsonMap.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasJsonMap(obj, 'body')) {
      // type of obj -> { body: JsonMap }
    }

    Type Parameters

    Parameters

    Returns value is T & JsonMap & View<K, JsonMap>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & JsonMap & View<K, JsonMap>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasNumber.html b/functions/hasNumber.html index a61d3799..589ddf78 100644 --- a/functions/hasNumber.html +++ b/functions/hasNumber.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'offset')) {
      // type of obj -> { offset: number }
      if (hasNumber(obj, 'page') && hasArray(obj, 'items')) {
        // type of obj -> { offset: number } & { page: number } & { items: unknown[] }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, number>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, number>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasObject.html b/functions/hasObject.html index b9a69034..c61d3c17 100644 --- a/functions/hasObject.html +++ b/functions/hasObject.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasObject(obj, 'data')) {
        // type of obj -> { status: number } & { data: object }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasPlainObject.html b/functions/hasPlainObject.html index 09169187..09da92fd 100644 --- a/functions/hasPlainObject.html +++ b/functions/hasPlainObject.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasPlainObject(obj, 'data')) {
        // type of obj -> { status: number } & { data: object }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasString.html b/functions/hasString.html index c4ed987a..d84bb70b 100644 --- a/functions/hasString.html +++ b/functions/hasString.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasString(obj, 'name')) {
      // type of obj -> { name: string }
      if (hasString(obj, 'message')) {
        // type of obj -> { name: string } & { message: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isAnyJson.html b/functions/isAnyJson.html index 2067572d..fa4c7bfb 100644 --- a/functions/isAnyJson.html +++ b/functions/isAnyJson.html @@ -1,4 +1,4 @@ isAnyJson | @salesforce/ts-types

    Function isAnyJson

    • isAnyJson(value): value is AnyJson

    • Tests whether unknown value is a valid JSON type. Note that objects and arrays are only checked using a shallow test. To be sure that a given value is JSON-compatible at runtime, see toAnyJson.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isArray.html b/functions/isArray.html index 4edf18a2..7e5b3748 100644 --- a/functions/isArray.html +++ b/functions/isArray.html @@ -7,4 +7,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isArrayLike.html b/functions/isArrayLike.html index dd124fd7..23d059fa 100644 --- a/functions/isArrayLike.html +++ b/functions/isArrayLike.html @@ -7,4 +7,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is ArrayLike<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is ArrayLike<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isBoolean.html b/functions/isBoolean.html index abb349c0..5bd612bd 100644 --- a/functions/isBoolean.html +++ b/functions/isBoolean.html @@ -1,3 +1,3 @@ isBoolean | @salesforce/ts-types

    Function isBoolean

    • isBoolean(value): value is boolean

    • Tests whether an unknown value is a boolean.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isClassAssignableTo.html b/functions/isClassAssignableTo.html index fc2910c7..059152ac 100644 --- a/functions/isClassAssignableTo.html +++ b/functions/isClassAssignableTo.html @@ -2,4 +2,4 @@ constructor.

    Type Parameters

    Parameters

    Returns value is C

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is C

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isDictionary.html b/functions/isDictionary.html index 2eeabb06..f9b48902 100644 --- a/functions/isDictionary.html +++ b/functions/isDictionary.html @@ -9,4 +9,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isFunction.html b/functions/isFunction.html index 189c6660..d9dcf82f 100644 --- a/functions/isFunction.html +++ b/functions/isFunction.html @@ -1,3 +1,3 @@ isFunction | @salesforce/ts-types

    Function isFunction

    • isFunction<T>(value): value is T

    • Tests whether an unknown value is a function.

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isInstance.html b/functions/isInstance.html index 8917bf58..39ce8b64 100644 --- a/functions/isInstance.html +++ b/functions/isInstance.html @@ -1,3 +1,3 @@ isInstance | @salesforce/ts-types

    Function isInstance

    • isInstance<C>(value, ctor): value is InstanceType<C>

    • Tests whether an unknown value is a function.

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -
      • ctor: C

      Returns value is InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • ctor: C

    • Returns value is InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isJsonArray.html b/functions/isJsonArray.html index 7e4e7e2f..68733763 100644 --- a/functions/isJsonArray.html +++ b/functions/isJsonArray.html @@ -1,3 +1,3 @@ isJsonArray | @salesforce/ts-types

    Function isJsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isJsonMap.html b/functions/isJsonMap.html index 84bcb273..05280cd7 100644 --- a/functions/isJsonMap.html +++ b/functions/isJsonMap.html @@ -1,3 +1,3 @@ isJsonMap | @salesforce/ts-types

    Function isJsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isKeyOf.html b/functions/isKeyOf.html index a6c003c2..fa764de9 100644 --- a/functions/isKeyOf.html +++ b/functions/isKeyOf.html @@ -1,4 +1,4 @@ isKeyOf | @salesforce/ts-types

    Function isKeyOf

    • isKeyOf<T, K>(obj, key): key is K

    • Tests whether or not a key string is a key of the given object type T.

      Type Parameters

      • T extends object
      • K extends string

      Parameters

      • obj: T

        The target object to check the key in.

      • key: string

        The string to test as a key of the target object.

        -

      Returns key is K

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns key is K

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isNumber.html b/functions/isNumber.html index 403af075..71b5554b 100644 --- a/functions/isNumber.html +++ b/functions/isNumber.html @@ -1,3 +1,3 @@ isNumber | @salesforce/ts-types

    Function isNumber

    • isNumber(value): value is number

    • Tests whether an unknown value is a number.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isObject.html b/functions/isObject.html index 8cbfe889..faf3e521 100644 --- a/functions/isObject.html +++ b/functions/isObject.html @@ -10,4 +10,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isPlainObject.html b/functions/isPlainObject.html index 539c74c1..4b12e904 100644 --- a/functions/isPlainObject.html +++ b/functions/isPlainObject.html @@ -8,4 +8,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isString.html b/functions/isString.html index 9a63689b..25af69db 100644 --- a/functions/isString.html +++ b/functions/isString.html @@ -1,3 +1,3 @@ isString | @salesforce/ts-types

    Function isString

    • isString(value): value is string

    • Tests whether an unknown value is a string.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/keysOf.html b/functions/keysOf.html index 4b695f91..84108252 100644 --- a/functions/keysOf.html +++ b/functions/keysOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    const keys = keysOf(point);
    // type of keys -> ('a' | 'b')[]
    for (const key of keys) {
      console.log(key, point[key]);
    }
    // x 1
    // y 2

    Type Parameters

    Parameters

    Returns K[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns K[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toAnyJson.html b/functions/toAnyJson.html index 9219095c..79c9987a 100644 --- a/functions/toAnyJson.html +++ b/functions/toAnyJson.html @@ -7,7 +7,7 @@ and only needs type coercion.

    Type Parameters

    Parameters

    Returns Optional<AnyJson>

    Throws

    JsonCloneError If the value values contain circular references.

    -
  • toAnyJson<T>(value, defaultValue): AnyJson

  • Narrows an object of type T to an AnyJson following a deep, brute-force conversion of the object's data to +

  • toAnyJson<T>(value, defaultValue): AnyJson

  • Narrows an object of type T to an AnyJson following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceAnyJson(unknown) to type-narrow an arbitrary value to an AnyJson when the value's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -17,4 +17,4 @@

    Type Parameters

    • T

    Parameters

    • value: Nullable<T>

      The value to convert.

    • defaultValue: AnyJson

      The default to return if value was not defined.

    Returns AnyJson

    Throws

    JsonCloneError If the value values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toJsonArray.html b/functions/toJsonArray.html index 3d0a40ae..f84e7d29 100644 --- a/functions/toJsonArray.html +++ b/functions/toJsonArray.html @@ -7,7 +7,7 @@ object can be guaranteed to be JSON-compatible and only needs type coercion.

    Type Parameters

    Parameters

    Returns JsonArray

    Throws

    JsonCloneError If the array values contain circular references.

    -
  • toJsonArray<T>(value): Optional<JsonArray>

  • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to +

  • toJsonArray<T>(value): Optional<JsonArray>

  • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to only consist of JSON-compatible values by performing a basic JSON clone on the array. This is preferable to using the weaker coerceJsonArray(array) to type-narrow an arbitrary array to a JsonArray when the array's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -16,7 +16,7 @@ object can be guaranteed to be JSON-compatible and only needs type coercion.

    Type Parameters

    • T

    Parameters

    Returns Optional<JsonArray>

    Throws

    JsonCloneError If the array values contain circular references.

    -
  • toJsonArray<T>(value, defaultValue): JsonArray

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

  • toJsonArray<T>(value, defaultValue): JsonArray

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary array to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -26,4 +26,4 @@

    Type Parameters

    • T

    Parameters

    • value: Optional<T[]>

      The array to convert.

    • defaultValue: JsonArray

      The default to return if the value was undefined or of the incorrect type.

    Returns JsonArray

    Throws

    JsonCloneError If the array values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toJsonMap.html b/functions/toJsonMap.html index e310e914..8bfe5e42 100644 --- a/functions/toJsonMap.html +++ b/functions/toJsonMap.html @@ -7,7 +7,7 @@ and only needs type coercion.

    Type Parameters

    Parameters

    Returns JsonMap

    Throws

    JsonCloneError If the object values contain circular references.

    -
  • toJsonMap<T>(value): Optional<JsonMap>

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

  • toJsonMap<T>(value): Optional<JsonMap>

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary object to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -16,7 +16,7 @@ and only needs type coercion.

    Type Parameters

    • T extends object

    Parameters

    Returns Optional<JsonMap>

    Throws

    JsonCloneError If the object values contain circular references.

    -
  • toJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

  • toJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary object to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -26,4 +26,4 @@

    Type Parameters

    • T extends object

    Parameters

    • value: Nullable<T>

      The object to convert.

    • defaultValue: JsonMap

      The default to return if value was not defined.

    Returns JsonMap

    Throws

    JsonCloneError If the object values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/valuesOf.html b/functions/valuesOf.html index 99c010ba..475bb0ba 100644 --- a/functions/valuesOf.html +++ b/functions/valuesOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    const values = valuesOf(point);
    // type of values -> number[]
    for (const value of values) {
      console.log(value);
    }
    // 1
    // 2

    Type Parameters

    Parameters

    Returns T[K][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T[K][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/JsonMap.html b/interfaces/JsonMap.html index 0b6aa1ff..c2aa6419 100644 --- a/interfaces/JsonMap.html +++ b/interfaces/JsonMap.html @@ -1,2 +1,2 @@ JsonMap | @salesforce/ts-types

    Interface JsonMap

    Any JSON-compatible object.

    -
    interface JsonMap {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface JsonMap {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyArray.html b/types/AnyArray.html index 771b767d..392233ce 100644 --- a/types/AnyArray.html +++ b/types/AnyArray.html @@ -1,2 +1,2 @@ AnyArray | @salesforce/ts-types

    Type alias AnyArray<T>

    AnyArray<T>: T[]

    An alias for an array of T elements, where T defaults to unknown.

    -

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyArrayLike.html b/types/AnyArrayLike.html index ccd5c138..a3ccb7e6 100644 --- a/types/AnyArrayLike.html +++ b/types/AnyArrayLike.html @@ -1,3 +1,3 @@ AnyArrayLike | @salesforce/ts-types

    Type alias AnyArrayLike<T>

    AnyArrayLike<T>: ArrayLike<T>

    Any object with both a numeric index signature with values of type T and a numeric length property. T defaults to unknown if unspecified.

    -

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyConstructor.html b/types/AnyConstructor.html index 7e583e47..76bb8823 100644 --- a/types/AnyConstructor.html +++ b/types/AnyConstructor.html @@ -1,2 +1,2 @@ AnyConstructor | @salesforce/ts-types

    Type alias AnyConstructor<T>

    AnyConstructor<T>: (new (...args) => T)

    A constructor for any type T. T defaults to object when not explicitly supplied.

    -

    Type Parameters

    • T = object

    Type declaration

      • new (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyFunction.html b/types/AnyFunction.html index 9a0d00fd..424cec0b 100644 --- a/types/AnyFunction.html +++ b/types/AnyFunction.html @@ -1,2 +1,2 @@ AnyFunction | @salesforce/ts-types

    Type alias AnyFunction<T>

    AnyFunction<T>: ((...args) => T)

    Any function returning type T. T defaults to unknown when not explicitly supplied.

    -

    Type Parameters

    • T = unknown

    Type declaration

      • (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyJson.html b/types/AnyJson.html index 63f381e9..62009ac8 100644 --- a/types/AnyJson.html +++ b/types/AnyJson.html @@ -1,2 +1,2 @@ AnyJson | @salesforce/ts-types

    Type alias AnyJson

    AnyJson: JsonPrimitive | JsonCollection

    Any valid JSON value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Dictionary.html b/types/Dictionary.html index 753a00d1..98757a0c 100644 --- a/types/Dictionary.html +++ b/types/Dictionary.html @@ -2,4 +2,4 @@ when not explicitly supplied. For convenient iteration of definitely assigned (i.e. non-nullable) entries, keys, and values, see the following functions: definiteEntriesOf, definiteKeysOf, and definiteValuesOf.

    -

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonArray.html b/types/JsonArray.html index 0255f7e0..5c4a47d6 100644 --- a/types/JsonArray.html +++ b/types/JsonArray.html @@ -1,2 +1,2 @@ JsonArray | @salesforce/ts-types

    Type alias JsonArray

    JsonArray: AnyJson[]

    Any JSON-compatible array.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonCollection.html b/types/JsonCollection.html index 2839499a..34640b36 100644 --- a/types/JsonCollection.html +++ b/types/JsonCollection.html @@ -1,2 +1,2 @@ JsonCollection | @salesforce/ts-types

    Type alias JsonCollection

    JsonCollection: JsonMap | JsonArray

    Any valid JSON collection value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonPrimitive.html b/types/JsonPrimitive.html index e60b9173..d96078eb 100644 --- a/types/JsonPrimitive.html +++ b/types/JsonPrimitive.html @@ -1,2 +1,2 @@ JsonPrimitive | @salesforce/ts-types

    Type alias JsonPrimitive

    JsonPrimitive: null | boolean | number | string

    Any valid JSON primitive value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/KeyOf.html b/types/KeyOf.html index e1a52b18..bfc78311 100644 --- a/types/KeyOf.html +++ b/types/KeyOf.html @@ -1,2 +1,2 @@ KeyOf | @salesforce/ts-types

    Type alias KeyOf<T>

    KeyOf<T>: Extract<keyof T, string>

    An alias for the commonly needed Extract<keyof T, string>.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/KeyValue.html b/types/KeyValue.html index 2bbb2846..f98ea3da 100644 --- a/types/KeyValue.html +++ b/types/KeyValue.html @@ -1,3 +1,3 @@ KeyValue | @salesforce/ts-types

    Type alias KeyValue<T>

    KeyValue<T>: [string, T]

    An alias for a tuple of type [string, T]' for a given generic type T. Tdefaults tounknown` if not otherwise defined.

    -

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Literals.html b/types/Literals.html index 9d431797..062fca50 100644 --- a/types/Literals.html +++ b/types/Literals.html @@ -1,3 +1,3 @@ Literals | @salesforce/ts-types

    Type alias Literals<T>

    Literals<T>: Extract<{
            [K in keyof T]: string extends K
                ? never
                : number extends K
                    ? never
                    : K
        } extends {
            [_ in keyof T]: infer U
        }
        ? U
        : never, string>

    Extracts literally defined property names from a type T as a union of key name strings, minus any index signatures.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/LiteralsRecord.html b/types/LiteralsRecord.html index e1419c9c..e91d2df0 100644 --- a/types/LiteralsRecord.html +++ b/types/LiteralsRecord.html @@ -5,4 +5,4 @@ generated type to the enum keys and remaining as DRY as possible.

    enum QUERY_KEY { id, name, created, updated }
    // type of QUERY_KEY -> {
    //     [x: number]: number;
    //     readonly id: number;
    //     readonly name: number;
    //     readonly created: number;
    //     readonly updated: number;
    // }
    interface QueryRecord extends LiteralsRecord<typeof QUERY_KEY, string> { }
    // type of QueryRecord -> {
    //     readonly id: string;
    //     readonly name: string;
    //     readonly created: string;
    //     readonly updated: string;
    // }
    // And for an interface with writable properties, use the following:
    interface QueryRecord extends ReadWrite<LiteralsRecord<typeof QUERY_KEY, string>> { }
    // type of QueryRecord -> {
    //     id: string;
    //     name: string;
    //     created: string;
    //     updated: string;
    // }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Many.html b/types/Many.html index 66ea664e..4116b433 100644 --- a/types/Many.html +++ b/types/Many.html @@ -1,2 +1,2 @@ Many | @salesforce/ts-types

    Type alias Many<T>

    Many<T>: T | T[]

    A union type for either the parameterized type T or an array of T.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NonOptional.html b/types/NonOptional.html index 24391ba9..adc24e39 100644 --- a/types/NonOptional.html +++ b/types/NonOptional.html @@ -1,2 +1,2 @@ NonOptional | @salesforce/ts-types

    Type alias NonOptional<T>

    NonOptional<T>: T extends undefined
        ? never
        : T

    Subtracts undefined from any union type T. This is the opposite of Optional.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Nullable.html b/types/Nullable.html index 83a083ac..61c91712 100644 --- a/types/Nullable.html +++ b/types/Nullable.html @@ -1,3 +1,3 @@ Nullable | @salesforce/ts-types

    Type alias Nullable<T>

    Nullable<T>: Optional<T | null>

    A union type for either the parameterized type T, null, or undefined -- the opposite of the NonNullable builtin conditional type.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Omit.html b/types/Omit.html index b98d04da..2ffc6406 100644 --- a/types/Omit.html +++ b/types/Omit.html @@ -1,2 +1,2 @@ Omit | @salesforce/ts-types

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Creates a new type that omits keys in union type K of a target type T.

    -

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Optional.html b/types/Optional.html index 563d27e5..77fa1d09 100644 --- a/types/Optional.html +++ b/types/Optional.html @@ -1,2 +1,2 @@ Optional | @salesforce/ts-types

    Type alias Optional<T>

    Optional<T>: T | undefined

    A union type for either the parameterized type T or undefined -- the opposite of NonOptional.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Overwrite.html b/types/Overwrite.html index 8d084d0e..78d45ec8 100644 --- a/types/Overwrite.html +++ b/types/Overwrite.html @@ -4,4 +4,4 @@ change their type or to make them optional.

    type NameAndStringValue = { name: string, value: string }
    type NameAndOptionalNumericValue = Overwrite<NameAndValue, { value?: number }>
    // type of NameAndOptionalNumericValue -> { name: string } & { value?: number | undefined }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ReadWrite.html b/types/ReadWrite.html index 863f651d..93f1aba9 100644 --- a/types/ReadWrite.html +++ b/types/ReadWrite.html @@ -1,3 +1,3 @@ ReadWrite | @salesforce/ts-types

    Type alias ReadWrite<T>

    ReadWrite<T>: {
        -readonly [K in keyof T]: T[K]
    }

    Converts readonly properties of a type T to writable properties. This is the opposite of the Readonly<T> builtin mapped type.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequiredNonNullable.html b/types/RequiredNonNullable.html index 20b9f096..d8b835c5 100644 --- a/types/RequiredNonNullable.html +++ b/types/RequiredNonNullable.html @@ -2,4 +2,4 @@ properties, while also subtracting null from all possible property values.

    type Foo = { bar?: string | undefined | null };
    type RequiredNonNullableFoo = RequiredNonNullable<Foo>;
    // RequiredNonNullableFoo -> { bar: string };
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequiredNonOptional.html b/types/RequiredNonOptional.html index 46ed20cb..3d1d9425 100644 --- a/types/RequiredNonOptional.html +++ b/types/RequiredNonOptional.html @@ -4,4 +4,4 @@ subtracts undefined from value union types as well as the optional property declaration.

    type Foo = { bar?: string | undefined | null };
    type RequiredNonOptionalFoo = RequiredNonOptional<Foo>;
    // RequiredNonOptionalFoo -> { bar: string | null };
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/View.html b/types/View.html index 86d04200..a7f8c70c 100644 --- a/types/View.html +++ b/types/View.html @@ -1,2 +1,2 @@ View | @salesforce/ts-types

    Type alias View<K, V>

    View<K, V>: {
        [_ in K]: V
    }

    A view over an object with constrainable properties.

    -

    Type Parameters

    • K extends string
    • V = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file