Skip to main content

Class: PageEmbedder

Defined in: web-embed/src/provider.ts:60

Extends​

  • BaseProvider

Constructors​

Constructor​

new PageEmbedder(createWorker, options?): PageEmbedder

Defined in: web-embed/src/provider.ts:69

createWorker starts the model's worker: bundled with the page, or with its runtime from a CDN.

Parameters​

createWorker​

() => Worker

options?​

PageEmbedderOptions = {}

Returns​

PageEmbedder

Overrides​

BaseProvider.constructor

Properties​

getState​

getState: () => ProviderState

Defined in: client/dist/index.d.ts:841

Current state; the core re-reads it after onChange fires.

Returns​

ProviderState

Inherited from​

BaseProvider.getState

id​

readonly id: string

Defined in: client/dist/index.d.ts:835

Inherited from​

BaseProvider.id

label​

readonly label: string

Defined in: client/dist/index.d.ts:836

Inherited from​

BaseProvider.label

locality​

readonly locality: Locality

Defined in: client/dist/index.d.ts:837

Inherited from​

BaseProvider.locality

model​

readonly model: string

Defined in: web-embed/src/provider.ts:62

offers​

readonly offers: readonly ["embed"]

Defined in: web-embed/src/provider.ts:61

onChange​

onChange: (listener) => () => void

Defined in: client/dist/index.d.ts:842

Subscribe to state changes. Returns the unsubscribe function.

Parameters​

listener​

() => void

Returns​

() => void

Inherited from​

BaseProvider.onChange

Methods​

connect()​

connect(): Promise<void>

Defined in: web-embed/src/provider.ts:98

Download the model (call it from a click).

Returns​

Promise<void>

createSession()​

createSession(): Promise<ProviderSession>

Defined in: web-embed/src/provider.ts:113

Returns​

Promise<ProviderSession>

Overrides​

BaseProvider.createSession

detect()​

detect(): Promise<void>

Defined in: web-embed/src/provider.ts:79

Returns​

Promise<void>

Overrides​

BaseProvider.detect

embed()​

embed(__namedParameters): Promise<EmbedResult>

Defined in: web-embed/src/provider.ts:102

Parameters​

__namedParameters​

EmbedRequest

Returns​

Promise<EmbedResult>

setState()​

protected setState(patch): void

Defined in: client/dist/index.d.ts:845

Parameters​

patch​

Partial<ProviderState>

Returns​

void

Inherited from​

BaseProvider.setState