# json-string-values-parser

> Recursively traverse JSON properties and call transformation function on the value

Latest version **0.2.0** (published 2023-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install json-string-values-parser
pnpm add json-string-values-parser
yarn add json-string-values-parser
bun add json-string-values-parser
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2023-07-08 |
| First published | 2023-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 17.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | alxevvv |
| Maintainers | alxevvv |
| Keywords | json, parser |

## Links

- npm: https://www.npmjs.com/package/json-string-values-parser
- Repository: https://github.com/alxevvv/json-string-values-parser
- Homepage: https://github.com/alxevvv/json-string-values-parser#readme
- Issues: https://github.com/alxevvv/json-string-values-parser/issues
- npm.io page: https://npm.io/package/json-string-values-parser

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.2.0 (latest) — 2023-07-08
- 0.1.1 — 2023-06-07
- 0.1.0 — 2023-06-06

## README

# json-string-values-parser

Recursively traverse JSON properties and call transformation function on the value.

## Example

```typescript
import { jsonParseStringValues } from "json-string-values-parser";

const source = {
  a: "1",
  b: "false",
  c: "string",
  d: "null",
  e: "undefined",
};

const result = jsonParseStringValues(source);

console.log(result);

/*
{
  a: 1,
  b: false,
  c: "string",
  d: null,
  e: "undefined",
}
*/
```

## Install

```
npm install json-string-values-parser
```

## API

### Function

```typescript
import { jsonParseStringValues } from "json-string-values-parser";

jsonParseStringValues(source, options); // options is optional
```

### Class instantiation

```typescript
import { JsonStringValuesParser } from "json-string-values-parser";

const parser = new JsonStringValuesParser(options); // options is optional

parser.parse(source);
```

### Options

All options are optional.

#### `options.nullValues: string[] | false`

String values converted to `null`.

- If set to `false`, conversion won't happen.
- If omitted, `JSON.parse` will be applied (`"null"` will become `null`).
- If passed array, only values from the array will be converted to `null`.

#### `options.falseValues: string[] | false`

String values converted to `false`.

- If set to `false`, conversion won't happen.
- If omitted, `JSON.parse` will be applied (`"false"` will become `false`).
- If passed array, only values from the array will be converted to `false`.

#### `options.trueValues: string[] | false`

String values converted to `true`.

- If set to `false`, conversion won't happen.
- If omitted, `JSON.parse` will be applied(`"true"` will become `true`).
- If passed array, only values from the array will be converted to `true`.

#### `options.parseNumbers: boolean`

> default: `true`

Try to convert string to number using `JSON.parse` method.

#### `options.arrayDelimiter`

Array delimiter. If set, string will be splitted into array by given pattern(s).
Array values will be parsed again.

```typescript
jsonParseStringValues("1, 2, 3", { arrayDelimiter: ", " });
// returns [1, 2, 3]
```

## License

Licensed under the MIT license. Copyright (c) 2023-present Vladislav Alexeev

---
_Source: https://npm.io/package/json-string-values-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._