# afo-state

> Already Figured Out State Bootstraps/provides helpers for reducers/state management. Use it to easily manage normalized relational data, such as from an RDB.

Latest version **1.0.4** (published 2023-07-07) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install afo-state
pnpm add afo-state
yarn add afo-state
bun add afo-state
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-07-07 |
| First published | 2023-07-03 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Unbound LLC |
| Maintainers | richardarosenthal |
| Keywords | Already Figured Out, redux, easy-reducer, state management, it just works, easy redux, easy reducers, frontend rdb, react state management, easy, reducer |

## Links

- npm: https://www.npmjs.com/package/afo-state
- npm.io page: https://npm.io/package/afo-state

## Alternatives

- [@reckona/mreact-store](https://npm.io/package/@reckona/mreact-store.md) — 976 weekly downloads
- [regular-state](https://npm.io/package/regular-state.md) — 410 weekly downloads
- [@pacote/flux-actions](https://npm.io/package/@pacote/flux-actions.md) — 65 weekly downloads
- [@pilotlab/lux-debug](https://npm.io/package/@pilotlab/lux-debug.md) — 39 weekly downloads
- [vue-persist-state](https://npm.io/package/vue-persist-state.md) — 19 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2023-07-07
- 1.0.2 — 2023-07-05
- 1.0.1 — 2023-07-03
- 1.0.0 — 2023-07-03

## README

# Already Figured Out State

A convenient library for managing centralized state in Typescript/JS

## Reducer Helper Functions

### InsertOrUpdate

```
    const state = {
        entities: {
        1: { id: 1, name: "one" },
        3: { id: 3, name: "three" },
        },
        order: [1, 3],
    };

    const newObject = { id: 2, name: "two" };
    const newState = insertOrUpdate(
        state,
        newObject
    );

```

**newState** will now be:

```
{
        entities: {
        1: { id: 1, name: "one" },
        3: { id: 3, name: "three" },
        2: newObject,
        },
        order: [1, 3, 2],
    }
```

### InsertOrUpdateMultiple

```
    const state = {
        entities: {
        1: { id: 1, name: "one" },
        3: { id: 3, name: "three" },
        },
        order: [1, 3],
    };

    // object with id 2 does not exist yet
    const newObject = { id: 2, name: "two" };

    // object id 1 already exists in the store
    const updatedObject = { id: 1, name: "Fancy new title" };
    const newState = insertOrUpdateMultiple(
        state,
        [newObject, updatedObject]
    );

```

**newState** will now be:

```
{
        entities: {
        1: { id: 1, name: "Fancy new title" },
        3: { id: 3, name: "three" },
        2: { id: 2, name: "two" },
        },
        order: [1, 3, 2],
    }
```

## Selector Functions

### selectById

**selectById** will select entities by their id. If you only pass a single id (not wrapped in an array) it will return a single object. Note that this behavior does not apply to other select functions, because no other key is unique

```
const state = {
entities: {
1: { id: 1, name: "one" },
2: { id: 2, name: "two" },
3: { id: 3, name: "three" },
},
order: [1, 2, 3],
};

// returns { id: 1, name: "one" }
const singleResultId = selectById(state, 1);


// returns [ { id: 2, name: "two" }, { id: 3, name: "three" } ]
const multiIdResult = selectById(state, [2,3]);


// returns undefined
const noResult = selectByFunction(state, 5);
```

### selectByProp

**selectByProp** will select from the store according to a filter function. The function receives the object, the larger store, and the index of the object in the order

```
const state = {
entities: {
1: { id: 1, name: "one" },
2: { id: 2, name: "two" },
3: { id: 3, name: "three" },
},
order: [1, 2, 3],
};

// returns [{ id: 1, name: "one" }]
const singleResultId = selectByProp(state, id, 1);


// returns [ { id: 2, name: "two" }, { id: 3, name: "three" } ]
const multiplePropValues = selectByProp(state, "name", ["two","three"]);


// returns []
const noResult = selectByProp(state, ({ id }) => id == 5);
```

### selectByFunction

_selectByFunction_ will select from the store according to a filter function. The function receives the object, the larger store, and the index of the object in the order

```
const state = {
entities: {
1: { id: 1, name: "one" },
2: { id: 2, name: "two" },
3: { id: 3, name: "three" },
},
order: [1, 2, 3],
};

// returns [{ id: 1, name: "one" }]
const singleResultId = selectByFunction(state, ({ id }) => id == 1);


// returns [ { id: 2, name: "two" }, { id: 3, name: "three" } ]
const multiResult = selectByFunction(state, ({ id }) => id > 1);


// returns []
const noResult = selectByFunction(state, ({ id }) => id == 5);
```

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