# @atomico/store

{% embed url="<https://github.com/atomicojs/store>" %}

### @atomico/store is Naturally asynchronous.

```typescript
interface State {
  api: string;
  loading: boolean;
  products: { id: number; title: string; price: number };
}

const initialState = (state: State) => ({
  api: "",
  loading: false,
  products: [],
});

async function* getProducts(state: State) {
  yield { ...state, loading: true };
  return {
    ...(yield),
    loading: false,
    products: await (await fetch(state.api)).json(),
  };
}

const store = new Store(initialState, {
  actions: { getProducts },
});
```

### Objectives

1. Asynchrony management.
2. Finitely predictable asynchrony.
3. Modularity and composition.

#### Asynchrony management

Application events and service calls are naturally asynchronous, with @atomico/store you can use asynchronous functions or asynchronous generators to define the update cycle.

**update cycle?** By this I mean the states that occur sequentially when dispatching the action, example:

```typescript
async function* getProducts(state: State) {
  yield { ...state, loading: true };
  return {
    ...(yield),
    loading: false,
    products: await (await fetch(state.api)).json(),
  };
}
```

The previous action will generate 2 states when dispatched:

1. state 1:`{loading: true, products:[]}`
2. state 2: `{loading: false, products:[...product]}`

The advantage of this is that the process is clearly observable by the store and by whoever dispatches the action.

#### Finitely predictable asynchrony

Every action in @atomico/store is wrapped in a promise that defines when it ends its cycle, this will let you execute actions sequentially, example:

```typescript
await store.actions.orderyBy();
await store.actions.insert({ id: 1000 });
await store.actions.updateAll();
```

#### Modularity and composition

@atomico/store allows to decouple the actions and the state of the store, for a better modularization , example:

{% tabs %}
{% tab title="actions.js" %}

```typescript
export interface State {
  api: string;
  loading: boolean;
  products: { id: number; title: string; price: number };
}

export const initialState = (state: State) => ({
  api: "",
  loading: false,
  products: [],
});

export async function* getProducts(state: State) {
  yield { ...state, loading: true };
  return {
    ...(yield),
    loading: false,
    products: await (await fetch(state.api)).json(),
  };
}
```

{% endtab %}

{% tab title="store.js" %}

```typescript
import * as Actions from "./actions";

export default new Store(Actions.initialStore, { actions: { Actions } });
```

{% endtab %}
{% endtabs %}

### API

{% content-ref url="/pages/CTgFqLguFrtKSHWxGm69" %}
[Store](/doc/packages/atomico-store/store.md)
{% endcontent-ref %}

{% content-ref url="/pages/VUd4GqfWHyPdhjp06rmT" %}
[Broken mention](broken://pages/VUd4GqfWHyPdhjp06rmT)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://atomico.gitbook.io/doc/packages/atomico-store.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.