BlockSuite API Documentation / @blocksuite/sync / BlobEngine

Class: BlobEngine

Defined in: blob/engine.ts:16

BlobEngine

sync blobs between storages in background.

all operations priority use main, then use shadows.

Constructors

new BlobEngine()

new BlobEngine(main, shadows, logger): BlobEngine

Defined in: blob/engine.ts:23

Parameters

main

BlobSource

shadows

BlobSource[]

logger

Logger

Returns

BlobEngine

Properties

logger

readonly logger: Logger

Defined in: blob/engine.ts:26

---

main

readonly main: BlobSource

Defined in: blob/engine.ts:24

---

shadows

readonly shadows: BlobSource[]

Defined in: blob/engine.ts:25

Accessors

sources

Get Signature

get sources(): BlobSource[]

Defined in: blob/engine.ts:19

Returns

BlobSource[]

Methods

delete()

delete(_key): Promise<void>

Defined in: blob/engine.ts:29

Parameters

_key

string

Returns

Promise<void>

---

get()

get(key): Promise<null | Blob>

Defined in: blob/engine.ts:35

Parameters

key

string

Returns

Promise<null | Blob>

---

list()

list(): Promise<string[]>

Defined in: blob/engine.ts:46

Returns

Promise<string[]>

---

set()

Call Signature

set(value): Promise<string>

Defined in: blob/engine.ts:59

Parameters

value

Blob

Returns

Promise<string>

Call Signature

set(key, value): Promise<string>

Defined in: blob/engine.ts:61

Parameters

key

string

value

Blob

Returns

Promise<string>

---

start()

start(): void

Defined in: blob/engine.ts:107

Returns

void

---

stop()

stop(): void

Defined in: blob/engine.ts:132

Returns

void

---

sync()

sync(): Promise<void>

Defined in: blob/engine.ts:137

Returns

Promise<void>