Class FilterExtensionWithFixedFilters<TItem>

FilterExtension that always sends a fixed expression too: alone when the user has no filters, otherwise grouped with the user filters through groupsLogic (default FilterLogics.and).

Example

// Only the active users, whatever the user filters.
const filtering = new FilterExtensionWithFixedFilters<User>({
  filters: [{ field: "active", operator: FilterOperators.equal, value: true }],
  logic: FilterLogics.and,
});
// payload.filters without user filters: the fixed expression itself.
filtering.addFilter({ field: "age", operator: FilterOperators.greaterThanOrEqual, value: 18 });
// payload.filters: { groups: [fixed, { filters: [age >= 18], logic: "and" }], logic: "and" }

Type Parameters

TItem = Any
Type of the items.

Hierarchy (View Summary)

FilterExtension<TItem>
- FilterExtensionWithFixedFilters

Implements

IFilterExtension<TItem>

Index

Constructors

constructor

new FilterExtensionWithFixedFilters<TItem = any>(
fixedFilters: FiltersExpression<TItem>,
options?: FilterExtensionWithFixedFiltersOptions,
): FilterExtensionWithFixedFilters<TItem>
Type Parameters
- TItem = any
  Type of the items.
Parameters
- fixedFilters: FiltersExpression<TItem>
  Expression always sent in the payload.
- Optionaloptions: FilterExtensionWithFixedFiltersOptions
  Logic of the group and debounce of the filtersChange event.
Returns FilterExtensionWithFixedFilters<TItem>
Overrides FilterExtension.constructor
- Defined in src/data-source/filtering/models.ts:153

Properties

`Protected` `Readonly`_changeDelay

_changeDelay: number

`Protected`_eventBus

_eventBus: EventBus<FilterExtensionEvents<TItem>>

Bus used to register handlers and to raise the events.

`Protected`_filters

_filters: List<Filter<TItem>> = []

`Protected` `Readonly`_fixedFilters

_fixedFilters: FiltersExpression<TItem>

`Protected` `Readonly`_groupsLogic

_groupsLogic: FilterLogics

`Protected`_logic

_logic: FilterLogics = FilterLogics.and

Accessors

filters

get filters(): List<Filter<TItem>>
Current filters, in insertion order.

Returns List<Filter<TItem>>
Implementation of IFilterExtension.filters

Inherited from FilterExtension.filters
- Defined in src/data-source/filtering/models.ts:50

fixedFilters

get fixedFilters(): FiltersExpression<TItem>
Expression always sent in the payload.

Returns FiltersExpression<TItem>
- Defined in src/data-source/filtering/models.ts:163

groupsLogic

get groupsLogic(): FilterLogics
Logic combining the fixed expression with the user filters.

Returns FilterLogics
- Defined in src/data-source/filtering/models.ts:167

hasFilters

get hasFilters(): boolean
true when at least one filter is set.

Returns boolean
Implementation of IFilterExtension.hasFilters

Inherited from FilterExtension.hasFilters
- Defined in src/data-source/filtering/models.ts:53

logic

get logic(): FilterLogics
Logic combining the filters.

Returns FilterLogics
Implementation of IFilterExtension.logic

Inherited from FilterExtension.logic
- Defined in src/data-source/filtering/models.ts:56

Methods

`Protected`_getFiltersExpression

_getFiltersExpression(): Nullable<FiltersExpression<TItem>>
Returns Nullable<FiltersExpression<TItem>>
the expression sent in the payload, null when there is none.
Overrides FilterExtension._getFiltersExpression
- Defined in src/data-source/filtering/models.ts:171

`Protected`_scheduleChange

_scheduleChange(): void
Schedules the *Change event after the quiet time, restarting the wait if one is already pending.

Returns void
Inherited from FilterExtension._scheduleChange
- Defined in src/data-source/extensions/models.ts:65

`Protected`_triggerChange

_triggerChange(): void
Raises the *Change event of the extension.

Returns void
Inherited from FilterExtension._triggerChange
- Defined in src/data-source/filtering/models.ts:119

addFilter

addFilter(filter: Filter<TItem>): void
Appends a filter. Several filters on the same field are allowed (e.g. an interval as two filters).
Parameters
- filter: Filter<TItem>
  Filter to add.
Returns void
Implementation of IFilterExtension.addFilter

Inherited from FilterExtension.addFilter
- Defined in src/data-source/filtering/models.ts:60

buildPayload

buildPayload(
payload: DataSourcePayload<TItem>,
): Promise<DataSourcePayload<TItem>>
Adds the contribution of the extension to the payload. Build phase, run in the order of the keys and completed before any item is read.
Parameters
- payload: DataSourcePayload<TItem>
  Payload built by the previous extensions.
