Skip to content

ChannelSchema

6 exports Added in v1.0.0 Source

Combinators

duplex

Added in v1.0.0 Source

Signature

declare const duplex: {
  <IA, II, IR, OA, OI, OR>(options: {
    readonly inputSchema: Schema.Schema<IA, II, IR>;
    readonly outputSchema: Schema.Schema<OA, OI, OR>;
  }): <R, InErr, OutErr, OutDone, InDone>(
    self: Channel<Chunk<OI>, Chunk<II>, OutErr, any, OutDone, InDone, R>,
  ) => Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, IR | OR | R>;
  <R, InErr, OutErr, OutDone, InDone, IA, II, IR, OA, OI, OR>(
    self: Channel<Chunk<OI>, Chunk<II>, OutErr, any, OutDone, InDone, R>,
    options: {
      readonly inputSchema: Schema.Schema<IA, II, IR>;
      readonly outputSchema: Schema.Schema<OA, OI, OR>;
    },
  ): Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, R | IR | OR>;
};

Signature

declare const duplexUnknown: {
  <IA, II, IR, OA, OI, OR>(options: {
    readonly inputSchema: Schema.Schema<IA, II, IR>;
    readonly outputSchema: Schema.Schema<OA, OI, OR>;
  }): <R, InErr, OutErr, OutDone, InDone>(
    self: Channel<Chunk<unknown>, Chunk<any>, OutErr, any, OutDone, InDone, R>,
  ) => Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, IR | OR | R>;
  <R, InErr, OutErr, OutDone, InDone, IA, II, IR, OA, OI, OR>(
    self: Channel<Chunk<unknown>, Chunk<any>, OutErr, any, OutDone, InDone, R>,
    options: {
      readonly inputSchema: Schema.Schema<IA, II, IR>;
      readonly outputSchema: Schema.Schema<OA, OI, OR>;
    },
  ): Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, R | IR | OR>;
};

Constructors

decode

Added in v1.0.0 Source

Signature

declare function decode<A, I, R>(
  schema: any,
): <IE = never, Done = unknown>() => Channel<Chunk<A>, Chunk<I>, any, IE, Done, Done, R>;

Signature

declare const decodeUnknown: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
) => <IE = never, Done = unknown>() => Channel.Channel<
  Chunk.Chunk<A>,
  Chunk.Chunk<any>,
  ParseError | IE,
  IE,
  Done,
  Done,
  R
>;

encode

Added in v1.0.0 Source

Signature

declare function encode<A, I, R>(
  schema: any,
): <IE = never, Done = unknown>() => Channel<Chunk<I>, Chunk<A>, any, IE, Done, Done, R>;

Signature

declare const encodeUnknown: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
) => <IE = never, Done = unknown>() => Channel.Channel<
  Chunk.Chunk<unknown>,
  Chunk.Chunk<A>,
  IE | ParseError,
  IE,
  Done,
  Done,
  R
>;