Variable traverse_jsonConst

Type declaration

• delete: { (root: MaybeJson, path: Path): MaybeJson; (root: MaybeJsonish, path: Path): MaybeJsonish }

  • • (root: MaybeJson, path: Path): MaybeJson

    • Traverses root with the given path, deleting the last item if it exists

      Returns

      the original input, or undefined if path was empty

      Parameters

      • root: MaybeJson

      • path: Path

      Returns MaybeJson

    • (root: MaybeJsonish, path: Path): MaybeJsonish

    • Traverses root with the given path, deleting the last item if it exists

      Returns

      the original input, or undefined if path was empty

      Parameters

      • root: MaybeJsonish

      • path: Path

      Returns MaybeJsonish

• get: { (root: MaybeJson, path: Path): MaybeJson; (root: MaybeJsonish, path: Path): MaybeJsonish }

  • • (root: MaybeJson, path: Path): MaybeJson

    • Returns the value resulting from traversing root with the given path

      Parameters

      • root: MaybeJson

      • path: Path

      Returns MaybeJson

    • (root: MaybeJsonish, path: Path): MaybeJsonish

    • Returns the value resulting from traversing root with the given path

      Parameters

      • root: MaybeJsonish

      • path: Path

      Returns MaybeJsonish

• has: { (root: MaybeJson, path: Path): boolean; (root: MaybeJsonish, path: Path): boolean }

  • • (root: MaybeJson, path: Path): boolean

    • Traverses root with the given path, returning true if the entire path exists

      Parameters

      • root: MaybeJson

      • path: Path

      Returns boolean

    • (root: MaybeJsonish, path: Path): boolean

    • Traverses root with the given path, returning true if the entire path exists

      Parameters

      • root: MaybeJsonish

      • path: Path

      Returns boolean

• set: ((root: MaybeJson, path: Path, value: MaybeJson, creator?: ((next: PathSegment) => Json)) => MaybeJson)

  • • (root: MaybeJson, path: Path, value: MaybeJson, creator?: ((next: PathSegment) => Json)): MaybeJson

    • Traverses root with the given path, creating missing members and elements as required, setting the final value to value. If value is undefined, then the leaf node is deleted and any generated parents are discarded

      Parameters

      • root: MaybeJson

      • path: Path

      • value: MaybeJson

      • Optional creator: ((next: PathSegment) => Json)

        optional method for creating missing parents as a path is constructed. default is creator_err_object

        • • (next: PathSegment): Json

          • Parameters

            • next: PathSegment

            Returns Json

      Returns MaybeJson

• update: ((root: MaybeJson, path: Path, update: ((value: MaybeJson) => MaybeJson), creator?: ((next: PathSegment) => Json)) => MaybeJson)

  • • (root: MaybeJson, path: Path, update: ((value: MaybeJson) => MaybeJson), creator?: ((next: PathSegment) => Json)): MaybeJson

    • Traverses root with the given path, creating missing members and elements as required, and applies update to the final value. Note: if update returns undefined, the leaf node is deleted and any generated parents are discarded

      Returns

      the original (but modified) root, or the result of updating the original root if path is empty

      Parameters

      • root: MaybeJson

      • path: Path

      • update: ((value: MaybeJson) => MaybeJson)

        accepts the current value and returns the resulting value

        • • (value: MaybeJson): MaybeJson

          • Parameters

            • value: MaybeJson

            Returns MaybeJson

      • Optional creator: ((next: PathSegment) => Json)

        optional method for creating missing parents as a path is constructed. default is creator_err_object

        • • (next: PathSegment): Json

          • Parameters

            • next: PathSegment

            Returns Json

      Returns MaybeJson