rpclibrary/docs/modules/_utils_.md

rpclibrary › Globals › “Utils”

External module: “Utils”

Index

Functions

• extractArgs
• hookGenerator
• makeSubResponse
• rpcHooker
• rpcToRpcinfo

Functions

Const extractArgs

▸ extractArgs(f: Function): T.Arg[]

Defined in Utils.ts:110

Extract a string list of parameters from a function

Parameters:

Name	Type	Description
f	Function	The source function

Returns: T.Arg[]

---

Const hookGenerator

▸ hookGenerator(rpc: T.HookRPC‹any›): function

Defined in Utils.ts:85

Utility function to generate HookFunction from a RPC

Parameters:

Name	Type	Description
rpc	T.HookRPC‹any›	The RPC to transform

Returns: function

A HookFunction

▸ (socket?: I.Socket): HookFunction‹T›

Parameters:

Name	Type
socket?	I.Socket

---

makeSubResponse

▸ makeSubResponse(uuid?: undefined | string): SubscriptionResponse

Defined in Utils.ts:119

Simple utility function to create basic SubscriptionResponse

Parameters:

Name	Type	Description
uuid?	undefined | string	optional uuid to use, otherwise defaults to uuid/v4

Returns: SubscriptionResponse

---

rpcHooker

▸ rpcHooker<SubResT>(socket: Socket, exporter: RPCExporter‹SubResT›, makeUnique: boolean): T.ExtendedRpcInfo[]

Defined in Utils.ts:59

Utility function to apply the RPCs of an RPCExporter.

Type parameters:

▪ SubResT

Parameters:

Name	Type	Default	Description
socket	Socket	-	The websocket (implementation: bsock) to hook on
exporter	RPCExporter‹SubResT›	-	The exporter
makeUnique	boolean	true	@default true Attach a suffix to RPC names

Returns: T.ExtendedRpcInfo[]

---

Const rpcToRpcinfo

▸ rpcToRpcinfo<SubResT>(rpc: T.RPC‹SubResT›, owner: T.Owner): T.RpcInfo

Defined in Utils.ts:13

Translate an RPC to RPCInfo for serialization.

Type parameters:

▪ SubResT

Parameters:

Name	Type	Description
rpc	T.RPC‹SubResT›	The RPC to transform
owner	T.Owner	The owning RPC group’s name

Returns: T.RpcInfo