Documentation / @finchart/indicators / volumeOf

Function: volumeOf()

volumeOf(candle): number | null

Defined in: indicators/src/kernels.ts:282

The one place a kernel reads a candle's volume: a gap (null or absent — see isGap) is null here, a number is the number. Every volume-dependent indicator goes through this door, so the README's "needs volume" column can be derived from a call to it — and a .volume read anywhere else in this file is refused by the matrix check.

Parameters

candle

OHLC

Returns

number | null