FetchClient

FetchClient is a library that makes it easier to use the fetch API for JSON APIs. It provides the following features:

• Makes fetch easier to use for JSON APIs
• Automatic model validation
• Caching
• Middleware
• Problem Details support
• Option to parse dates in responses

Install

1npm install --save @exceptionless/fetchclient

Docs

API Documentation

Usage

Typed Response

1import { FetchClient } from '@exceptionless/fetchclient';
2
3type Products = {
4  products: Array<{ id: number; name: string }>;
5};
6
7const client = new FetchClient();
8const response = await client.getJSON<Products>(
9  `https://dummyjson.com/products/search?q=iphone&limit=10`,
10);
11
12const products = response.data;

Typed Response Using a Function

1import { getJSON } from '@exceptionless/fetchclient';
2
3type Products = {
4  products: Array<{ id: number; name: string }>;
5};
6
7const response = await getJSON<Products>(
8  `https://dummyjson.com/products/search?q=iphone&limit=10`,
9);
10
11const products = response.data;

Model Validator

1import { FetchClient, setModelValidator } from '@exceptionless/fetchclient';
2
3setModelValidator(async (data: object | null) => {
4  // use zod or any other validator
5  const problem = new ProblemDetails();
6  const d = data as { password: string };
7  if (d?.password?.length < 6) {
8    problem.errors.password = [
9      "Password must be longer than or equal to 6 characters.",
10    ];
11  }
12  return problem;
13});
14
15const client = new FetchClient();
16const data = {
17  email: "test@test",
18  password: "test",
19};
20
21const response = await client.postJSON(
22  "https://jsonplaceholder.typicode.com/todos/1",
23  data,
24);
25
26if (!response.ok) {
27  // check response problem
28  console.log(response.problem.detail);
29}

Caching

1import { FetchClient } from '@exceptionless/fetchclient';
2
3type Todo = { userId: number; id: number; title: string; completed: boolean };
4
5const client = new FetchClient();
6const response = await client.getJSON<Todo>(
7  `https://jsonplaceholder.typicode.com/todos/1`,
8  {
9    cacheKey: ["todos", "1"],
10    cacheDuration: 1000 * 60, // expires in 1 minute
11  }
12);
13
14// invalidate programmatically
15client.cache.delete(["todos", "1"]);

Middleware

1import { FetchClient, useMiddleware } from '@exceptionless/fetchclient';
2
3type Products = {
4  products: Array<{ id: number; name: string }>;
5};
6
7useMiddleware(async (ctx, next) => {
8  console.log('starting request')
9  await next();
10  console.log('completed request')
11});
12
13const client = new FetchClient();
14const response = await client.getJSON<Products>(
15  `https://dummyjson.com/products/search?q=iphone&limit=10`,
16);

Also, take a look at the tests:

FetchClient Tests

Contributing

Run tests:

1deno run test

Lint code:

1deno lint

Format code:

1deno fmt

Type check code:

1deno run check

License

MIT © Exceptionless