Fetch.variables.fetchJsonWithSchema

fx-fetch

---

fx-fetch / Fetch / fetchJsonWithSchema

Variable: fetchJsonWithSchema()

const fetchJsonWithSchema: {<A, I, R>(request, schema): Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>; <A, I, R>(schema): (request) => Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>; }

Defined in: packages/fx-fetch/src/Fetch/fetchJsonWithSchema.ts:49

Fetches and reads a JSON response with the given schema.

Call Signature

<A, I, R>(request, schema): Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>

Fetches and reads a JSON response with the given schema.

Type Parameters

A

A

I

I

R

R

Parameters

request

Request

schema

Schema<A, I, R>

Returns

Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>

Since

0.1.0

See

Response.readJsonWithSchema

Example

import { Effect, Schema } from 'effect';
import { Fetch, Request, Response } from 'fx-fetch';

const UserSchema = Schema.Struct({
  id: Schema.Int,
  name: Schema.String,
});

//       ┌─── Effect.Effect<
//       │      void,
//       │      | Fetch.FetchError
//       │      | Fetch.AbortError
//       │      | Fetch.NotAllowedError
//       │      | Response.NotOkError
//       │      | MalformedJsonError
//       │      | ParseError,
//       │      Fetch.Fetch
//       │    >
//       ▼
const program = Effect.gen(function* () {
  const request = Request.unsafeMake({ url: './my-endpoint' });

  //       ┌─── typeof UserSchema.Type
  //       ▼
  const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
});

Call Signature

<A, I, R>(schema): (request) => Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>

Fetches and reads a JSON response with the given schema.

Type Parameters

A

A

I

I

R

R

Parameters

schema

Schema<A, I, R>

Returns

(request): Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>

Parameters

request

Request

Returns

Effect<A, MalformedJsonError | FetchError | AbortError | NotAllowedError | ParseError | NotOkError, Fetch | R>

Since

0.1.0

See

Response.readJsonWithSchema

Example

import { Effect, Schema } from 'effect';
import { Fetch, Request, Response } from 'fx-fetch';

const UserSchema = Schema.Struct({
  id: Schema.Int,
  name: Schema.String,
});

//       ┌─── Effect.Effect<
//       │      void,
//       │      | Fetch.FetchError
//       │      | Fetch.AbortError
//       │      | Fetch.NotAllowedError
//       │      | Response.NotOkError
//       │      | MalformedJsonError
//       │      | ParseError,
//       │      Fetch.Fetch
//       │    >
//       ▼
const program = Effect.gen(function* () {
  const request = Request.unsafeMake({ url: './my-endpoint' });

  //       ┌─── typeof UserSchema.Type
  //       ▼
  const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
});

Since

0.1.0

See

Response.readJsonWithSchema

Example

import { Effect, Schema } from 'effect';
import { Fetch, Request, Response } from 'fx-fetch';

const UserSchema = Schema.Struct({
  id: Schema.Int,
  name: Schema.String,
});

//       ┌─── Effect.Effect<
//       │      void,
//       │      | Fetch.FetchError
//       │      | Fetch.AbortError
//       │      | Fetch.NotAllowedError
//       │      | Response.NotOkError
//       │      | MalformedJsonError
//       │      | ParseError,
//       │      Fetch.Fetch
//       │    >
//       ▼
const program = Effect.gen(function* () {
  const request = Request.unsafeMake({ url: './my-endpoint' });

  //       ┌─── typeof UserSchema.Type
  //       ▼
  const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
});