remote-data-ts

by devexperts

devexperts / remote-data-ts

RemoteData type

154 Stars 18 Forks Last release: about 2 years ago (v0.3.0) Mozilla Public License 2.0 126 Commits 15 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

RemoteData type Build Status

Description

RemoteData is an ADT (algebraic data type) described in this article. Heavily based on 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.
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:
import { failure, success } from '@devexperts/remote-data-ts';
import { apiClient } from 'apiClient';
import { TCustomer } from './MyModel';

const getCustomers = (): RemoteData => { 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:

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

type TCustomersList = { entities: RemoteData; };

const CustomersList: SFC = ({ entities }) => entities.foldL( () => , () => , err => , data =>

    {data.map(item =>
  • {item.name}
  • )}
);

Docs & Examples

Coming soon (check the source)

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.