In my previous post, I promised to build on the RemoteData type based on the popular Elm pattern. Read it first to understand the why and the wtf of this post.
Use the code from the CodeSandbox from the previous post as a starter code.
This time we will make the switch statement in the Main React component into a thing of beauty.
return foldRemoteData(
posts,
() => <FetchPosts getPosts={getPosts} />,
() => <Loading />,
(error) => <Failure error={error} />,
(data) => <BlogPosts data={data} />
);
What it does is simply make a less verbose version of the switch statement.
This way of doing it makes sense because the pattern has a somewhat logical order.
Split the logic
Just because it's good to separate stuff into smaller functions, we can start with extracting the views out of the Main function.
function FetchPosts({ getPosts }: { getPosts: () => void }) {
return (
<div style=>
<div>Not asked for posts yet</div>
<button onClick={getPosts}>Fetch Posts</button>
</div>
);
}
function Loading() {
return <div>Loading</div>;
}
function Failure({ error }: { error: Error }) {
return <div>Error: {error.message}</div>;
}
function BlogPosts({ data }: { data: Post[] }) {
return (
<div>
{data.map((post) => (
<article
key={post.id}
style=
>
<h2>{post.title}</h2>
<div dangerouslySetInnerHTML=></div>
</article>
))}
</div>
);
}
Doing this makes it already look very clean.
function Main(): JSX.Element {
const [posts, setPosts] = useState<RemoteData<Error, Post[]>>({
type: "NOT_ASKED",
});
const getPosts = () => {
setPosts({ type: "LOADING" });
fetchPosts().then((remoteData) => setPosts(remoteData));
};
switch (posts.type) {
case "NOT_ASKED":
return <FetchPosts getPosts={getPosts} />;
case "LOADING":
return <Loading />;
case "FAILURE":
return <Failure error={posts.error} />;
case "SUCCESS":
return <BlogPosts data={posts.data} />;
}
}
Writing the fold function
Let us dive in and make the utility function for RemoteData. It might look weird, but just type it out yourself, and I think it will make sense to you.
function foldRemoteData<R, E, D>(
remoteData: RemoteData<E, D>,
notAsked: () => R,
loading: () => R,
failure: (error: E) => R,
success: (data: D) => R
): R {
switch (remoteData.type) {
case "NOT_ASKED":
return notAsked();
case "LOADING":
return loading();
case "FAILURE":
return failure(remoteData.error);
case "SUCCESS":
return success(remoteData.data);
}
}
The function is heavily based on gcantis Flow port of RemoteData.
I made the fold function a bit more general. I also ditched it being curried as it disabled type inference on the data and error types.
What you see above is a higher order function. Don't be afraid. It just means a function that takes in or returns functions. You probably deal with it all the time.
Using the fold function
Now, you can replace the switch statement with the foldRemoteData function.
function Main(): JSX.Element {
const [posts, setPosts] = useState<RemoteData<Error, Post[]>>({
type: "NOT_ASKED",
});
const getPosts = () => {
setPosts({ type: "LOADING" });
fetchPosts().then((remoteData) => setPosts(remoteData));
};
return foldRemoteData(
posts,
() => <FetchPosts getPosts={getPosts} />,
() => <Loading />,
(error) => <Failure error={error} />,
(data) => <BlogPosts data={data} />
);
}
Very sleek!
- See the complete code on CodeSandbox
RemoteData Libraries
If you like this pattern, but you prefer to use a library, there are some alternatives:
- devexperts/remote-data-ts (based on fp-ts)
- abraham/remotedata
The devexperts version seems to have some advanced utilities, but I wish there were any examples in the docs.
You can pretty easily make your own convenience functions as the pattern is really simple anyway.
I currently prefer to just put the RemoteData type and the fold function into my own code. That's pretty much all I need, and there isn't much more to it.
- Feel free to use this Github gist as a "minimal library" on your own project
Next up
That's it for RemoteData, but there is yet another part to this series.
I want this code to mimic the advantages of Elm. That will require a few more steps.
In the next post we are decoding the incoming data in the next post.
Decoding JSON doesn't sound very cool, but it's one of those features in Elm that makes it almost impossible to get run-time exceptions in production.
And with a functional library based on TypeScript, it's pretty easy. Purify to the rescue!