@typed/json-rpc

A relative work-in-progress compared to the rest of the libraries in Typed, but is an attempt to abstract the building of JSON-RPC servers and client connects using @typed/effects, @typed/hooks, and the ecosystem.

Index

Enumerations

Interfaces

Variables

isMessage

Type aliases

Batch

Batch: BatchRequest | BatchResponse

BatchRequest

BatchRequest: JsonRpcRequest[]

BatchResponse

BatchResponse: JsonRpcResponse[]

ConnectionEnv

ConnectionEnv: { connection: Connection }

Type declaration

Readonly connection: Connection

ConnectionEvent

ConnectionEvent: Tuple<"add", Connection> | Tuple<"remove", Connection>

HandlerMap

HandlerMap<A>: ReadonlyMap<string, Tuple<A, any>>

Type parameters

Id

Id: string | number

IsNever

IsNever<A>: [A] extends [never] ? true : false

Type parameters

JsonRpcError

JsonRpcError<Code, ErrorData>: IsNever<ErrorData> extends true ? { code: Code; message: string } : { code: Code; data: ErrorData; message: string }

Type parameters

Code: number
ErrorData: Json

JsonRpcFailedResponse

JsonRpcFailedResponse<Code, ErrorData>: { error: JsonRpcError<Code, ErrorData>; id: Id; jsonrpc: "2.0" }

Type parameters

Code: number
ErrorData: Json

Type declaration

Readonly error: JsonRpcError<Code, ErrorData>
Readonly id: Id
Readonly jsonrpc: "2.0"

JsonRpcNotification

JsonRpcNotification<Method, Params>: IsNever<Params> extends true ? { jsonrpc: "2.0"; method: Method } : { jsonrpc: "2.0"; method: Method; params: Params }

Type parameters

Method: string
Params: StructuredJson

JsonRpcRequest

JsonRpcRequest<Method, Params>: IsNever<Params> extends true ? { id: Id; jsonrpc: "2.0"; method: Method } : { id: Id; jsonrpc: "2.0"; method: Method; params: Params }

Type parameters

Method: string
Params: StructuredJson

JsonRpcResponse

JsonRpcResponse<Result, Code, ErrorData>: JsonRpcSuccessfulResponse<Result> | JsonRpcFailedResponse<Code, ErrorData>

Type parameters

Result: StructuredJson
Code: number
ErrorData: Json

JsonRpcSuccessfulResponse

JsonRpcSuccessfulResponse<Result>: { id: Id; jsonrpc: "2.0"; result: Result }

Type parameters

Result: StructuredJson

Type declaration

Readonly id: Id
Readonly jsonrpc: "2.0"
Readonly result: Result

Message

Message: JsonRpcRequest | JsonRpcResponse | JsonRpcNotification | Batch

NotificationHandler

NotificationHandler<E, A>: (notification: A) => HookEffects<E, void>

Type parameters

E
A: JsonRpcNotification

Type declaration

- (notification: A): HookEffects<E, void>
- Parameters
  - notification: A
  Returns HookEffects<E, void>

RequestHandler

RequestHandler<E, A, B>: (notification: A) => HookEffects<E, B>

Type parameters

Type declaration

- (notification: A): HookEffects<E, B>
- Parameters
  - notification: A
  Returns HookEffects<E, B>

SendRequest

SendRequest<E>: <A, B>(request: A, direction: MessageDirection) => Effects<E, B>

Type parameters

Type declaration

- <A, B>(request: A, direction: MessageDirection): Effects<E, B>
- Type parameters
  - A: JsonRpcRequest
  - B: JsonRpcResponse
  Parameters
  - request: A
  - direction: MessageDirection
  Returns Effects<E, B>

ServerChannel

ServerChannel<E>: Channel<E, ServerState>

Type parameters

ServerState

ServerState: { connectionEvents: Subscription<ConnectionEvent>; connections: ReadonlyArray<Connection>; notificationHandlers: HandlerMap<NotificationHandler<any, any>>; requestHandlers: HandlerMap<RequestHandler<any, any, any>> }

Type declaration

Readonly connectionEvents: Subscription<ConnectionEvent>
Readonly connections: ReadonlyArray<Connection>
Readonly notificationHandlers: HandlerMap<NotificationHandler<any, any>>
Readonly requestHandlers: HandlerMap<RequestHandler<any, any, any>>

StructuredJson

StructuredJson: JsonObject | JsonArray

Variables

Const isMessage

isMessage: (x: unknown) => x is Message = or(isNotification,or(isRequest, or(isResponse, or(isBatchRequest, isBatchResponse))),)

Type declaration

- (x: unknown): x is Message
- Parameters
  - x: unknown
  Returns x is Message

Functions

Const createConnectionEventSubscription

createConnectionEventSubscription(): Subscription<ConnectionEvent>

