fetchclient 0.30.0
Install from the command line:
Learn more about npm packages
$ npm install @exceptionless/fetchclient@0.30.0
Install via package.json:
"@exceptionless/fetchclient": "0.30.0"
About this version
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
npm install --save @exceptionless/fetchclient
Get a typed JSON response:
import { FetchClient } from '@exceptionless/fetchclient';
type Products = {
products: Array<{ id: number; name: string }>;
};
const client = new FetchClient();
const response = await client.getJSON<Products>(
`https://dummyjson.com/products/search?q=iphone&limit=10`,
);
const products = response.data;
Get a typed JSON response using a function:
import { useFetchClient } from '@exceptionless/fetchclient';
type Products = {
products: Array<{ id: number; name: string }>;
};
const response = await useFetchClient().getJSON<Products>(
`https://dummyjson.com/products/search?q=iphone&limit=10`,
);
const products = response.data;
Use a model validator:
import { FetchClient, setModelValidator } from '@exceptionless/fetchclient';
setModelValidator(async (data: object | null) => {
// use zod or any other validator
const problem = new ProblemDetails();
const d = data as { password: string };
if (d?.password?.length < 6) {
problem.errors.password = [
"Password must be longer than or equal to 6 characters.",
];
}
return problem;
});
const client = new FetchClient();
const data = {
email: "test@test",
password: "test",
};
const response = await client.postJSON(
"https://jsonplaceholder.typicode.com/todos/1",
data,
);
if (!response.ok) {
// check response problem
console.log(response.problem.detail);
}
Use caching:
import { FetchClient } from '@exceptionless/fetchclient';
type Todo = { userId: number; id: number; title: string; completed: boolean };
const client = new FetchClient();
const response = await client.getJSON<Todo>(
`https://jsonplaceholder.typicode.com/todos/1`,
{
cacheKey: ["todos", "1"],
cacheDuration: 1000 * 60, // expires in 1 minute
}
);
// invalidate programmatically
client.cache.delete(["todos", "1"]);
Use middleware:
import { FetchClient, useMiddleware } from '@exceptionless/fetchclient';
type Products = {
products: Array<{ id: number; name: string }>;
};
useMiddleware(async (ctx, next) => {
console.log('starting request')
await next();
console.log('completed request')
});
const client = new FetchClient();
const response = await client.getJSON<Products>(
`https://dummyjson.com/products/search?q=iphone&limit=10`,
);
Also, take a look at the tests:
Run tests:
deno test --allow-net
Lint code:
deno lint
Format code:
deno fmt
Type check code:
deno check scripts/*.ts *.ts src/*.ts
MIT © Exceptionless
Details
- fetchclient
- exceptionless
- 4 days ago
- Apache-2.0
- 3 dependencies
Assets
- fetchclient-0.30.0.tgz
Download activity
- Total downloads 0
- Last 30 days 0
- Last week 0
- Today 0