Taxum / @taxum/core / http / SizeHint

Class: SizeHint

Defined in: http/size-hint.ts:6

Represents a size range with a lower and an optional upper bound.

This is used as hints in response bodies to determine their possible size.

Properties

lower

readonly lower: number

Defined in: http/size-hint.ts:7

---

upper

readonly upper: null | number

Defined in: http/size-hint.ts:8

Methods

exact()

exact(): null | number

Defined in: http/size-hint.ts:39

Returns an exact size if both lower and upper are equal.

Returns

null | number

---

exact()

static exact(value): SizeHint

Defined in: http/size-hint.ts:32

Creates a size hint with an exact size.

Parameters

value

number

Returns

SizeHint

---

range()

static range(lower, upper): SizeHint

Defined in: http/size-hint.ts:25

Creates a size hint with a known range.

Parameters

lower

number

upper

number

Returns

SizeHint

---

unbounded()

static unbounded(): SizeHint

Defined in: http/size-hint.ts:18

Creates a size hint with an unknown size.

Returns

SizeHint