Variable traverse_jsonishConst

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: MaybeJsonish, path: Path, value: MaybeJsonish, creator?: ((next: PathSegment) => Jsonish)) => MaybeJsonish)

  • • (root: MaybeJsonish, path: Path, value: MaybeJsonish, creator?: ((next: PathSegment) => Jsonish)): MaybeJsonish

    • Traverses root with the given path, creating missing members and elements as required, setting the final value to value

      Parameters

      • root: MaybeJsonish

      • path: Path

      • value: MaybeJsonish

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

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

        • • (next: PathSegment): Jsonish

          • Parameters

            • next: PathSegment

            Returns Jsonish

      Returns MaybeJsonish

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

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

    • Traverses root with the given path, creating missing members and elements as required, and applies update to the final value.

      Returns

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

      Parameters

      • root: MaybeJsonish

      • path: Path

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

        accepts the current value and returns the resulting value

        • • (value: MaybeJsonish): MaybeJsonish

          • Parameters

            • value: MaybeJsonish

            Returns MaybeJsonish

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

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

        • • (next: PathSegment): Jsonish

          • Parameters

            • next: PathSegment

            Returns Jsonish

      Returns MaybeJsonish