decoder overview

Decoder combinator: decodes Resp of a Req<A> and returns a Req<B>.

Added in v3.0.0

---

Table of contents

• Decoder
  • Decoder (interface)
  • GenericDecoder (interface)
• combinators
  • withDecoder
• helpers
  • toDecoder

---

Decoder

Decoder (interface)

A specialization of a GenericDecoder with Left type fixed to Error.

Signature

export interface Decoder<A> extends GenericDecoder<Error, A> {}

Added in v3.0.0

GenericDecoder (interface)

Encodes a generic decoder, namely a function which takes an unknown input (usually a JSON object) and tries to decode it, returning a Right<A> if it succeeds or a Left<L> otherwise.

Signature

export interface GenericDecoder<L, A> extends ReaderEither<unknown, L, A> {}

Added in v3.0.0

combinators

withDecoder

Applies Decoder<B> to the Resp<A> of a Req converting it to a Resp<B>.

It returns a Left<ResponseError> in case the decoding fails.

It automatically sets “JSON” request header’s

Signature

export declare const withDecoder: <B>(decoder: Decoder<B>) => <A>(req: Req<A>) => Req<B>

Added in v3.0.0

helpers

toDecoder

Converts a GenericDecoder<L, A> into a Decoder<A>.

Signature

export declare const toDecoder: <L, A>(dec: GenericDecoder<L, A>, onLeft: (e: L) => Error) => Decoder<A>

Added in v3.0.0