DataSource | @sheetwrite/core

Host callback that asynchronously loads cancellable row pages.

Package: @sheetwrite/core
Source: packages/core/src/types/data.ts#L39

Members 1

getRows Loads the requested half-open row interval; implementations should stop work when its signal aborts.

getRows(request: DataSourceRequestinterface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}Cancellable sheet and row interval requested from a DataSource.API reference →): Promise<DataSourcePageinterface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}One resolved row page returned by a DataSource.API reference →>;

Declaration

View full TypeScript declaration

export interface DataSource {
  getRows(request: DataSourceRequestinterface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  sheet: SheetId;
  start: number;
  end: number;
  signal: AbortSignal;
  revision: number;
}Cancellable sheet and row interval requested from a DataSource.API reference →): Promise<DataSourcePageinterface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  start: number;
  rows: RowData[];
  revision?: string | number;
}One resolved row page returned by a DataSource.API reference →>;
}