@bemedev/decompose/README.md

Decompose object and so more

# @bemedev/decompose

Utility library for decomposing and recomposing objects in
JavaScript/TypeScript.

## Installation

```bash
npm install @bemedev/decompose
# or
pnpm add @bemedev/decompose
# or
yarn add @bemedev/decompose
```

## Usage

```typescript
import {
  decompose,
  decomposeKeys,
  decomposeSV,
  recompose,
} from '@bemedev/decompose';

const obj = {
  data: {
    name: {
      firstName: 'John',
      lastName: 'Doe',
    },
  },
};

const decomposed = decompose(obj);
// Result: { 'data.name.firstName': 'John', 'data.name.lastName': 'Doe' }

const recomposed = recompose(decomposed);
// Returns original object structure

const keys = decomposeKeys(obj);
// Result: ['data', 'data.name', 'data.name.firstName', 'data.name.lastName']

const sv = {
  red: {
    walk: 'stop',
  },
};

const decomposedSV = decomposeSV(sv);
// Result: ['red', 'red.walk', 'red.walk.stop']
```

### Arrays and tuples (v2.0.0+)

```typescript
const objWithArray = {
  users: [{ name: 'Alice' }, { name: 'Bob' }],
};

const decomposed = decompose(objWithArray);
// Result: { 'users.0.name': 'Alice', 'users.1.name': 'Bob' }
```

Nested tuples and optional properties are fully supported in the
`Decompose` type.

### `getByKey`

Retrieves a value from an object using a dot-notation key.

```typescript
import { getByKey } from '@bemedev/decompose';

const obj = {
  data: {
    name: {
      firstName: 'John',
      lastName: 'Doe',
    },
  },
};

getByKey(obj, 'data.name.firstName'); // 'John'
getByKey(obj, 'data.name.lastName'); // 'Doe'

// Works with array indices too
const arr = { users: [{ name: 'Alice' }, { name: 'Bob' }] };

getByKey(arr, 'users.[0].name'); // 'Alice'
getByKey(arr, 'users.[1].name'); // 'Bob'
```

#### Typed variants

`getByKey.typed` preserves the full TypeScript type including `undefined`:

```typescript
const val = getByKey.typed(obj, 'data.name.firstName');
// type: string | undefined
```

`getByKey.defined` strips `undefined` from the return type (non-nullable):

```typescript
const val = getByKey.defined(obj, 'data.name.firstName');
// type: string
```

### `assignByKey`

Assigns a value to a path in an object using a dot-notation key. Creates
intermediate objects or arrays as needed.

```typescript
import { assignByKey } from '@bemedev/decompose';

const obj = { data: { name: { firstName: 'John' } } };

const updated = assignByKey(obj, 'data.name.firstName', 'Jane');
// Result: { data: { name: { firstName: 'Jane' } } }

// Works with array indices too
const arr = { users: [{ name: 'Alice' }] };
const updated2 = assignByKey(arr, 'users.[0].name', 'Bob');
// Result: { users: [{ name: 'Bob' }] }
```

## [CHANGELOG](https://github.com/chlbri/decompose/blob/main/CHANGELOG.md)

## License

MIT

## Auteur

chlbri (bri_lvi@icloud.com)

[My github](https://github.com/chlbri?tab=repositories)

[<svg width="98" height="96" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="#24292f"/></svg>](https://github.com/chlbri?tab=repositories)

<br/>

## Liens

- [Documentation](https://github.com/chlbri/decompose)