Module: Payload

Types containing references to R objects, raw data or errors over the webR communication channel.

Table of contents

Type Aliases

• WebRPayload
• WebRPayloadErr
• WebRPayloadPtr
• WebRPayloadRaw
• WebRPayloadWorker

Functions

• isWebRPayload
• isWebRPayloadPtr
• isWebRPayloadRaw
• webRPayloadAsError

Type Aliases

WebRPayload

Ƭ WebRPayload: WebRPayloadRaw | WebRPayloadPtr

Defined in

webR/payload.ts:34

---

WebRPayloadErr

Ƭ WebRPayloadErr: Object

Type declaration

Name	Type
obj	{ message: string ; name: string ; stack?: string }
obj.message	string
obj.name	string
obj.stack?	string
payloadType	"err"

Defined in

webR/payload.ts:23

---

WebRPayloadPtr

Ƭ WebRPayloadPtr: Object

Type declaration

Name	Type
obj	{ methods?: string[] ; ptr: RPtr ; type?: RType }
obj.methods?	string[]
obj.ptr	RPtr
obj.type?	RType
payloadType	"ptr"

Defined in

webR/payload.ts:14

---

WebRPayloadRaw

Ƭ WebRPayloadRaw: Object

Type declaration

Name	Type
obj	WebRDataRaw
payloadType	"raw"

Defined in

webR/payload.ts:9

---

WebRPayloadWorker

Ƭ WebRPayloadWorker: WebRPayloadRaw | WebRPayloadPtr | WebRPayloadErr

Defined in

webR/payload.ts:35

Functions

isWebRPayload

▸ isWebRPayload(value): value is WebRPayload

Test for an WebRPayload instance.

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is WebRPayload

True if the object is an instance of an WebRPayload.

Defined in

webR/payload.ts:53

---

isWebRPayloadPtr

▸ isWebRPayloadPtr(value): value is WebRPayloadPtr

Test for an WebRPayloadPtr instance.

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is WebRPayloadPtr

True if the object is an instance of an WebRPayloadPtr.

Defined in

webR/payload.ts:62

---

isWebRPayloadRaw

▸ isWebRPayloadRaw(value): value is WebRPayloadRaw

Test for an WebRPayloadRaw instance.

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is WebRPayloadRaw

True if the object is an instance of an WebRPayloadRaw.

Defined in

webR/payload.ts:71

---

webRPayloadAsError

▸ webRPayloadAsError(payload): Error

Parameters

Name	Type
payload	WebRPayloadErr

Returns

Error

Defined in

webR/payload.ts:38