Variable JSONObjectOpsConst

Type Declaration

• clone: function

  • clone<T extends JSONObject = JSONObject>(obj: T): T

    Creates a deep copy of a JSON object via JSON serialization.

    Type Parameters

    • T extends JSONObject = JSONObject

    Parameters

    • obj: T

    Returns T

• getByPath: function

  • getByPath(obj: JSONObject, path: string): JSONValueOrUndefined

    Returns undefined if the path does not exist. Object and array values are returned by reference, not cloned.

    Parameters

    • obj: JSONObject
    • path: string

    Returns JSONValueOrUndefined

• setByPath: function

  • setByPath(obj: JSONObject, path: string, value: JSONValue): void

    Creates missing intermediate containers automatically. Mutates obj in place.

    This operation is transactional: if it throws, the object is left unchanged.

    Parameters

    • obj: JSONObject
    • path: string
    • value: JSONValue

    Returns void

    Throws

    • PathConflictError: If the path conflicts with an existing non-container value or an invalid array index.

• update: function

  • update(obj: JSONObject, update: JSONUpdate): void

    Mutates obj in place.

    This operation is non-transactional: updates are applied one by one, and if a later update throws, earlier changes remain in place.

    Parameters

    • obj: JSONObject
    • update: JSONUpdate

    Returns void

    Throws

    Propagates errors thrown by setByPath.