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

RpcMessage.ts overview

Since v1.0.0


Exports Grouped by Category


request

Ack (interface)

Signature

export interface Ack {
  readonly _tag: "Ack"
  readonly requestId: RequestId
}

Source

Since v1.0.0

Eof (interface)

Signature

export interface Eof {
  readonly _tag: "Eof"
}

Source

Since v1.0.0

FromClient (type alias)

Signature

type FromClient<A> = Request<A> | Ack | Interrupt | Eof

Source

Since v1.0.0

FromClientEncoded (type alias)

Signature

type FromClientEncoded = RequestEncoded | Ack | InterruptEncoded | Ping | Eof

Source

Since v1.0.0

Interrupt (interface)

Signature

export interface Interrupt {
  readonly _tag: "Interrupt"
  readonly requestId: RequestId
  readonly interruptors: ReadonlyArray<FiberId.FiberId>
}

Source

Since v1.0.0

InterruptEncoded (interface)

Signature

export interface InterruptEncoded {
  readonly _tag: "Interrupt"
  readonly requestId: RequestId
}

Source

Since v1.0.0

Ping (interface)

Signature

export interface Ping {
  readonly _tag: "Ping"
}

Source

Since v1.0.0

Request (interface)

Signature

export interface Request<A extends Rpc.Any> {
  readonly _tag: "Request"
  readonly id: RequestId
  readonly tag: Rpc.Tag<A>
  readonly payload: Rpc.Payload<A>
  readonly traceId: string
  readonly spanId: string
  readonly sampled: boolean
  readonly headers: Headers
}

Source

Since v1.0.0

RequestEncoded (interface)

Signature

export interface RequestEncoded {
  readonly _tag: "Request"
  readonly id: bigint | string
  readonly tag: string
  readonly payload: unknown
  readonly traceId: string
  readonly spanId: string
  readonly sampled: boolean
  readonly headers: ReadonlyArray<[string, string]>
}

Source

Since v1.0.0

RequestId

Signature

declare const RequestId: (id: bigint | string) => RequestId

Source

Since v1.0.0

RequestId (type alias)

Signature

type RequestId = Branded<bigint, RequestIdTypeId>

Source

Since v1.0.0

RequestIdTypeId

Signature

declare const RequestIdTypeId: unique symbol

Source

Since v1.0.0

RequestIdTypeId (type alias)

Signature

type RequestIdTypeId = typeof RequestIdTypeId

Source

Since v1.0.0

constEof

Signature

declare const constEof: Eof

Source

Since v1.0.0

constPing

Signature

declare const constPing: Ping

Source

Since v1.0.0

response

ClientEnd (interface)

Signature

export interface ClientEnd {
  readonly _tag: "ClientEnd"
  readonly clientId: number
}

Source

Since v1.0.0

FromServer (type alias)

Signature

type FromServer<A> = ResponseChunk<A> | ResponseExit<A> | ResponseDefect | ClientEnd

Source

Since v1.0.0

FromServerEncoded (type alias)

Signature

type FromServerEncoded = ResponseChunkEncoded | ResponseExitEncoded | ResponseDefectEncoded | Pong

Source

Since v1.0.0

Pong (interface)

Signature

export interface Pong {
  readonly _tag: "Pong"
}

Source

Since v1.0.0

ResponseChunk (interface)

Signature

export interface ResponseChunk<A extends Rpc.Any> {
  readonly _tag: "Chunk"
  readonly clientId: number
  readonly requestId: RequestId
  readonly values: NonEmptyReadonlyArray<Rpc.SuccessChunk<A>>
}

Source

Since v1.0.0

ResponseChunkEncoded (interface)

Signature

export interface ResponseChunkEncoded {
  readonly _tag: "Chunk"
  readonly requestId: bigint | string
  readonly values: NonEmptyReadonlyArray<unknown>
}

Source

Since v1.0.0

ResponseDefect (interface)

Signature

export interface ResponseDefect {
  readonly _tag: "Defect"
  readonly clientId: number
  readonly defect: unknown
}

Source

Since v1.0.0

ResponseDefectEncoded

Signature

declare const ResponseDefectEncoded: (input: unknown) => ResponseDefectEncoded

Source

Since v1.0.0

ResponseDefectEncoded (interface)

Signature

export interface ResponseDefectEncoded {
  readonly _tag: "Defect"
  readonly defect: unknown
}

Source

Since v1.0.0

ResponseExit (interface)

Signature

export interface ResponseExit<A extends Rpc.Any> {
  readonly _tag: "Exit"
  readonly clientId: number
  readonly requestId: RequestId
  readonly exit: Rpc.Exit<A>
}

Source

Since v1.0.0

ResponseExitEncoded (interface)

Signature

export interface ResponseExitEncoded {
  readonly _tag: "Exit"
  readonly requestId: bigint | string
  readonly exit: Schema.ExitEncoded<unknown, unknown, unknown>
}

Source

Since v1.0.0

ResponseId (type alias)

Signature

type ResponseId = Branded<number, ResponseIdTypeId>

Source

Since v1.0.0

ResponseIdTypeId

Signature

declare const ResponseIdTypeId: unique symbol

Source

Since v1.0.0

ResponseIdTypeId (type alias)

Signature

type ResponseIdTypeId = typeof ResponseIdTypeId

Source

Since v1.0.0

constPong

Signature

declare const constPong: Pong

Source

Since v1.0.0