JSONExt | @lumino/coreutils

The namespace for JSON-specific functions.

Index

Variables

Functions

Variables

Const emptyArray

emptyArray: ReadonlyJSONArray = Object.freeze([]) as ReadonlyJSONArray

A shared frozen empty JSONArray

Const emptyObject

emptyObject: ReadonlyJSONObject = Object.freeze({}) as ReadonlyJSONObject

A shared frozen empty JSONObject

Functions

deepCopy

deepCopy<T>(value: T): T

- Defined in packages/coreutils/src/json.ts:228
Create a deep copy of a JSON value.

Type parameters
- T: ReadonlyPartialJSONValue
Parameters
- value: T
  
  The JSON value to copy.
Returns T

A deep copy of the given JSON value.

deepEqual

deepEqual(first: ReadonlyPartialJSONValue, second: ReadonlyPartialJSONValue): boolean

- Defined in packages/coreutils/src/json.ts:183
Compare two JSON values for deep equality.

Parameters
- first: ReadonlyPartialJSONValue
  
  The first JSON value of interest.
- second: ReadonlyPartialJSONValue
  
  The second JSON value of interest.
Returns boolean

true if the values are equivalent, false otherwise.

isArray

isArray(value: JSONValue): value is JSONArray
isArray(value: ReadonlyJSONValue): value is ReadonlyJSONArray
isArray(value: PartialJSONValue): value is PartialJSONArray
isArray(value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONArray

- Defined in packages/coreutils/src/json.ts:145
Test whether a JSON value is an array.

Parameters
- value: JSONValue
  
  The JSON value of interest.
Returns value is JSONArray

true if the value is a an array, false otherwise.
- Defined in packages/coreutils/src/json.ts:146
Parameters
- value: ReadonlyJSONValue
Returns value is ReadonlyJSONArray
- Defined in packages/coreutils/src/json.ts:147
Parameters
- value: PartialJSONValue
Returns value is PartialJSONArray
- Defined in packages/coreutils/src/json.ts:148
Parameters
- value: ReadonlyPartialJSONValue
Returns value is ReadonlyPartialJSONArray

isObject

isObject(value: JSONValue): value is JSONObject
isObject(value: ReadonlyJSONValue): value is ReadonlyJSONObject
isObject(value: PartialJSONValue): value is PartialJSONObject
isObject(value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONObject

- Defined in packages/coreutils/src/json.ts:162
Test whether a JSON value is an object.

Parameters
- value: JSONValue
  
  The JSON value of interest.
Returns value is JSONObject

true if the value is a an object, false otherwise.
- Defined in packages/coreutils/src/json.ts:163
Parameters
- value: ReadonlyJSONValue
Returns value is ReadonlyJSONObject
- Defined in packages/coreutils/src/json.ts:166
Parameters
- value: PartialJSONValue
Returns value is PartialJSONObject
- Defined in packages/coreutils/src/json.ts:167
Parameters
- value: ReadonlyPartialJSONValue
Returns value is ReadonlyPartialJSONObject

isPrimitive

isPrimitive(value: ReadonlyPartialJSONValue): value is JSONPrimitive

- Defined in packages/coreutils/src/json.ts:127
Test whether a JSON value is a primitive.

Parameters
- value: ReadonlyPartialJSONValue
  
  The JSON value of interest.
Returns value is JSONPrimitive

true if the value is a primitive,false otherwise.

Index

Variables

Functions

Variables

Const emptyArray

Const emptyObject

Functions

deepCopy

Type parameters

T: ReadonlyPartialJSONValue

Parameters

value: T

Returns T

deepEqual

Parameters

first: ReadonlyPartialJSONValue

second: ReadonlyPartialJSONValue

Returns boolean

isArray

Parameters

value: JSONValue

Returns value is JSONArray

Parameters

value: ReadonlyJSONValue

Returns value is ReadonlyJSONArray

Parameters

value: PartialJSONValue

Returns value is PartialJSONArray

Parameters

value: ReadonlyPartialJSONValue

Returns value is ReadonlyPartialJSONArray

isObject

Parameters

value: JSONValue

Returns value is JSONObject

Parameters

value: ReadonlyJSONValue

Returns value is ReadonlyJSONObject

Parameters

value: PartialJSONValue

Returns value is PartialJSONObject

Parameters

value: ReadonlyPartialJSONValue

Returns value is ReadonlyPartialJSONObject

isPrimitive

Parameters

value: ReadonlyPartialJSONValue

Returns value is JSONPrimitive