Skip to main content

Interface: ItemsDataProvider<TItemsDataSource, TItemsData>

Defined in: storage/base.ts:43

Base interface for items data providers

Extends​

Extended by​

Type Parameters​

TItemsDataSource​

TItemsDataSource extends ItemsDataSource

TItemsData​

TItemsData extends ItemsData

Properties​

name​

readonly name: string

Defined in: storage/base.ts:14

The name of the data provider

Inherited from​

DataProvider.name

schema​

readonly schema: JsonSchema

Defined in: storage/base.ts:17

The JSON schema for the data source

Inherited from​

DataProvider.schema

uischema​

readonly uischema: UISchemaElement

Defined in: storage/base.ts:20

The JSON Forms UI schema for the data source

Inherited from​

DataProvider.uischema

Methods​

open()​

open(dataSource, options?): Promise<TItemsData>

Defined in: storage/base.ts:29

Opens a data source and returns the loaded data accessor

Parameters​

dataSource​

TItemsDataSource

The data source to open

options?​

Optional abort signal, progress callback, and workspace directory handle

onProgress?​

ProgressCallback

signal?​

AbortSignal

workspace?​

FileSystemDirectoryHandle | null

Returns​

Promise<TItemsData>

A promise that resolves to the loaded data accessor

Inherited from​

DataProvider.open