Skip to main content Link Search Menu Expand Document (external link)

RpcSchema.ts overview

Since v1.0.0


Exports Grouped by Category


Stream

Stream

Signature

declare const Stream: <A extends Schema.Schema.Any, E extends Schema.Schema.All>({
  failure,
  success
}: {
  readonly failure: E
  readonly success: A
}) => Stream<A, E>

Source

Since v1.0.0

Stream (interface)

Signature

export interface Stream<A extends Schema.Schema.Any, E extends Schema.Schema.All>
  extends Schema.Schema<
    Stream_.Stream<A["Type"], E["Type"]>,
    Stream_.Stream<A["Encoded"], E["Encoded"]>,
    A["Context"] | E["Context"]
  > {
  readonly success: A
  readonly failure: E
}

Source

Since v1.0.0

StreamSchemaId

Signature

declare const StreamSchemaId: unique symbol

Source

Since v1.0.0

getStreamSchemas

Signature

declare const getStreamSchemas: (
  ast: AST.AST
) => Option.Option<{ readonly success: Schema.Schema.Any; readonly failure: Schema.Schema.All }>

Source

Since v1.0.0

isStreamSchema

Signature

declare const isStreamSchema: (schema: Schema.Schema.All) => schema is Stream<any, any>

Source

Since v1.0.0

isStreamSerializable

Signature

declare const isStreamSerializable: (schema: Schema.WithResult.Any) => boolean

Source

Since v1.0.0