Class FilterRangeLimit<TValue>

Editable RangeLimit: a value (null when unset) and an exclusion flag. Raises change only when one of the two actually changes.

Type Parameters

TValue = Any
Type of the value.

Hierarchy

Subscribable<FilterRangeLimitEvents<TValue>>
- FilterRangeLimit

Index

Constructors

Properties

Accessors

exclude hasValue value

Methods

_onChange dispose matchesTo on setExclude setValue toggleExclude toRangeLimit

Constructors

constructor

new FilterRangeLimit<TValue = any>(
value?: Nullable<TValue>,
exclude?: boolean,
): FilterRangeLimit<TValue>
Type Parameters
- TValue = any
  Type of the value.
Parameters
- value: Nullable<TValue> = null
  Initial value, null when unset.
- exclude: boolean = false
  Initial exclusion.
Returns FilterRangeLimit<TValue>
Overrides Subscribable< FilterRangeLimitEvents<TValue> >.constructor
- Defined in src/query-items/filtering/range/models.ts:128

Properties

`Protected`_eventBus

_eventBus: EventBus<FilterRangeLimitEvents<TValue>>

Bus used to register handlers and to raise the events.

Accessors

exclude

get exclude(): boolean
true when the limit itself is out of the range (strict comparison).

Returns boolean
- Defined in src/query-items/filtering/range/models.ts:164

hasValue

get hasValue(): boolean
true when the value is set (not null).

Returns boolean
- Defined in src/query-items/filtering/range/models.ts:188

value

get value(): Nullable<TValue>
Current value, null when unset.

Returns Nullable<TValue>
- Defined in src/query-items/filtering/range/models.ts:193

Methods

`Protected`_onChange

_onChange(): void
Returns void
- Defined in src/query-items/filtering/range/models.ts:156

dispose

dispose(): Promise<void>
Removes every registered handler.

Returns Promise<void>
Inherited from Subscribable.dispose
- Defined in node_modules/@mantlebee/ts-core/dist/src/subscriptions/subscribable/models.d.ts:25

matchesTo

matchesTo(filterRangeLimit: FilterRangeLimit<TValue>): boolean
Parameters
- filterRangeLimit: FilterRangeLimit<TValue>
  Limit to compare with.
Returns boolean
true when value and exclusion are the same.
- Defined in src/query-items/filtering/range/models.ts:138

on

on<TKey extends string>(
event: TKey,
handler: EventHandler<FilterRangeLimitEvents<TValue>, TKey>,
): IDisposable
Registers a handler for an event.
Type Parameters
- TKey extends string
  Name of the event to listen to.
Parameters
- event: TKey
  Event to subscribe to.
- handler: EventHandler<FilterRangeLimitEvents<TValue>, TKey>
  Callback invoked every time event is raised.
Returns IDisposable
a subscription; dispose it to remove this single handler.
Inherited from Subscribable.on
- Defined in node_modules/@mantlebee/ts-core/dist/src/subscriptions/subscribable/models.d.ts:33

setExclude

setExclude(exclude: boolean): void
Parameters
- exclude: boolean
  New exclusion; nothing happens when it is the current one.
Returns void
- Defined in src/query-items/filtering/range/models.ts:171

setValue

setValue(value: Nullable<TValue>): void
Parameters
- value: Nullable<TValue>
  New value, null to unset; nothing happens when it is the current one (compared with ===).
Returns void
- Defined in src/query-items/filtering/range/models.ts:200

toggleExclude

toggleExclude(): void
Inverts the exclusion, always raising change.

Returns void
- Defined in src/query-items/filtering/range/models.ts:179

toRangeLimit

toRangeLimit(): Nullable<RangeLimit<TValue>>
Returns Nullable<RangeLimit<TValue>>
the plain RangeLimit, or null when the value is unset.
- Defined in src/query-items/filtering/range/models.ts:147