parse-json-object

Parse a typed JSON object.

_If I should maintain this repo, please ⭐️_

_DM me on Twitter if you have questions or suggestions._

---

- Returns undefined if unable to parse
- Returns value if successful

Installation

``sh
yarn add parse-json-object
`

`sh
npm install parse-json-object
`

`sh
pnpm add parse-json-object
`

Usage

$3

parseJSONObject('{"a": 1}'); // { a: 1 }
parseJSONArray("[1, 2, 3]"); // [1, 2, 3]
parseString('"hello"'); // "hello"
`

Additionally, a parse function is provided, which takes a function to validate the parsed value. This can be easily used with zod to validate more complex types:
`ts
import { parse } from "parse-json-object";
import z from "zod";

const schema = z.object({
a: z.number(),
b: z.string()
});

parse('{ a: 1, b: "hello" }', schema); // { a: 1, b: 'hello' }

`

A custom typeguard can also be used:

`ts
import { parse } from "parse-json-object";

function isNumber(value: unknown): value is number {
return typeof value === "number";
}

parse("1", isNumber); // 1
parse("not a number", isNumber); // undefined
``

Dependencies

- is-zod: Typeguard to check if a value matches a zod schema
- types-json: Type checking for JSON values

Dev Dependencies

- autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
- zod: TypeScript-first schema declaration and validation library with static type inference

License

MIT

Related Packages:

- stringify-json-object: Stringify and format a JSON object
- types-json: Type checking for JSON objects