BlockSuite API Documentation / @blocksuite/sync / BroadcastChannelDocSource

Class: BroadcastChannelDocSource

Defined in: doc/impl/broadcast.ts:16

Implements

• DocSource

Constructors

new BroadcastChannelDocSource()

new BroadcastChannelDocSource(channelName): BroadcastChannelDocSource

Defined in: doc/impl/broadcast.ts:44

Parameters

channelName

string = 'blocksuite:doc'

Returns

BroadcastChannelDocSource

Properties

channel

channel: BroadcastChannel

Defined in: doc/impl/broadcast.ts:38

---

channelName

readonly channelName: string = 'blocksuite:doc'

Defined in: doc/impl/broadcast.ts:44

---

docMap

docMap: Map<string, Uint8Array<ArrayBufferLike>>

Defined in: doc/impl/broadcast.ts:40

---

name

name: string = 'broadcast-channel'

Defined in: doc/impl/broadcast.ts:42

for debug

Implementation of

DocSource.name

Methods

pull()

pull(docId, state): null | { data: Uint8Array<ArrayBufferLike>; state: Uint8Array<ArrayBufferLike>; }

Defined in: doc/impl/broadcast.ts:52

Parameters

docId

string

state

Uint8Array

Returns

null | { data: Uint8Array<ArrayBufferLike>; state: Uint8Array<ArrayBufferLike>; }

Implementation of

DocSource.pull

---

push()

push(docId, data): void

Defined in: doc/impl/broadcast.ts:60

Parameters

docId

string

data

Uint8Array

Returns

void

Implementation of

DocSource.push

---

subscribe()

subscribe(cb): () => void

Defined in: doc/impl/broadcast.ts:81

Subscribe to updates from peer

Parameters

cb

(docId, data) => void

callback to handle updates

Returns

Function

unsubscribe function

Returns

void

Implementation of

DocSource.subscribe