Class JsonElement

Index

Constructors

Accessors

Methods

clear deepExtend forEach forEachBoolean forEachElement forEachNumber forEachString forEachValue getBoolean getBooleanOrUndefined getDate getDateTime getDecimal getGuid getInteger getIntegerOrUndefined getNumber getNumberOrUndefined getString getStringOrUndefined hasName newElement parse setBoolean setBooleanArray setDate setDateTime setDecimal setElement setElementArray setGuid setInteger setJson setJsonValue setNumber setNumberArray setObjectArray setString setStringArray shallowAssign stringify tryGetAnyJsonValueArray tryGetBoolean tryGetBooleanArray tryGetBooleanOrNull tryGetBooleanOrNullArray tryGetDate tryGetDateTime tryGetDecimal tryGetDefinedNumber tryGetElement tryGetElementArray tryGetGuid tryGetInteger tryGetJsonObject tryGetJsonObjectArray tryGetJsonValue tryGetNativeObject tryGetNumber tryGetNumberArray tryGetNumberOrNull tryGetNumberOrNullArray tryGetString tryGetStringArray tryGetStringOrNull tryGetStringOrNullArray tryGetUndefinableAnyJsonValueArray tryGetUndefinableBoolean tryGetUndefinableBooleanArray tryGetUndefinableBooleanOrNull tryGetUndefinableBooleanOrNullArray tryGetUndefinableDate tryGetUndefinableDateTime tryGetUndefinableDecimal tryGetUndefinableElement tryGetUndefinableElementArray tryGetUndefinableGuid tryGetUndefinableInteger tryGetUndefinableJsonObject tryGetUndefinableJsonObjectArray tryGetUndefinableNativeObject tryGetUndefinableNumber tryGetUndefinableNumberArray tryGetUndefinableNumberOrNull tryGetUndefinableNumberOrNullArray tryGetUndefinableString tryGetUndefinableStringArray tryGetUndefinableStringOrNull tryGetUndefinableStringOrNullArray

Constructors

constructor

new JsonElement(jsonObject?: Json | UndefinableJsonValueRecord): JsonElement
Parameters
- OptionaljsonObject: Json | UndefinableJsonValueRecord
Returns JsonElement

Accessors

json

get json(): Json
Returns Json

Methods

clear

clear(): void
Returns void

deepExtend

deepExtend(other: Json): void
Parameters
- other: Json
Returns void

forEach

forEach(callback: ForEachCallback): void
Parameters
- callback: ForEachCallback
Returns void

forEachBoolean

forEachBoolean(callback: ForEachBooleanCallback): void
Parameters
- callback: ForEachBooleanCallback
Returns void

forEachElement

forEachElement(callback: ForEachElementCallback): void
Parameters
- callback: ForEachElementCallback
Returns void

forEachNumber

forEachNumber(callback: ForEachNumberCallback): void
Parameters
- callback: ForEachNumberCallback
Returns void

forEachString

forEachString(callback: ForEachStringCallback): void
Parameters
- callback: ForEachStringCallback
Returns void

forEachValue

forEachValue(callback: ForEachValueCallback): void
Parameters
- callback: ForEachValueCallback
Returns void

getBoolean

getBoolean(name: string, defaultValue: boolean): boolean
Parameters
- name: string
- defaultValue: boolean
Returns boolean

getBooleanOrUndefined

getBooleanOrUndefined(name: string): undefined | boolean
Parameters
- name: string
Returns undefined | boolean

getDate

getDate(name: string, defaultValue: Date): Date
Parameters
- name: string
- defaultValue: Date
Returns Date

getDateTime

getDateTime(name: string, defaultValue: Date): Date
Parameters
- name: string
- defaultValue: Date
Returns Date

getDecimal

getDecimal(
    name: string,
    defaultValue: Decimal,
    decimalFactory: DecimalFactory,
): Decimal
Parameters
- name: string
- defaultValue: Decimal
- decimalFactory: DecimalFactory
Returns Decimal

