# @devexperts/remote-data-ts

> RemoteData type

Latest version **2.1.1** (published 2021-09-09) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install @devexperts/remote-data-ts
pnpm add @devexperts/remote-data-ts
yarn add @devexperts/remote-data-ts
bun add @devexperts/remote-data-ts
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-09-09 |
| First published | 2018-03-13 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 104.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 296 |
| Author | devexperts |
| Maintainers | eugryumov, anikolaenkov, raveclassic, dx-owner, mankdev, devexperts-bot, korol, sutarmin, dmkokovtsev |
| Keywords | typescript, algebraic-data-types, functional-programming |

## Links

- npm: https://www.npmjs.com/package/@devexperts/remote-data-ts
- Repository: https://github.com/devexperts/remote-data-ts
- Homepage: https://github.com/devexperts/remote-data-ts#readme
- Issues: https://github.com/devexperts/remote-data-ts/issues
- npm.io page: https://npm.io/package/@devexperts/remote-data-ts

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 2.1.1 (latest) — 2021-09-09
- 2.1.0 — 2021-09-07
- 2.0.5 — 2021-02-08
- 2.0.4 — 2020-08-11
- 2.0.3 — 2020-01-24
- 2.0.2 — 2020-01-17
- 2.0.1 — 2019-12-03
- 2.0.0 — 2019-08-23
- 0.6.0 — 2019-05-26
- 0.5.0 — 2019-01-31
- 0.4.2 — 2018-11-20
- 0.4.1 — 2018-11-07
- 0.4.0 — 2018-11-06
- 0.3.1 — 2018-10-16
- 0.3.0 — 2018-09-25
- … 2 more at https://npm.io/package/@devexperts/remote-data-ts/versions

## README

# RemoteData type [![Build Status](https://travis-ci.org/devexperts/remote-data-ts.svg?branch=master)](https://travis-ci.org/devexperts/remote-data-ts)
### Description
RemoteData is an ADT (algebraic data type) described in [this article](https://medium.com/@gcanti/slaying-a-ui-antipattern-with-flow-5eed0cfb627b). Heavily based on [fp-ts](https://github.com/gcanti/fp-ts) lib.

### Installation
`npm i --save @devexperts/remote-data-ts`

### How to lift (wrap) your data in RemoteData:
As you remember RemoteData is an union of few types: `RemoteInitial`, `RemotePending`, `RemoteFailure` and `RemoteSuccess`.

While your data in **initial** or **pending** state just use `initial` or `pending` constant, because you don't have any **real** values in this case.

```ts
import { initial, pending } from '@devexperts/remote-data-ts';

const customers = initial;
// or
const customers = pending;
```

When you receive data from server, use `failure` or `success` function, it depends on what you received:

```ts
import { failure, success } from '@devexperts/remote-data-ts';
import { apiClient } from 'apiClient';
import { TCustomer } from './MyModel';

const getCustomers = (): RemoteData<TCustomer[]> => {
   const rawData: TCustomer[] = apiClient.get('/customers');

   try {
        const length = rawData.length;

        return success(rawData);
   }
   catch(err) {
        return failure(new Error('parse error'));
   }
}
```

### How to fold (unwrap) your data from RemoteData:
Finally you pass data to the component and want to render values, so now it's time to get our values back from RemoteData wrapper:

```ts
import { NoData, Pending, Failure } from './MyPlaceholders';
import { TCustomer } from './MyModel';

type TCustomersList = {
    entities: RemoteData<TCustomer[]>;
};

const CustomersList: SFC<TCustomersList> = ({ entities }) => entities.foldL(
    () => <NoData />,
    () => <Pending />,
    err => <Failure error={err} />,
    data => <ul>{data.map(item => <li>{item.name}</li>)}</ul>
);
```

### Docs & Examples
Coming soon (check the [source](src/remote-data.ts))


### Contributions
- use https://www.conventionalcommits.org/en/v1.0.0-beta.2/

### Publish
Don't forget to run `npm run changelog` and to commit the changes

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