object-standard-path/README.md

Safely get/set deep nested properties with standard path, strong type support

![title](media/repo-header.svg)

<p align="center">
<a href="https://github.com/react-earth/object-standard-path" target="\_parent"><img alt="star" src="https://img.shields.io/github/stars/react-earth/object-standard-path.svg?style=social&label=Star" /></a>
<a href="https://www.npmjs.com/package/object-standard-path" target="\_parent"><img src="https://img.shields.io/npm/v/object-standard-path" alt="version"></a>
<a href="https://www.npmjs.com/package/object-standard-path" target="\_parent"><img alt="minzip" src="https://img.badgesize.io/https:/unpkg.com/object-standard-path@latest/dist/index.esm.js?compression=gzip" /></a>
<a href="https://www.npmjs.com/package/object-standard-path" target="\_parent"><img alt="downloads" src="https://img.shields.io/npm/dm/object-standard-path.svg" /></a>
<a href="https://github.com/react-earth/object-standard-path" target="\_parent"><img alt="license" src="https://img.shields.io/npm/l/object-standard-path" /></a>
</p>

## Quick Features 🥳

- Standard path, e.g. `a.b.c[0].d`.
- Provider types & utils: Path, PathValue, pathGet, pathSet, pathSetImmutable.
- Built with typescript, provide type protection, code autocompletion, make your app robust.
- No dependencies, less than 1kB page size.

## How to use 📖

### Install package

```shell
npm install object-standard-path
```

### Use types: Path, PathValue

```typescript
import { Path, PathValue } from 'object-standard-path';

type Test = {
  value: string;
  array: {
    value: string;
  }[];
};

type TestPath = Path<Test>;
// result: "value" | "array" | `array[${number}]` | `array[${number}].value`

type TestPathValue = PathValue<Test, 'array[0]'>;
// result: { value: string }
```

### Use utils: pathGet, pathSet, pathSetImmutable

```typescript
import { pathGet, pathSet, pathSetImmutable } from 'object-standard-path';

const object = {
  array: [
    {
      value: 1,
    },
  ],
};

const result = pathGet(object, 'array[0].value');
// result: 1

pathSet(object, 'array[0].value', 2);
// object: { array: [{ value: 2 }] }

const result = pathSetImmutable(object, 'array[0].value', 2);
// result: { array: [{ value: 2 }] }
```

**Notes: please don't include the characters `.[]` in the key of the object, as they may affect parsing.**