@reactor/data — rpcbuilder
@reactor/data / RpcBuilder
Class: RpcBuilder<Args, Returns>
Section titled “Class: RpcBuilder<Args, Returns>”Defined in: rpc.ts:30
RPC builder for type-safe function calls.
Type Parameters
Section titled “Type Parameters”Args extends Record<string, unknown>
Returns
Section titled “Returns”Returns
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RpcBuilder<
Args,Returns>(ctx,functionName):RpcBuilder<Args,Returns>
Defined in: rpc.ts:35
Parameters
Section titled “Parameters”RequestContext
functionName
Section titled “functionName”string
Returns
Section titled “Returns”RpcBuilder<Args, Returns>
Methods
Section titled “Methods”abortSignal()
Section titled “abortSignal()”abortSignal(
signal):this
Defined in: rpc.ts:47
Provide an AbortSignal
Parameters
Section titled “Parameters”signal
Section titled “signal”AbortSignal
Returns
Section titled “Returns”this
call()
Section titled “call()”call(
args):this
Defined in: rpc.ts:41
Set function arguments
Parameters
Section titled “Parameters”Args
Returns
Section titled “Returns”this
headers()
Section titled “headers()”headers(
headers):this
Defined in: rpc.ts:53
Set custom headers
Parameters
Section titled “Parameters”headers
Section titled “headers”Record<string, string>
Returns
Section titled “Returns”this
then()
Section titled “then()”then<
TResult1,TResult2>(onfulfilled?,_onrejected?):Promise<TResult1|TResult2>
Defined in: rpc.ts:59
Execute the RPC call
Type Parameters
Section titled “Type Parameters”TResult1
Section titled “TResult1”TResult1 = Result<Returns>
TResult2
Section titled “TResult2”TResult2 = never
Parameters
Section titled “Parameters”onfulfilled?
Section titled “onfulfilled?”((value) => TResult1 | PromiseLike<TResult1>) | null
_onrejected?
Section titled “_onrejected?”((reason) => TResult2 | PromiseLike<TResult2>) | null
Returns
Section titled “Returns”Promise<TResult1 | TResult2>
throwOnError()
Section titled “throwOnError()”throwOnError():
Promise<Returns>
Defined in: rpc.ts:80
Throw on error
Returns
Section titled “Returns”Promise<Returns>