RequestContext
Defined in: packages/client/src/types.ts:64
Request context passed to method handlers.
Provides methods to send responses back to parent.
All response methods are async to properly handle backpressure. Always await these methods to prevent deadlocks with large payloads.
Properties
Section titled “Properties”aborted
Section titled “aborted”
readonlyaborted:boolean
Defined in: packages/client/src/types.ts:72
Was request aborted by parent?
method
Section titled “method”
readonlymethod:string
Defined in: packages/client/src/types.ts:69
Method name being handled
requestId
Section titled “requestId”
readonlyrequestId:number
Defined in: packages/client/src/types.ts:66
Request ID for correlation
Methods
Section titled “Methods”ack(
data?):Promise<void>
Defined in: packages/client/src/types.ts:95
Send acknowledgment to parent. Sets IS_RESPONSE | IS_ACK flags.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the response has been written and socket buffer has drained (if backpressure occurred).
chunk()
Section titled “chunk()”chunk(
data):Promise<void>
Defined in: packages/client/src/types.ts:104
Send stream chunk to parent. Sets IS_RESPONSE | IS_STREAM flags.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the chunk has been written and socket buffer has drained (if backpressure occurred).
end():
Promise<void>
Defined in: packages/client/src/types.ts:113
End stream. Sets IS_RESPONSE | IS_STREAM | STREAM_END flags.
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the end marker has been written and socket buffer has drained (if backpressure occurred).
error()
Section titled “error()”error(
err):Promise<void>
Defined in: packages/client/src/types.ts:122
Send error response to parent. Sets IS_RESPONSE | IS_ERROR flags.
Parameters
Section titled “Parameters”string | Error
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the error has been written and socket buffer has drained (if backpressure occurred).
onAbort()
Section titled “onAbort()”onAbort(
callback):void
Defined in: packages/client/src/types.ts:77
Register callback to be called when request is aborted.
Parameters
Section titled “Parameters”callback
Section titled “callback”() => void
Returns
Section titled “Returns”void
respond()
Section titled “respond()”respond(
data):Promise<void>
Defined in: packages/client/src/types.ts:86
Send full response to parent. Sets IS_RESPONSE flag.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the response has been written and socket buffer has drained (if backpressure occurred).