Request.variables.readJsonWithSchema

fx-fetch

---

fx-fetch / Request / readJsonWithSchema

Variable: readJsonWithSchema()

const readJsonWithSchema: {<A, I, R>(self, schema): Effect<A, MalformedJsonError | ParseError, R>; <A, I, R>(self): (request) => Effect<A, MalformedJsonError | ParseError, R>; }

Defined in: packages/fx-fetch/src/Request/readJsonWithSchema.ts:33

Reads a JSON request with the given schema.

Call Signature

<A, I, R>(self, schema): Effect<A, MalformedJsonError | ParseError, R>

Reads a JSON request with the given schema.

Type Parameters

A

A

I

I

R

R

Parameters

self

Request

schema

Schema<A, I, R>

Returns

Effect<A, MalformedJsonError | ParseError, R>

Example

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

const UserSchema = Schema.Struct({
  name: Schema.String,
  age: Schema.Number
});

const request = Request.make({ url: 'https://api.example.com' });
const userEffect = Request.readJsonWithSchema(request, UserSchema);

Since

0.1.0

Call Signature

<A, I, R>(self): (request) => Effect<A, MalformedJsonError | ParseError, R>

Reads a JSON request with the given schema.

Type Parameters

A

A

I

I

R

R

Parameters

self

Schema<A, I, R>

Returns

(request): Effect<A, MalformedJsonError | ParseError, R>

Parameters

request

Request

Returns

Effect<A, MalformedJsonError | ParseError, R>

Example

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

const UserSchema = Schema.Struct({
  name: Schema.String,
  age: Schema.Number
});
const request = Request.make({ url: 'https://api.example.com' });

const userEffect = pipe(
  request,
  Request.readJsonWithSchema(UserSchema)
);

Since

0.1.0

Example

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

const UserSchema = Schema.Struct({
  name: Schema.String,
  age: Schema.Number
});

const request = Request.make({ url: 'https://api.example.com' });
const userEffect = Request.readJsonWithSchema(request, UserSchema);

Since

0.1.0