delimRangeSpread(input: string, deliminater: string = ","): string[]

The delimRangeSpread function takes in a deliminated string of ranges and cells and returns an unique member array of all cells and cells associated with ranges provided by the input. The delimiter defaults to "," but can be specified.

import delimRangeSpread from 'range-hf';

let arrayOfCells = delimRangeSpread("AA1, A2:B3, C3, C2:C4");
let arrayOfCellsWDelim = delimRangeSpread("A2:B3|C3", "|");

console.log(arrayOfCells);
//returns ["AA1", "A2", "A3", "B2", "B3", "C3", "C2", "C4"];
console.log(arrayOfCellsWDelim);
//returns ["A2", "A3", "B2", "B3", "C3"]
  

rangeSpread(input: string): string[]

The rangeSpread function returns an array of strings representing all member cells of a range

import rangeSpread from 'range-hf';

let spreadRange = rangeSpread("Z1:AA2");

console.log(spreadRange);
//returns ["Z1", "Z2", "AA1", "AA2"]
              

isInRange(cell: string, range: string): boolean

The isInRange function checks to see if a cell is a member of a range

import isInRange from 'range-hf';

let cellCheck = isInRange("C1", "A1:D5")

console.log(cellCheck);
//returns true
              

randomCell(range: string): string

Generates a random cell as a string from a given range inclusively

import randomCell from 'range-hf';

let randomCell = randomCell("A1:D5")

console.log(randomCell);
//returns random cell in the range "A1:D5" inclusive e.g. "B1"