IndexRange.getIndicesFor | /mod.ts | rimbu@0.14.0

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.

actor base bimap bimultimap collection-types common core deep graph hashed list multimap multiset ordered sorted spy stream table typical

mod.ts (default module)

ArrowGraph

ArrowGraphHashed

ArrowGraphSorted

ArrowValuedGraph

ArrowValuedGraphHashed

ArrowValuedGraphSorted

EdgeValuedGraphHashed

EdgeValuedGraphSorted

HashMultiMapHashValue

HashMultiMapSortedValue

HashMultiSet

HashSet

HashTableHashColumn

HashTableSortedColumn

SortedMultiMapHashValue

SortedMultiMapSortedValue

SortedMultiSet

SortedSet

SortedTableHashColumn

SortedTableSortedColumn

function IndexRange.getIndicesFor

import { IndexRange } from "https://deno.land/x/rimbu@0.14.0/mod.ts";
const { getIndicesFor } = IndexRange;

getIndicesFor(range: IndexRange, length: number): [number, number] | "empty" | "all"

Returns, given the range IndexRange, and a target maximum length, the actual index range. This can be one of three options:

'empty': there are no elements within the range
'all': all elements are within the range
[start: number, end: number]: an inclusive range of element indices within the given range

Parameters

range: IndexRange

the IndexRange to use

length: number

the target maximum length

Returns

[number, number] | "empty" | "all"