Tiny RPC

Original idea from wenerme/tinyrpc

Document

Links

Site
- wener.me
  - Blog
  - Github wenerme/wener
- apis.wener.me
  - APIs playground with docs & stories
  - Github wenerme/apis
Library
- @wener/utils - -
  - utils for daily use
  - Document
- @wener/ui - -
  - Storybook
  - Document
- @wener/tinyrpc - -
  - Document
- rjsf-antd-theme - -
  - Ant Design Theme for React Json Schema Form
  - Storybook
  - Document

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

JsonRpcErrors

Type aliases

Fetch

Fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration

- (input: RequestInfo, init?: RequestInit): Promise<Response>
- Parameters
  - input: RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>

ProxyInvokeHandler

ProxyInvokeHandler: (ctx: ProxyContext, method: string, args: any[]) => any

Type declaration

- (ctx: ProxyContext, method: string, args: any[]): any
- Parameters
  - ctx: ProxyContext
  - method: string
  - args: any[]
  Returns any

ServiceInvocationHandler

ServiceInvocationHandler: (req: ServiceInvocation) => Promise<ServiceResponse>

Type declaration

- (req: ServiceInvocation): Promise<ServiceResponse>
- Parameters
  - req: ServiceInvocation
  Returns Promise<ServiceResponse>

Variables

Const GlobalRegistry

GlobalRegistry: ServiceRegistry = new ServiceRegistry()

Const ProxyTargetSymbol

ProxyTargetSymbol: unique symbol = Symbol('ProxyTarget')

Functions

consumeService

consumeService<T>(options: ConsumeOptions): T

- Defined in consumer.ts:15
Type parameters
- T: object
Parameters
- options: ConsumeOptions
Returns T

createFetchConsumer

createFetchConsumer<T>(__namedParameters: { maybeFetch: undefined | ((input: RequestInfo, init?: RequestInit) => Promise<Response>); url: string }): ServiceInvocationHandler

- Defined in consumers/fetch.ts:11
Type parameters
- T
Parameters
- __namedParameters: { maybeFetch: undefined | ((input: RequestInfo, init?: RequestInit) => Promise<Response>); url: string }
  - maybeFetch: undefined | ((input: RequestInfo, init?: RequestInit) => Promise<Response>)
  - url: string
Returns ServiceInvocationHandler

createInvoker

createInvoker(context: { consumer: ServiceInvocationHandler; method: string; service: string }): (Anonymous function)

- Defined in consumer.ts:49
Parameters
- context: { consumer: ServiceInvocationHandler; method: string; service: string }
  - consumer: ServiceInvocationHandler
  - method: string
  - service: string
Returns (Anonymous function)

createProxy

createProxy<T>(options: { handler?: ProxyInvokeHandler; methods?: any }): T

- Defined in createProxy.ts:5
Type parameters
- T: object
Parameters
- options: { handler?: ProxyInvokeHandler; methods?: any }
  - Optional handler?: ProxyInvokeHandler
  - Optional methods?: any
Returns T

createServiceConsumer

createServiceConsumer(opts: Partial<ConsumeOptions> & { consumer: ServiceInvocationHandler }): (options: Partial<ConsumeOptions> & { service: string }) => any

- Defined in consumer.ts:63
Parameters
- opts: Partial<ConsumeOptions> & { consumer: ServiceInvocationHandler }
Returns (options: Partial<ConsumeOptions> & { service: string }) => any
- - (options: Partial<ConsumeOptions> & { service: string }): any
  - Parameters
    - options: Partial<ConsumeOptions> & { service: string }
    Returns any

createServiceDefinition

createServiceDefinition(__namedParameters: { excludes: any[]; includes: any[]; name: string; prototype: any; provider: any; target: any }): ServiceDefinition

- Defined in ServiceRegistry.ts:47
Parameters
- __namedParameters: { excludes: any[]; includes: any[]; name: string; prototype: any; provider: any; target: any }
  - excludes: any[]
  - includes: any[]
  - name: string
  - prototype: any
  - provider: any
  - target: any
Returns ServiceDefinition

Object literals

Const JsonRpcErrors

JsonRpcErrors: object

InternalError

InternalError: object

code

code: number = -32603

message

message: string = "Internal error"

InvalidParams

InvalidParams: object

code

code: number = -32602

message

message: string = "Invalid params"

InvalidRequest

InvalidRequest: object

code

code: number = -32600

message

message: string = "Invalid Request"

MethodNotFound

MethodNotFound: object

code

code: number = -32601

message

message: string = "Method not found"

ParseError

ParseError: object

code

code: number = -32700

message

message: string = "Parse error"

ServerError

ServerError: object

code

code: number = -32000

message

message: string = "Server error"

Generated using TypeDoc

Tiny RPC

Links

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Fetch

Type declaration

Parameters

input: RequestInfo

Optional init: RequestInit

Returns Promise<Response>

ProxyInvokeHandler

Type declaration

Parameters

ctx: ProxyContext

method: string

args: any[]

Returns any

ServiceInvocationHandler

Type declaration

Parameters

req: ServiceInvocation

Returns Promise<ServiceResponse>

Variables

Const GlobalRegistry

Const ProxyTargetSymbol

Functions

consumeService

Type parameters

T: object

Parameters

options: ConsumeOptions

Returns T

createFetchConsumer

Type parameters

T

Parameters

__namedParameters: { maybeFetch: undefined | ((input: RequestInfo, init?: RequestInit) => Promise<Response>); url: string }

maybeFetch: undefined | ((input: RequestInfo, init?: RequestInit) => Promise<Response>)

url: string

Returns ServiceInvocationHandler

createInvoker

Parameters

context: { consumer: ServiceInvocationHandler; method: string; service: string }

consumer: ServiceInvocationHandler

method: string

service: string

Returns (Anonymous function)

createProxy

Type parameters

T: object

Parameters

options: { handler?: ProxyInvokeHandler; methods?: any }

Optional handler?: ProxyInvokeHandler

Optional methods?: any

Returns T

createServiceConsumer

Parameters

opts: Partial<ConsumeOptions> & { consumer: ServiceInvocationHandler }

Returns (options: Partial<ConsumeOptions> & { service: string }) => any

Parameters

options: Partial<ConsumeOptions> & { service: string }

Returns any

createServiceDefinition

Parameters

__namedParameters: { excludes: any[]; includes: any[]; name: string; prototype: any; provider: any; target: any }

excludes: any[]

includes: any[]

name: string

prototype: any

provider: any

target: any

Returns ServiceDefinition

Object literals

Const JsonRpcErrors