rpclibrary/docs/modules/_types_.md

rpclibrary › Globals › “Types”

External module: “Types”

Index

Type aliases

• Any
• Arg
• AsyncFunction
• BaseInfo
• CallInfo
• CallRPC
• CallbackFunction
• CloseHandler
• ConnectionHandler
• ErrorHandler
• ErrorResponse
• ExtendedRpcInfo
• HookCloseFunction
• HookFunction
• HookInfo
• HookRPC
• Name
• OnFunction
• Outcome
• Owner
• RPC
• RPCType
• ResponseType
• Respose
• RpcInfo
• SocketConf
• SubscriptionResponse
• SuccessResponse
• Visibility

Type aliases

Any

Ƭ Any: any

Defined in Types.ts:4

---

Arg

Ƭ Arg: string

Defined in Types.ts:5

---

AsyncFunction

Ƭ AsyncFunction: function

Defined in Types.ts:65

Type declaration:

▸ (…args: any): Promise‹any›

Parameters:

Name	Type
...args	any

---

BaseInfo

Ƭ BaseInfo: object

Defined in Types.ts:43

Type declaration:

• argNames: Name[]

• name: Name

• owner: Name

---

CallInfo

Ƭ CallInfo: BaseInfo & object

Defined in Types.ts:54

---

CallRPC

Ƭ CallRPC: object | Function

Defined in Types.ts:36

---

CallbackFunction

Ƭ CallbackFunction: function

Defined in Types.ts:66

Type declaration:

▸ (…args: any): void

Parameters:

Name	Type
...args	any

---

CloseHandler

Ƭ CloseHandler: function

Defined in Types.ts:10

Type declaration:

▸ (socket: Socket): void

Parameters:

Name	Type
socket	Socket

---

ConnectionHandler

Ƭ ConnectionHandler: function

Defined in Types.ts:8

Type declaration:

▸ (socket: Socket): void

Parameters:

Name	Type
socket	Socket

---

ErrorHandler

Ƭ ErrorHandler: function

Defined in Types.ts:9

Type declaration:

▸ (socket: Socket, error: any): void

Parameters:

Name	Type
socket	Socket
error	any

---

ErrorResponse

Ƭ ErrorResponse: Respose‹T› & object

Defined in Types.ts:24

---

ExtendedRpcInfo

Ƭ ExtendedRpcInfo: RpcInfo & object

Defined in Types.ts:60

---

HookCloseFunction

Ƭ HookCloseFunction: function

Defined in Types.ts:63

Type declaration:

▸ (res: SubscriptionResponse‹T›, rpc: HookRPC‹T›): any

Parameters:

Name	Type
res	SubscriptionResponse‹T›
rpc	HookRPC‹T›

---

HookFunction

Ƭ HookFunction: function

Defined in Types.ts:64

Type declaration:

▸ (…args: any): Promise‹SubscriptionResponse‹T› | ErrorResponse›

Parameters:

Name	Type
...args	any

---

HookInfo

Ƭ HookInfo: BaseInfo & object

Defined in Types.ts:49

---

HookRPC

Ƭ HookRPC: object

Defined in Types.ts:29

Type declaration:

• hook: HookFunction‹T›

• name: Name

• onCallback? : CallbackFunction

• onClose? : HookCloseFunction‹T›

---

Name

Ƭ Name: Arg

Defined in Types.ts:6

---

OnFunction

Ƭ OnFunction: function

Defined in Types.ts:62

Type declaration:

▸ (type: “error” | “close”, f: function): Socket

Parameters:

▪ type: “error” | “close”

▪ f: function

▸ (e?: any): void

Parameters:

Name	Type
e?	any

---

Outcome

Ƭ Outcome: “Success” | “Error”

Defined in Types.ts:19

---

Owner

Ƭ Owner: Name

Defined in Types.ts:7

---

RPC

Ƭ RPC: CallRPC | HookRPC‹T›

Defined in Types.ts:41

---

RPCType

Ƭ RPCType: “Hook” | “Unhook” | “Call”

Defined in Types.ts:27

---

ResponseType

Ƭ ResponseType: “Subscribe” | “Success” | “Error”

Defined in Types.ts:18

---

Respose

Ƭ Respose: T & object

Defined in Types.ts:22

---

RpcInfo

Ƭ RpcInfo: HookInfo | CallInfo

Defined in Types.ts:59

---

SocketConf

Ƭ SocketConf: object

Defined in Types.ts:11

Type declaration:

• closeHandler? : CloseHandler

• connectionHandler? : ConnectionHandler

• errorHandler? : ErrorHandler

• visibility? : Visibility

---

SubscriptionResponse

Ƭ SubscriptionResponse: Respose‹T› & object

Defined in Types.ts:25

---

SuccessResponse

Ƭ SuccessResponse: Respose‹T› & object

Defined in Types.ts:23

---

Visibility

Ƭ Visibility: “127.0.0.1” | “0.0.0.0”

Defined in Types.ts:3