Skip to content
Mog is in active development. The GitHub repo and npm SDK packages are available now; community channels are still being prepared. Follow for launch updates

ws.cells

WorksheetCellsAccessor

Sub-API for typed per-cell readback by A1 address. Surfaced on {@link Worksheet.cells}.

1 method

get

Promise<CellRecord | undefined>
get(addr: string): Promise<CellRecord | undefined>;
ParameterTypeRequired
addrstringrequired

Read a typed cell record by A1 address (e.g. `"B2"`). **Async.** Backed by the kernel's domain-layer `CellReads.getData`, which goes through the compute bridge (CellId lookup + `getActiveCell`, with spill-member and materialized-cell fallbacks). A sync read off the viewport buffer was considered and rejected: the viewport only covers the rendered window, so a sync `get` would silently return `undefined` for off-screen cells and surprise callers. Returns `undefined` when the cell is outside the sheet bounds. Empty in-bounds cells return a record with `value === null` and `valueType === RangeValueType.Empty` — deliberately divergent from `getCell`'s `{value: null}` shape so the discriminant tag is always present (callers don't need a separate "is this in-bounds" check).