- Defined in packages/json-rpc/source/infrastructure/createTestServerChannel.ts:23
Returns Subscription<ConnectionEvent>

createFailedResponse

createFailedResponse<Code, ErrorData>(requestId: Id, error: JsonRpcError<Code, ErrorData>): JsonRpcFailedResponse<Code, ErrorData>

- Defined in packages/json-rpc/source/domain/services/messages/createFailedResponse.ts:4
Type parameters
- Code: number
- ErrorData: Json
Parameters
- requestId: Id
- error: JsonRpcError<Code, ErrorData>
Returns JsonRpcFailedResponse<Code, ErrorData>

createNotification

createNotification<A>(method: A): JsonRpcNotification<A>
createNotification<A, B>(method: A, params: B): JsonRpcNotification<A, B>

- Defined in packages/json-rpc/source/domain/services/messages/createNotification.ts:4
Type parameters
- A: string
Parameters
- method: A
Returns JsonRpcNotification<A>
- Defined in packages/json-rpc/source/domain/services/messages/createNotification.ts:5
Type parameters
- A: string
- B: StructuredJson
Parameters
- method: A
- params: B
Returns JsonRpcNotification<A, B>

createRequest

createRequest<A>(id: Id, method: A): JsonRpcRequest<A>
createRequest<A, B>(id: Id, method: A, params: B): JsonRpcRequest<A, B>

- Defined in packages/json-rpc/source/domain/services/messages/createRequest.ts:4
Type parameters
- A: string
Parameters
- id: Id
- method: A
Returns JsonRpcRequest<A>
- Defined in packages/json-rpc/source/domain/services/messages/createRequest.ts:5
Type parameters
- A: string
- B: StructuredJson
Parameters
- id: Id
- method: A
- params: B
Returns JsonRpcRequest<A, B>

createServer

createServer<E>(serverChannel: ServerChannel<E>): HookEffects<HooksManagerEnv & TimerEnv & E, Server<HooksManagerEnv & TimerEnv & E>>

- Defined in packages/json-rpc/source/infrastructure/createServer.ts:33
Type parameters
- E
Parameters
- serverChannel: ServerChannel<E>
Returns HookEffects<HooksManagerEnv & TimerEnv & E, Server<HooksManagerEnv & TimerEnv & E>>

createSuccessfulResponse

createSuccessfulResponse<R>(requestId: Id, result: R): JsonRpcSuccessfulResponse<R>

- Defined in packages/json-rpc/source/domain/services/messages/createSuccessfulResponse.ts:3
Type parameters
- R: StructuredJson
Parameters
- requestId: Id
- result: R
Returns JsonRpcSuccessfulResponse<R>

Const createTestConnection

createTestConnection(options?: Partial<Connection>): Connection

- Defined in packages/json-rpc/source/infrastructure/createTestServerChannel.ts:26
Parameters
- Default value options: Partial<Connection> = {}
Returns Connection

Const createTestServerChannel

createTestServerChannel(options: Partial<ServerState>): ServerChannel<unknown>

- Defined in packages/json-rpc/source/infrastructure/createTestServerChannel.ts:7
Parameters
- options: Partial<ServerState>
Returns ServerChannel<unknown>

getOppositeDirection

getOppositeDirection(direction: MessageDirection): MessageDirection

- Defined in packages/json-rpc/source/domain/services/oppositeDirection.ts:3
Parameters
- direction: MessageDirection
Returns MessageDirection

getSubscription

getSubscription(direction: MessageDirection): Effects<ConnectionEnv, Subscription<Message>>

- Defined in packages/json-rpc/source/infrastructure/getSubscription.ts:5
Parameters
- direction: MessageDirection
Returns Effects<ConnectionEnv, Subscription<Message>>

isBatchRequest

isBatchRequest(x: unknown): x is BatchRequest

- Defined in packages/json-rpc/source/domain/services/validations/isBatchRequest.ts:5
Parameters
- x: unknown
Returns x is BatchRequest

isBatchResponse

isBatchResponse(x: unknown): x is BatchResponse

- Defined in packages/json-rpc/source/domain/services/validations/isBatchResponse.ts:5
Parameters
- x: unknown
Returns x is BatchResponse

Const isFailedResponse

isFailedResponse(x: unknown): x is JsonRpcFailedResponse

- Defined in packages/json-rpc/source/domain/services/validations/isResponse.ts:23
Parameters
- x: unknown
Returns x is JsonRpcFailedResponse

isNotification

isNotification(x: unknown): x is JsonRpcNotification

- Defined in packages/json-rpc/source/domain/services/validations/isNotification.ts:19
Parameters
- x: unknown
Returns x is JsonRpcNotification

isRequest

isRequest(x: unknown): x is JsonRpcRequest