Returns Promise<DataSourcePayload<TItem>>
the payload for the next extension.
Implementation of IFilterExtension.buildPayload

Inherited from FilterExtension.buildPayload
- Defined in src/data-source/filtering/models.ts:112

clearFilters

clearFilters(): void
Removes every filter.

Returns void
Implementation of IFilterExtension.clearFilters

Inherited from FilterExtension.clearFilters
- Defined in src/data-source/filtering/models.ts:65

dispose

dispose(): Promise<void>
Cancels the pending *Change event and removes every handler.

Returns Promise<void>
Implementation of IFilterExtension.dispose

Inherited from FilterExtension.dispose
- Defined in src/data-source/extensions/models.ts:51

on

on<TKey extends string>(
event: TKey,
handler: EventHandler<FilterExtensionEvents<TItem>, 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<FilterExtensionEvents<TItem>, TKey>
  Callback invoked every time event is raised.
Returns IDisposable
a subscription; dispose it to remove this single handler.
Implementation of IFilterExtension.on

Inherited from FilterExtension.on
- Defined in node_modules/@mantlebee/ts-core/dist/src/subscriptions/subscribable/models.d.ts:33

removeFilter

removeFilter(filter: Filter<TItem>): void
Removes a filter, compared by reference.
Parameters
- filter: Filter<TItem>
  The very object given to addFilter or setFilters.
Returns void
Implementation of IFilterExtension.removeFilter

Inherited from FilterExtension.removeFilter
- Defined in src/data-source/filtering/models.ts:70

removeFiltersOf

removeFiltersOf(field: Extract<keyof TItem>): void
Removes every filter on a field.
Parameters
- field: Extract<keyof TItem>
  Field whose filters are removed.
Returns void
Implementation of IFilterExtension.removeFiltersOf

Inherited from FilterExtension.removeFiltersOf
- Defined in src/data-source/filtering/models.ts:75

replaceFiltersOf

replaceFiltersOf(
field: Extract<keyof TItem>,
...filters: List<Filter<TItem>>,
): void
Removes every filter on a field and appends the given ones.
Parameters
- field: Extract<keyof TItem>
  Field whose filters are replaced.
- ...filters: List<Filter<TItem>>
  New filters, appended as they are (their field is not checked); none to just remove.
Returns void
Implementation of IFilterExtension.replaceFiltersOf

Inherited from FilterExtension.replaceFiltersOf
- Defined in src/data-source/filtering/models.ts:80

setFilters

setFilters(filters: List<Filter<TItem>>): void
Replaces every filter.
Parameters
- filters: List<Filter<TItem>>
  New filters.
Returns void
Implementation of IFilterExtension.setFilters

Inherited from FilterExtension.setFilters
- Defined in src/data-source/filtering/models.ts:90

setLogic

setLogic(logic: FilterLogics): void
Changes the logic combining the filters. Raises setLogic only: it does not schedule filtersChange.
Parameters
- logic: FilterLogics
  New logic.
Returns void
Implementation of IFilterExtension.setLogic

Inherited from FilterExtension.setLogic
- Defined in src/data-source/filtering/models.ts:95

Class FilterExtensionWithFixedFilters<TItem>

Example

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FilterExtensionWithFixedFilters<TItem>

Properties

Protected Readonly_changeDelay

Protected_eventBus

Protected_filters

Protected Readonly_fixedFilters

Protected Readonly_groupsLogic

Protected_logic

Accessors

filters

Returns List<Filter<TItem>>

fixedFilters

Returns FiltersExpression<TItem>

groupsLogic

Returns FilterLogics

hasFilters

Returns boolean

logic

Returns FilterLogics

Methods

Protected_getFiltersExpression

Returns Nullable<FiltersExpression<TItem>>

Protected_scheduleChange

Returns void

Protected_triggerChange

Returns void

addFilter

Parameters

Returns void

buildPayload

Parameters

Returns Promise<DataSourcePayload<TItem>>

clearFilters

Returns void

dispose

Returns Promise<void>

on

Type Parameters

Parameters

Returns IDisposable

removeFilter

Parameters

Returns void

removeFiltersOf

Parameters

Returns void

replaceFiltersOf

Parameters

Returns void

setFilters

Parameters

Returns void

setLogic

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`_changeDelay

`Protected`_eventBus

`Protected`_filters

`Protected` `Readonly`_fixedFilters

`Protected` `Readonly`_groupsLogic

`Protected`_logic

`Protected`_getFiltersExpression

`Protected`_scheduleChange

`Protected`_triggerChange