Skip to content
Sheetwritev0.5.1

RowBridgeOptions@sheetwrite/core

On this page
@sheetwrite/coreinterface

Options for the framework-neutral, opt-in row bridge.

Source
packages/core/src/row-bridge.ts#L24

Members 6

columns 
readonly columns: readonly RowBridgeColumn<Row>[];
defaultRows 
readonly defaultRows: readonly Row[];
getRowId 
readonly getRowId: (row: Row, index: number) => Id;
sheet Sheet identity used by the simple data-first adapter. 
readonly sheet?: SheetId;

Sheet identity used by the simple data-first adapter. Defaults to `sheet1`.

createRowId Optional identity factory for rows created by an addRows operation. 
readonly createRowId?: (context: RowBridgeInsertContext) => Id;
maxRecentTransactions Maximum entries in each recent identity window; defaults to 8,192. 
readonly maxRecentTransactions?: number;

Maximum entries in each recent identity window; defaults to 8,192. Must be a positive safe integer.

Declaration

View full TypeScript declaration 
export interface RowBridgeOptions<
  Row extends Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (row: Row, index: number) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (context: RowBridgeInsertContext) => Id;
  readonly maxRecentTransactions?: number;
}

Referenced by

Workspace packages depending on @sheetwrite/core

  • @sheetwrite/benchdependency
  • @sheetwrite/docs-startdependency
  • @sheetwrite/reactdependency
  • @sheetwrite/sveltedependency
  • @sheetwrite/vuedependency
  • @sheetwrite/xlsxdependency

Public exports naming RowBridgeOptions

Documentation