- Defined in packages/json-rpc/source/domain/services/validations/isRequest.ts:7
Parameters
- x: unknown
Returns x is JsonRpcRequest

isResponse

isResponse(x: unknown): x is JsonRpcResponse

- Defined in packages/json-rpc/source/domain/services/validations/isResponse.ts:26
Parameters
- x: unknown
Returns x is JsonRpcResponse

Const isSuccessfulResponse

isSuccessfulResponse(x: unknown): x is JsonRpcSuccessfulResponse

- Defined in packages/json-rpc/source/domain/services/validations/isResponse.ts:20
Parameters
- x: unknown
Returns x is JsonRpcSuccessfulResponse

Const sendMessage

sendMessage(message: { id: Id; jsonrpc: "2.0"; method: Method; params: Params } | { id: Id; jsonrpc: "2.0"; result: Result } | { error: JsonRpcError<Code, ErrorData>; id: Id; jsonrpc: "2.0" } | { jsonrpc: "2.0"; method: Method; params: Params } | { id: Id; jsonrpc: "2.0"; method: Method; params: Params }[] | ({ id: Id; jsonrpc: "2.0"; result: Result } | { error: JsonRpcError<Code, ErrorData>; id: Id; jsonrpc: "2.0" })[], direction: MessageDirection): Generator<Env<{ connection: Connection }, any>, Disposable, any>

- Defined in packages/json-rpc/source/infrastructure/sendMessage.ts:4
Parameters
- message: { id: Id; jsonrpc: "2.0"; method: Method; params: Params } | { id: Id; jsonrpc: "2.0"; result: Result } | { error: JsonRpcError<Code, ErrorData>; id: Id; jsonrpc: "2.0" } | { jsonrpc: "2.0"; method: Method; params: Params } | { id: Id; jsonrpc: "2.0"; method: Method; params: Params }[] | ({ id: Id; jsonrpc: "2.0"; result: Result } | { error: JsonRpcError<Code, ErrorData>; id: Id; jsonrpc: "2.0" })[]
- direction: MessageDirection
Returns Generator<Env<{ connection: Connection }, any>, Disposable, any>

Const sendRequest

sendRequest<A, B>(request: A, direction: MessageDirection): Generator<Env<{ connection: Connection } & { fork: <A>(effect: A, c: Capabilities<A> & FiberFailure) => Resume<Fiber<Return<A>>> } & {}, any> | Env<{ join: <A>(fiber: Fiber<A>) => Resume<Either<Error, A>> } & {}, any>, B, any>

- Defined in packages/json-rpc/source/infrastructure/sendRequest.ts:13
Type parameters
- A: JsonRpcRequest
- B: JsonRpcResponse
Parameters
- request: A
- direction: MessageDirection
Returns Generator<Env<{ connection: Connection } & { fork: <A>(effect: A, c: Capabilities<A> & FiberFailure) => Resume<Fiber<Return<A>>> } & {}, any> | Env<{ join: <A>(fiber: Fiber<A>) => Resume<Either<Error, A>> } & {}, any>, B, any>

Const waitForResponse

waitForResponse(requestId: Id, direction: MessageDirection): Effects<ConnectionEnv, JsonRpcResponse>

- Defined in packages/json-rpc/source/infrastructure/waitForResponse.ts:14
Parameters
- requestId: Id
- direction: MessageDirection
Returns Effects<ConnectionEnv, JsonRpcResponse>

@typed/json-rpc

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

Batch

BatchRequest

BatchResponse

ConnectionEnv

Type declaration

Readonly connection: Connection

ConnectionEvent

HandlerMap

Type parameters

A

Id

IsNever

Type parameters

A

JsonRpcError

Type parameters

Code: number

ErrorData: Json

JsonRpcFailedResponse

Type parameters

Code: number

ErrorData: Json

Type declaration

Readonly error: JsonRpcError<Code, ErrorData>

Readonly id: Id

Readonly jsonrpc: "2.0"

JsonRpcNotification

Type parameters

Method: string

Params: StructuredJson

JsonRpcRequest

Type parameters

Method: string

Params: StructuredJson

JsonRpcResponse

Type parameters

Result: StructuredJson

Code: number

ErrorData: Json

JsonRpcSuccessfulResponse

Type parameters

Result: StructuredJson

Type declaration

Readonly id: Id

Readonly jsonrpc: "2.0"

Readonly result: Result

Message

NotificationHandler

Type parameters

E

A: JsonRpcNotification

Type declaration

Parameters

notification: A

Returns HookEffects<E, void>

RequestHandler

Type parameters

E

A: JsonRpcRequest

B: JsonRpcResponse

Type declaration

Parameters

notification: A

Returns HookEffects<E, B>

SendRequest

Type parameters

E

Type declaration

Type parameters

A: JsonRpcRequest

B: JsonRpcResponse

Parameters