@rtorcato/js-common / json

json

Functions

safeJsonParse()

safeJsonParse<T>(str, fallback?): T | null

Defined in: json/index.ts:16

Safely parses a JSON string, returning a fallback value if parsing fails.

Example

safeJsonParse('{"a":1}') // { a: 1 }
safeJsonParse('{oops') // null
safeJsonParse('{oops', {}) // {}

Type Parameters

T

T = any

Parameters

str

string

The JSON string to parse.

fallback?

T | null

The value to return if parsing fails.

Returns

T | null

The parsed object or the fallback value.

---

safeJsonStringify()

safeJsonStringify(value, fallback?): string | null

Defined in: json/index.ts:42

Safely stringifies a value to JSON, returning a fallback value if stringification fails.

Example

safeJsonStringify({ a: 1 }) // '{"a":1}'

const circular: any = {}
circular.self = circular
safeJsonStringify(circular) // null
safeJsonStringify(circular, '{}') // '{}'

Parameters

value

any

The value to stringify.

fallback?

string | null

The value to return if stringification fails.

Returns

string | null

The JSON string or the fallback value.

---

isValidJson()

isValidJson(str): boolean

Defined in: json/index.ts:63

Checks if a string is valid JSON.

Example

isValidJson('{"a":1}') // true
isValidJson('[1,2]') // true
isValidJson('{oops') // false

Parameters

str

string

The string to check.

Returns

boolean

True if the string is valid JSON, false otherwise.