getGuid

getGuid(name: string, defaultValue: string): string
Parameters
- name: string
- defaultValue: string
Returns string

getInteger

getInteger(name: string, defaultValue: number): number
Parameters
- name: string
- defaultValue: number
Returns number

getIntegerOrUndefined

getIntegerOrUndefined(name: string): undefined | number
Parameters
- name: string
Returns undefined | number

getNumber

getNumber(name: string, defaultValue: number): number
Parameters
- name: string
- defaultValue: number
Returns number

getNumberOrUndefined

getNumberOrUndefined(name: string): undefined | number
Parameters
- name: string
Returns undefined | number

getString

getString(name: string, defaultValue: string): string
Parameters
- name: string
- defaultValue: string
Returns string

getStringOrUndefined

getStringOrUndefined(name: string): undefined | string
Parameters
- name: string
Returns undefined | string

hasName

hasName(name: string): boolean
Parameters
- name: string
Returns boolean

newElement

newElement(name: string): JsonElement
Parameters
- name: string
Returns JsonElement

parse

parse(jsonText: string): Result<void, InvalidJsonText>
Parameters
- jsonText: string
Returns Result<void, InvalidJsonText>

setBoolean

setBoolean(name: string, value: undefined | boolean): void
Parameters
- name: string
- value: undefined | boolean
Returns void

setBooleanArray

setBooleanArray(name: string, value: undefined | boolean[]): void
Parameters
- name: string
- value: undefined | boolean[]
Returns void

setDate

setDate(name: string, value: undefined | Date): void
Parameters
- name: string
- value: undefined | Date
Returns void

setDateTime

setDateTime(name: string, value: undefined | Date): void
Parameters
- name: string
- value: undefined | Date
Returns void

setDecimal

setDecimal(name: string, value: undefined | Decimal): void
Parameters
- name: string
- value: undefined | Decimal
Returns void

setElement

setElement(name: string, value: undefined | JsonElement): void
Parameters
- name: string
- value: undefined | JsonElement
Returns void

setElementArray

setElementArray(name: string, value: undefined | JsonElement[]): void
Parameters
- name: string
- value: undefined | JsonElement[]
Returns void

setGuid

setGuid(name: string, value: undefined | string): void
Parameters
- name: string
- value: undefined | string
Returns void

setInteger

setInteger(name: string, value: undefined | number): void
Parameters
- name: string
- value: undefined | number
Returns void

setJson

setJson(name: string, value: undefined | Json): void
Parameters
- name: string
- value: undefined | Json
Returns void

setJsonValue

setJsonValue(name: string, value: undefined | JsonValue): void
Parameters
- name: string
- value: undefined | JsonValue
Returns void

setNumber

setNumber(name: string, value: undefined | number): void
Parameters
- name: string
- value: undefined | number
Returns void

setNumberArray

setNumberArray(name: string, value: undefined | number[]): void
Parameters
- name: string
- value: undefined | number[]
Returns void

setObjectArray

setObjectArray(name: string, value: undefined | Json[]): void
Parameters
- name: string
- value: undefined | Json[]
Returns void

setString

setString(name: string, value: undefined | string): void
Parameters
- name: string
- value: undefined | string
Returns void

setStringArray

setStringArray(name: string, value: undefined | string[]): void
Parameters
- name: string
- value: undefined | string[]
Returns void

shallowAssign

shallowAssign(element: undefined | JsonElement): void
Parameters
- element: undefined | JsonElement
Returns void

stringify

stringify(): string
Returns string

tryGetAnyJsonValueArray

tryGetAnyJsonValueArray(
name: string,
): Result<JsonValue[], JsonValueIsNotDefined | JsonValueIsNotAnArray>
Parameters
- name: string
Returns Result<JsonValue[], JsonValueIsNotDefined | JsonValueIsNotAnArray>

tryGetBoolean

