Module: WebR

The webR JavaScript API.

Table of contents

References

• BrowseMessage
• CanvasMessage
• EvalRMessageOutputType
• EvalROptions
• InstallPackagesOptions
• PagerMessage
• RCall
• RCharacter
• RComplex
• RDataFrame
• RDouble
• REnvironment
• RFunction
• RInteger
• RList
• RLogical
• RNull
• RObject
• RPairlist
• RRaw
• RString
• RSymbol
• ViewMessage
• isRCall
• isRCharacter
• isRComplex
• isRDouble
• isREnvironment
• isRFunction
• isRInteger
• isRList
• isRLogical
• isRNull
• isRObject
• isRPairlist
• isRRaw
• isRSymbol

Classes

• Console
• Shelter
• WebR
• WebRChannelError
• WebRError
• WebRPayloadError
• WebRWorkerError

Interfaces

• ConsoleCallbacks
• WebRFS
• WebROptions

Type Aliases

• FSMetaData
• FSMountOptions
• FSNode
• FSType
• ShelterID

Variables

• ChannelType

Functions

• isShelterID

References

BrowseMessage

Re-exports BrowseMessage

---

CanvasMessage

Re-exports CanvasMessage

---

EvalRMessageOutputType

Re-exports EvalRMessageOutputType

---

EvalROptions

Re-exports EvalROptions

---

InstallPackagesOptions

Re-exports InstallPackagesOptions

---

PagerMessage

Re-exports PagerMessage

---

RCall

Re-exports RCall

---

RCharacter

Re-exports RCharacter

---

RComplex

Re-exports RComplex

---

RDataFrame

Re-exports RDataFrame

---

RDouble

Re-exports RDouble

---

REnvironment

Re-exports REnvironment

---

RFunction

Re-exports RFunction

---

RInteger

Re-exports RInteger

---

RList

Re-exports RList

---

RLogical

Re-exports RLogical

---

RNull

Re-exports RNull

---

RObject

Re-exports RObject

---

RPairlist

Re-exports RPairlist

---

RRaw

Re-exports RRaw

---

RString

Re-exports RString

---

RSymbol

Re-exports RSymbol

---

ViewMessage

Re-exports ViewMessage

---

isRCall

Re-exports isRCall

---

isRCharacter

Re-exports isRCharacter

---

isRComplex

Re-exports isRComplex

---

isRDouble

Re-exports isRDouble

---

isREnvironment

Re-exports isREnvironment

---

isRFunction

Re-exports isRFunction

---

isRInteger

Re-exports isRInteger

---

isRList

Re-exports isRList

---

isRLogical

Re-exports isRLogical

---

isRNull

Re-exports isRNull

---

isRObject

Re-exports isRObject

---

isRPairlist

Re-exports isRPairlist

---

isRRaw

Re-exports isRRaw

---

isRSymbol

Re-exports isRSymbol

Type Aliases

FSMetaData

Ƭ FSMetaData: Object

Emscripten filesystem image metadata

Type declaration

Name	Type
files	{ end: number ; filename: string ; start: number }[]
gzip?	boolean

Defined in

webR/webr-main.ts:118

---

FSMountOptions

Ƭ FSMountOptions<T>: T extends "NODEFS" ? { root: string } : { blobs?: { data: Blob | ArrayBufferLike ; name: string }[] ; files?: (File | FileList)[] ; packages?: { blob: Blob | ArrayBufferLike ; metadata: FSMetaData }[] }

Configuration settings to be used when mounting Filesystem objects with Emscripten

Type parameters

Name	Type
T	extends FSType = FSType

Defined in

webR/webr-main.ts:108

---

FSNode

Ƭ FSNode: Object

A filesystem entry in the Emscripten Virtual File System

Type declaration

Name	Type
contents?	{ [key: string]: FSNode; }
id	number
isFolder	boolean
mode	number
mounted	null | { mountpoint: string ; root: FSNode }
name	string

Defined in

webR/webr-main.ts:89

---

FSType

Ƭ FSType: "NODEFS" | "WORKERFS" | "IDBFS"

An Emscripten Filesystem type

Defined in

webR/webr-main.ts:102

---

ShelterID

Ƭ ShelterID: string

Defined in

webR/chan/task-common.ts:32

Variables

ChannelType

• Const ChannelType: Object

Type declaration

Name	Type
Automatic	0
PostMessage	3
ServiceWorker	2
SharedArrayBuffer	1

Defined in

webR/chan/channel-common.ts:11

Functions

isShelterID

▸ isShelterID(x): x is string

Parameters

Name	Type
x	any

Returns

x is string

Defined in

webR/chan/task-common.ts:34