Interface ComponentFilterRegistry

interface ComponentFilterRegistry {
    addFilters(types: "*", filters: ComponentFilter<Object>[]): void;
    addFilters(
        types: ComponentType[],
        filters: ComponentFilter<Object>[],
    ): void;
    applyFilters<T extends Object>(toFilter: T[], type: ComponentType): T[];
}

Implemented by

ComponentFilterRegistryImpl

Index

Methods

addFilters applyFilters

Methods

addFilters

addFilters(types: "*", filters: ComponentFilter<Object>[]): void
Add filters to be applied for every type of component.
Parameters
- types: "*"
- filters: ComponentFilter<Object>[]
Returns void
- Defined in packages/core/src/common/provider/provider-protocol.ts:34
addFilters(types: ComponentType[], filters: ComponentFilter<Object>[]): void
Given a list of component types, register filters to apply.
Parameters
- types: ComponentType[]
  types for which to register the filters.
- filters: ComponentFilter<Object>[]
Returns void
- Defined in packages/core/src/common/provider/provider-protocol.ts:40

applyFilters

applyFilters<T extends Object>(toFilter: T[], type: ComponentType): T[]
Applies the filters for the given component type. Generic filters will be applied on any given type.
Type Parameters
- T extends Object
Parameters
- toFilter: T[]
  the elements to filter
- type: ComponentType
  the component type for which potentially filters were registered
Returns T[]
the filtered elements
- Defined in packages/core/src/common/provider/provider-protocol.ts:48