tryGetBoolean(
name: string,
): Result<boolean, JsonValueIsNotDefined | JsonValueIsNotOfTypeBoolean>
Parameters
- name: string
Returns Result<boolean, JsonValueIsNotDefined | JsonValueIsNotOfTypeBoolean>

tryGetBooleanArray

tryGetBooleanArray(
    name: string,
): Result<
    boolean[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotABoolean,
>
Parameters
- name: string
Returns Result<
    boolean[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotABoolean,
>

tryGetBooleanOrNull

tryGetBooleanOrNull(
    name: string,
): Result<
    null
    | boolean,
    JsonValueIsNotDefined | JsonValueIsNotOfTypeBooleanOrNull,
>
Parameters
- name: string
Returns Result<
    null
    | boolean,
    JsonValueIsNotDefined | JsonValueIsNotOfTypeBooleanOrNull,
>

tryGetBooleanOrNullArray

tryGetBooleanOrNullArray(
    name: string,
): Result<
    (null | boolean)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotABooleanOrNull,
>
Parameters
- name: string
Returns Result<
    (null | boolean)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotABooleanOrNull,
>

tryGetDate

tryGetDate(
name: string,
): Result<Date, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<Date, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>

tryGetDateTime

tryGetDateTime(
name: string,
): Result<Date, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<Date, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>

tryGetDecimal

tryGetDecimal(
    name: string,
    decimalFactory: DecimalFactory,
): Result<
    Decimal,
    JsonValueIsNotDefined
    | DecimalJsonValueIsNotOfTypeString
    | InvalidDecimal,
>
Parameters
- name: string
- decimalFactory: DecimalFactory
Returns Result<
    Decimal,
    JsonValueIsNotDefined
    | DecimalJsonValueIsNotOfTypeString
    | InvalidDecimal,
>

tryGetDefinedNumber

tryGetDefinedNumber(
name: string,
): Result<undefined | number, JsonValueIsNotOfTypeNumber>
Parameters
- name: string
Returns Result<undefined | number, JsonValueIsNotOfTypeNumber>

tryGetElement

tryGetElement(
name: string,
): Result<JsonElement, ElementIsNotDefined | JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<JsonElement, ElementIsNotDefined | JsonValueIsNotOfTypeObject>

tryGetElementArray

tryGetElementArray(
    name: string,
): Result<
    JsonElement[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotAnObject,
>
Parameters
- name: string
Returns Result<
    JsonElement[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotAnObject,
>

tryGetGuid

tryGetGuid(
name: string,
): Result<string, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<string, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>

tryGetInteger

tryGetInteger(
name: string,
): Result<number, JsonValueIsNotDefined | JsonValueIsNotOfTypeNumber>
Parameters
- name: string
Returns Result<number, JsonValueIsNotDefined | JsonValueIsNotOfTypeNumber>

tryGetJsonObject

tryGetJsonObject(
name: string,
): Result<Json, JsonValueIsNotDefined | JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<Json, JsonValueIsNotDefined | JsonValueIsNotOfTypeObject>

tryGetJsonObjectArray

tryGetJsonObjectArray(
    name: string,
): Result<
    Json[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotJson,
>
Parameters
- name: string
Returns Result<
    Json[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotJson,
>

tryGetJsonValue

tryGetJsonValue(name: string): undefined | JsonValue
Parameters
- name: string
Returns undefined | JsonValue

tryGetNativeObject

tryGetNativeObject(
name: string,
): Result<object, JsonValueIsNotDefined | JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<object, JsonValueIsNotDefined | JsonValueIsNotOfTypeObject>

tryGetNumber

tryGetNumber(
name: string,
): Result<number, JsonValueIsNotDefined | JsonValueIsNotOfTypeNumber>
Parameters
- name: string
Returns Result<number, JsonValueIsNotDefined | JsonValueIsNotOfTypeNumber>

tryGetNumberArray

tryGetNumberArray(
    name: string,
): Result<
    number[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotANumber,
>
Parameters
- name: string
Returns Result<
    number[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotANumber,
>

tryGetNumberOrNull

tryGetNumberOrNull(
    name: string,
): Result<
    null
    | number,
    JsonValueIsNotDefined | JsonValueIsNotOfTypeNumberOrNull,
>
Parameters
- name: string
Returns Result<null | number, JsonValueIsNotDefined | JsonValueIsNotOfTypeNumberOrNull>

tryGetNumberOrNullArray

tryGetNumberOrNullArray(
    name: string,
): Result<
    (null | number)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotANumberOrNull,
>
Parameters
- name: string
Returns Result<
    (null | number)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotANumberOrNull,
>

tryGetString

tryGetString(
name: string,
): Result<string, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<string, JsonValueIsNotDefined | JsonValueIsNotOfTypeString>

tryGetStringArray

tryGetStringArray(
    name: string,
): Result<
    string[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotAString,
>
Parameters
- name: string
Returns Result<
    string[],
    | JsonValueIsNotDefined
    | JsonValueIsNotAnArray
    | JsonValueArrayElementIsNotAString,
>

tryGetStringOrNull

tryGetStringOrNull(
    name: string,
): Result<
    null
    | string,
    JsonValueIsNotDefined | JsonValueIsNotOfTypeStringOrNull,
>
Parameters
- name: string
Returns Result<null | string, JsonValueIsNotDefined | JsonValueIsNotOfTypeStringOrNull>

tryGetStringOrNullArray

tryGetStringOrNullArray(
    name: string,
): Result<
    (null | string)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotAStringOrNull,
>
Parameters
- name: string
Returns Result<
    (null | string)[],

        | JsonValueIsNotDefined
        | JsonValueIsNotAnArray
        | JsonValueArrayElementIsNotAStringOrNull,
>

tryGetUndefinableAnyJsonValueArray

tryGetUndefinableAnyJsonValueArray(
name: string,
): Result<undefined | JsonValue[], JsonValueIsNotAnArray>
Parameters
- name: string
Returns Result<undefined | JsonValue[], JsonValueIsNotAnArray>

tryGetUndefinableBoolean

tryGetUndefinableBoolean(
name: string,
): Result<undefined | boolean, JsonValueIsNotOfTypeBoolean>
Parameters
- name: string
Returns Result<undefined | boolean, JsonValueIsNotOfTypeBoolean>

tryGetUndefinableBooleanArray

tryGetUndefinableBooleanArray(
    name: string,
): Result<
    undefined
    | boolean[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotABoolean,
>
Parameters
- name: string
Returns Result<
    undefined
    | boolean[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotABoolean,
>

tryGetUndefinableBooleanOrNull

tryGetUndefinableBooleanOrNull(
name: string,
): Result<undefined | null | boolean, JsonValueIsNotOfTypeBooleanOrNull>
Parameters
- name: string
Returns Result<undefined | null | boolean, JsonValueIsNotOfTypeBooleanOrNull>

tryGetUndefinableBooleanOrNullArray

tryGetUndefinableBooleanOrNullArray(
    name: string,
): Result<
    undefined
    | (null | boolean)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotABooleanOrNull,
>
Parameters
- name: string
Returns Result<
    undefined
    | (null | boolean)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotABooleanOrNull,
>

tryGetUndefinableDate

tryGetUndefinableDate(
name: string,
): Result<undefined | Date, JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<undefined | Date, JsonValueIsNotOfTypeString>

tryGetUndefinableDateTime

tryGetUndefinableDateTime(
name: string,
): Result<undefined | Date, JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<undefined | Date, JsonValueIsNotOfTypeString>

tryGetUndefinableDecimal

tryGetUndefinableDecimal(
    name: string,
    decimalFactory: DecimalFactory,
): Result<
    undefined
    | Decimal,
    DecimalJsonValueIsNotOfTypeString | InvalidDecimal,
>
Parameters
- name: string
- decimalFactory: DecimalFactory
Returns Result<undefined | Decimal, DecimalJsonValueIsNotOfTypeString | InvalidDecimal>

tryGetUndefinableElement

tryGetUndefinableElement(
name: string,
): Result<undefined | JsonElement, JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<undefined | JsonElement, JsonValueIsNotOfTypeObject>

tryGetUndefinableElementArray

tryGetUndefinableElementArray(
    name: string,
): Result<
    undefined
    | JsonElement[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAnObject,
>
Parameters
- name: string
Returns Result<
    undefined
    | JsonElement[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAnObject,
>

tryGetUndefinableGuid

tryGetUndefinableGuid(
name: string,
): Result<undefined | string, JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<undefined | string, JsonValueIsNotOfTypeString>

tryGetUndefinableInteger

tryGetUndefinableInteger(
name: string,
): Result<undefined | number, JsonValueIsNotOfTypeNumber>
Parameters
- name: string
Returns Result<undefined | number, JsonValueIsNotOfTypeNumber>

tryGetUndefinableJsonObject

tryGetUndefinableJsonObject(
name: string,
): Result<undefined | Json, JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<undefined | Json, JsonValueIsNotOfTypeObject>

tryGetUndefinableJsonObjectArray

tryGetUndefinableJsonObjectArray(
    name: string,
): Result<
    undefined
    | Json[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotJson,
>
Parameters
- name: string
Returns Result<
    undefined
    | Json[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotJson,
>

tryGetUndefinableNativeObject

tryGetUndefinableNativeObject(
name: string,
): Result<undefined | object, JsonValueIsNotOfTypeObject>
Parameters
- name: string
Returns Result<undefined | object, JsonValueIsNotOfTypeObject>

tryGetUndefinableNumber

tryGetUndefinableNumber(
name: string,
): Result<undefined | number, JsonValueIsNotOfTypeNumber>
Parameters
- name: string
Returns Result<undefined | number, JsonValueIsNotOfTypeNumber>

tryGetUndefinableNumberArray

tryGetUndefinableNumberArray(
    name: string,
): Result<
    undefined
    | number[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotANumber,
>
Parameters
- name: string
Returns Result<
    undefined
    | number[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotANumber,
>

tryGetUndefinableNumberOrNull

tryGetUndefinableNumberOrNull(
name: string,
): Result<undefined | null | number, JsonValueIsNotOfTypeNumberOrNull>
Parameters
- name: string
Returns Result<undefined | null | number, JsonValueIsNotOfTypeNumberOrNull>

tryGetUndefinableNumberOrNullArray

tryGetUndefinableNumberOrNullArray(
    name: string,
): Result<
    undefined
    | (null | number)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotANumberOrNull,
>
Parameters
- name: string
Returns Result<
    undefined
    | (null | number)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotANumberOrNull,
>

tryGetUndefinableString

tryGetUndefinableString(
name: string,
): Result<undefined | string, JsonValueIsNotOfTypeString>
Parameters
- name: string
Returns Result<undefined | string, JsonValueIsNotOfTypeString>

tryGetUndefinableStringArray

tryGetUndefinableStringArray(
    name: string,
): Result<
    undefined
    | string[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAString,
>
Parameters
- name: string
Returns Result<
    undefined
    | string[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAString,
>

tryGetUndefinableStringOrNull

tryGetUndefinableStringOrNull(
name: string,
): Result<undefined | null | string, JsonValueIsNotOfTypeStringOrNull>
Parameters
- name: string
Returns Result<undefined | null | string, JsonValueIsNotOfTypeStringOrNull>

tryGetUndefinableStringOrNullArray

tryGetUndefinableStringOrNullArray(
    name: string,
): Result<
    undefined
    | (null | string)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAStringOrNull,
>
Parameters
- name: string
Returns Result<
    undefined
    | (null | string)[],
    JsonValueIsNotAnArray | JsonValueArrayElementIsNotAStringOrNull,
>