requireCellGridRange

function requireCellGridRange(
  value: unknown,
  message: string = "Expected a grid range covering exactly one cell."
): GridRange;

One row and one column, measured by the bounds rather than by how the range was written: the end indices are exclusive, so a single cell is endRowIndex - startRowIndex === 1 and the same for the columns. A range with a bound left out is open in that direction and is never a single cell.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`value`	`unknown`	The value to validate.
`message` (optional) `= "Expected a grid range covering exactly one cell."`	`string`	The message of the exception. A default is used when omitted.

Returns

GridRange — the same value, typed as a single-cell range.

Throws

Exception	Condition
`InvalidGridRangeException`	the value is not a single-cell range.

Examples

What passes and what does not

requireCellGridRange({ startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1 }); // => { startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1 }
requireCellGridRange({ startRowIndex: 0, endRowIndex: 2, startColumnIndex: 0, endColumnIndex: 1 }); // throws InvalidGridRangeException
requireCellGridRange({}); // throws InvalidGridRangeException

Source

src/appsscript/sheet/requireCellGridRange.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help