Class BrowserDucDocument

Methods

clearExternalFileRevisionChunks

clearExternalFileRevisionChunks(revisionId: string): void
Parameters
- revisionId: string
Returns void
- Defined in packages/ducjs/src/opfs.ts:181

close

close(): void
Returns void
- Defined in packages/ducjs/src/opfs.ts:295

createDucStream

createDucStream(): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
- Defined in packages/ducjs/src/opfs.ts:248

exportDucBlob

exportDucBlob(): Promise<Blob>
Returns Promise<Blob>
- Defined in packages/ducjs/src/opfs.ts:283

exportDucBytes

exportDucBytes(): Promise<Uint8Array<ArrayBufferLike>>
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/ducjs/src/opfs.ts:290

getFilename

getFilename(): string
Returns string
- Defined in packages/ducjs/src/opfs.ts:135

listExternalFiles

listExternalFiles(): unknown
Returns unknown
- Defined in packages/ducjs/src/opfs.ts:157

readCheckpointDataChunk

readCheckpointDataChunk(
checkpointId: string,
chunkIndex: number,
): undefined | Uint8Array<ArrayBufferLike>
Parameters
- checkpointId: string
- chunkIndex: number
Returns undefined | Uint8Array<ArrayBufferLike>
- Defined in packages/ducjs/src/opfs.ts:161

readDeltaChangesetChunk

readDeltaChangesetChunk(
deltaId: string,
chunkIndex: number,
): undefined | Uint8Array<ArrayBufferLike>
Parameters
- deltaId: string
- chunkIndex: number
Returns undefined | Uint8Array<ArrayBufferLike>
- Defined in packages/ducjs/src/opfs.ts:171

readExternalFileRevisionChunk

readExternalFileRevisionChunk(
revisionId: string,
chunkIndex: number,
): undefined | Uint8Array<ArrayBufferLike>
Parameters
- revisionId: string
- chunkIndex: number
Returns undefined | Uint8Array<ArrayBufferLike>
- Defined in packages/ducjs/src/opfs.ts:194

readExternalFileRevisionChunks

readExternalFileRevisionChunks(
    revisionId: string,
    startChunkIndex?: number,
    maxChunks?: number,
): Uint8Array<ArrayBufferLike>[]
Parameters
- revisionId: string
- startChunkIndex: number = 0
- maxChunks: number = MAX_EXTERNAL_CHUNK_BATCH
Returns Uint8Array<ArrayBufferLike>[]
- Defined in packages/ducjs/src/opfs.ts:198

readExternalFileRevisionRange

readExternalFileRevisionRange(
    revisionId: string,
    offsetBytes: number,
    lengthBytes: number,
): undefined | Uint8Array<ArrayBufferLike>
Parameters
- revisionId: string
- offsetBytes: number
- lengthBytes: number
Returns undefined | Uint8Array<ArrayBufferLike>
- Defined in packages/ducjs/src/opfs.ts:223

readRestoredState

readRestoredState(
elementsConfig?: ElementsConfig,
restoreConfig?: RestoreConfig,
): RestoredDataState
Parameters
- OptionalelementsConfig: ElementsConfig
- OptionalrestoreConfig: RestoreConfig
Returns RestoredDataState
- Defined in packages/ducjs/src/opfs.ts:145

readState

readState(): ExportedDataState
Returns ExportedDataState
- Defined in packages/ducjs/src/opfs.ts:139

writeExternalFileRevisionChunk

writeExternalFileRevisionChunk(
    revisionId: string,
    chunkIndex: number,
    offsetBytes: number,
    data: Uint8Array,
): void
Parameters
- revisionId: string
- chunkIndex: number
- offsetBytes: number
- data: Uint8Array
Returns void
- Defined in packages/ducjs/src/opfs.ts:185

writeState

writeState(data: Partial<ExportedDataState>): void
Parameters
- data: Partial<ExportedDataState>
Returns void
- Defined in packages/ducjs/src/opfs.ts:153

`Static`create

create(options?: BrowserDucDocumentOptions): Promise<BrowserDucDocument>
Parameters
- options: BrowserDucDocumentOptions = {}
Returns Promise<BrowserDucDocument>
- Defined in packages/ducjs/src/opfs.ts:60

`Static`deleteDatabase

deleteDatabase(
    name: string,
    wasmUrl?: string | URL | BufferSource,
    poolName?: string,
): Promise<boolean>
Parameters
- name: string
- OptionalwasmUrl: string | URL | BufferSource
- OptionalpoolName: string
Returns Promise<boolean>
- Defined in packages/ducjs/src/opfs.ts:122

`Static`listDatabases

listDatabases(
wasmUrl?: string | URL | BufferSource,
poolName?: string,
): Promise<string[]>
Parameters
- OptionalwasmUrl: string | URL | BufferSource
- OptionalpoolName: string
Returns Promise<string[]>
- Defined in packages/ducjs/src/opfs.ts:110

`Static`openDucStream

openDucStream(
stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
options?: BrowserDucDocumentOptions & DucStreamImportOptions,
): Promise<BrowserDucDocument>
Parameters
- stream: ReadableStream<Uint8Array<ArrayBufferLike>>
- options: BrowserDucDocumentOptions & DucStreamImportOptions = {}
Returns Promise<BrowserDucDocument>
- Defined in packages/ducjs/src/opfs.ts:67