Class Fetcher

GET request

Fetches data from a URL with a GET request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.get({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  schema: z.object({ name: z.string() }),
});
Copy

Posts array buffer data to a URL

Posts array buffer data to a URL with a POST request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.postArrayBuffer({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  body: new ArrayBuffer(),
  schema: z.object({ name: z.string() }),
  contentType: 'application/octet-stream',

Copy

Posts blob data to a URL

Posts blob data to a URL with a POST request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.postBlob({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  body: new Blob(),
  schema: z.object({ name: z.string() }),
  contentType: 'image/png',

Copy

Posts form data to a URL

Posts form data to a URL with a POST request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.postFormData({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  body: new FormData(),
  schema: z.object({ name: z.string() }),
  contentType: 'application/x-www-form-urlencoded',

Copy

Posts JSON data to a URL

Posts JSON data to a URL with a POST request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.postJson({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  body: { name: 'example' },
  schema: z.object({ name: z.string() }),
  contentType: 'application/json',
});
Copy

POST text data to a URL

Posts text data to a URL with a POST request.

Throws

HTTPError if the response is not ok

Throws

ZodError if the response is not valid

Example

const data = await Fetcher.postText({
  urlBuilder: new URLBuilder({ baseUrl: 'https://api.example.com' }),
  body: 'Hello, world!',
  schema: z.object({ name: z.string() }),
  contentType: 'text/plain',
});
Copy