ws.names

WorksheetNames

Sub-API for sheet-scoped named range operations.

9 methods

add

→ Promise<NamedRangeInfo>

add(name: string, reference: string, comment?: string): Promise<NamedRangeInfo>;

Parameter	Type	Required
name	string	required
reference	string	required
comment	string	optional

Add a named range scoped to this sheet. @param name - Name for the range @param reference - Cell reference (e.g., "A1:B10" or "=Sheet1!A1:B10") @param comment - Optional comment @returns The created named range info

NamedRangeInfo

has

→ Promise<boolean>

has(name: string): Promise<boolean>;

Parameter	Type	Required
name	string	required

Check if a named range exists in this sheet's scope. @param name - Name to check @returns True if the named range exists

getCount

→ Promise<number>

getCount(): Promise<number>;

Get the total number of named ranges scoped to this sheet. @returns The count of named ranges

get

→ Promise<NamedRangeInfo | null>

get(name: string): Promise<NamedRangeInfo | null>;

Parameter	Type	Required
name	string	required

Get a named range by name, scoped to this sheet. @param name - Name to look up @returns Named range info or null if not found

NamedRangeInfo

getRange

→ Promise<NamedRangeReference | null>

getRange(name: string): Promise<NamedRangeReference | null>;

Parameter	Type	Required
name	string	required

Get the range reference for a named range scoped to this sheet. @param name - Name to look up @returns Range reference or null if not found

NamedRangeReference

remove

→ Promise<void>

remove(name: string): Promise<void>;

Parameter	Type	Required
name	string	required

Remove a named range scoped to this sheet. @param name - Name to remove

update

→ Promise<void>

update(name: string, updates: NamedRangeUpdateOptions): Promise<void>;

Parameter	Type	Required
name	string	required
updates	NamedRangeUpdateOptions	required

Update a named range scoped to this sheet. @param name - Name of the range to update @param updates - Fields to update

NamedRangeUpdateOptions

clear

→ Promise<void>

clear(): Promise<void>;

Remove all named ranges scoped to this sheet.

list

→ Promise<NamedRangeInfo[]>

list(): Promise<NamedRangeInfo[]>;

List all named ranges scoped to this sheet. @returns Array of named range info objects

NamedRangeInfo