Function avg

avg<V extends number | bigint>(): Sink<V, V | undefined>
Creates a sink averaging the items of the feed.

The mean is computed from the running total and the item count. number items are averaged as IEEE 754 doubles and bigint items as exact integers: a feed is expected to carry one numeric type throughout, and mixing the two is reported rather than silently coerced.

bigint means are rounded to the nearest integer, halves away from zero, as no fractional bigint can carry the remainder; callers needing another rounding, or a fractional mean, combine sum with count themselves.

An empty feed resolves to undefined, as a mean over no items is not defined; callers wanting a default supply it with ?? 0 or ?? 0n.
Warning
- Exhaustive: every item is drawn before the sink resolves, so an infinite feed never completes.
- Streaming: no more than the running total and count are held in memory, whatever the size of the feed.
- Stateful: the mean covers the items drawn, so a sink closing a nested or truncated feed sees those alone.
Type Parameters
- V extends number | bigint
  The type of items in the feed
Returns Sink<V, V | undefined>
A sink resolving to the mean of the items of the feed, or to undefined if the feed carried no items
Throws
TypeError If the feed mixes number and bigint items
Example
```
await pipe(
  (items([1, 2, 3, 4]))
  (avg())
);  // 2.5

await pipe(
  (items([1n, 2n, 4n]))
  (avg())
);  // 2n

await pipe(
  (items<number>([]))
  (avg())
);  // undefined
```
- Defined in sinks/avg.ts:66

Function avg

Type Parameters

Returns Sink<V, V | undefined>

Throws

Example

Settings