> For the complete documentation index, see [llms.txt](https://mgcrea.gitbook.io/redux-rest-resource/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mgcrea.gitbook.io/redux-rest-resource/basics/actions.md).

# Actions

**Actions** are payloads of information that send data from your application to your store.

**Action creators** are functions that create actions. It's easy to conflate the terms “action” and “action creator,” so do your best to use the proper term.

## Provided action creators

**Redux REST Resource** gives you ready-to-use action creators that will dispatch associated actions. Out of the box, you have the following actions configured:

```javascript
const {types, actions, reducers} = createResource({name: 'user', url: 'localhost:9000/api'});

Object.keys(actions) ==
  ['createUser', 'fetchUsers', 'getUser', 'updateUser', 'updateUsers', 'deleteUser', 'deleteUsers'];
```

> You can check the [default actions configuration](/redux-rest-resource/defaults/defaultactions.md)

## Available options

You can configure/override actions actions when using `createResource`:

Every configuration can be specified at either a global level:

```javascript
createResource({
  name: 'user',
  url: `foo.com/users/:id`,
  headers: {Authorization: 'Bearer foobar'}
});
```

Or at the action level:

```javascript
createResource({
  name: 'user',
  url: `foo.com/users/:id`,
  actions: {
    update: {
      method: 'POST'
    }
  }
});
```

#### Fetch related options

| Option name   | Type                | Default    | Description              | Example                         |
| ------------- | ------------------- | ---------- | ------------------------ | ------------------------------- |
| `url`         | *String / Function* | *Required* | Base URL to fetch        | `"https://foo.com/users/:id"`   |
| `method`      | *String / Function* | `"GET"`    | HTTP method              | `"PATCH"`                       |
| `headers`     | *Object / Function* | {}         | Headers to be sent along | `{Authorization: 'Bearer foo'}` |
| `query`       | *Object / Function* | {}         | Query params             | `{from: 10, until: 20}`         |
| `credentials` | *String / Function* | undefined  | Credentials              | `"include"`                     |
| `body`        | *String / Function* | undefined  | HTTP body override       | `{foo: 'bar'}`                  |

Every option also accept a function that will receive the `getState` helper, to act against the current state.

```javascript
export const {types, actions, reducers} = createResource({
  name: 'user',
  url: `foo.com/users/:id`,
  actions: {
    update: {
      method: (getState, {actionId, context, contextOpts}) => 'POST'
    }
  }
});
```

Every option can also be used at action call-time:

```javascript
export const {types, actions, reducers} = createResource({
  name: 'user',
  url: `foo.com/users/:id`
});
actions.updateUser(
  {
    id: '5925b7f7d9808600076ce557',
    firstName: 'Olivier'
  },
  {
    query: {
      foo: 'bar'
    },
    credentials: 'include'
  }
);
```

#### Reduce related options

| Option name      | Type      | Default | Description                               |
| ---------------- | --------- | ------- | ----------------------------------------- |
| `isArray`        | *Boolean* | false   | Whether the expected response is an Array |
| `assignResponse` | *Boolean* | false   | Whether to assign the response            |
| `isPure`         | *Boolean* | false   | Whether to skip the HTTP request          |

### Dispatched actions

We're using a dedicated `status` field in our actions to reflect the Promise state.

For instance, `fetchUsers()` will dispatch the following actions:

```javascript
// Dispatched actions by the `fetchUsers` action creator
// First a `pending` action is dispatched
{type: '@@resource/USER/FETCH', status: 'pending', context}
// then either a `resolved` action on success
{type: '@@resource/USER/FETCH', status: 'resolved', context, options, body, receivedAt, headers}
// or a `rejected` action if an error is caught
{type: '@@resource/USER/FETCH', status: 'rejected', context, options, err, receivedAt}
```

Every REST action creator will dispatch at most two actions based on the async status of the request.