assertBar

Documentation

Documentation / @elitechart/core / assertBar

function assertBar(
   bar, 
   prev?, 
   mode?, 
   onWarn?): void;

Defined in: data/validation.ts:49

Assert all bar invariants for a single bar. Optionally enforces strict monotonicity against the previous bar.

Parameters

bar

Bar

prev?

Bar

mode?

ValidationMode = 'strict'

onWarn?

WarnFn

Returns

void

Throws

RangeError on any violation in strict mode.

Example

import { assertBar } from '@elitechart/core';
assertBar(bars[0]);
for (let i = 1; i < bars.length; i++) assertBar(bars[i], bars[i - 1]);