N

filters

namespace filters

Functions

F

all(...parts: MetroFilter[]): MetroFilter

Builds a filter matching a module every part matches, testing the parts in order.

Returns

A MetroFilter keyed by its parts' keys in any order, or unkeyed when a part is.

F

any(...parts: MetroFilter[]): MetroFilter

Builds a filter matching a module any part matches, testing the parts in order.

Returns

A MetroFilter keyed by its parts' keys in any order, or unkeyed when a part is.

F

byDisplayName(name: string): MetroFilter

Builds a filter matching a module whose displayName equals the given name.

Returns

A MetroFilter matching the module with that displayName.

F

byFilePath(path: string): MetroFilter

Builds a filter matching a module whose tracked file path equals the given path.

Returns

A MetroFilter matching the module loaded from that file path.

F

byFluxStore(name: string, short?: boolean): MetroFilter

Builds a filter matching a flux store by name, appending Store when short is set.

Returns

A MetroFilter matching the flux store with that name.

F

byName(name: string): MetroFilter

Builds a filter matching a module whose name equals the given name.

Returns

A MetroFilter matching the module with that name.

F

byProps(...props: string[]): MetroFilter

Builds a filter matching a module that exposes all of the given property names.

Returns

A MetroFilter matching modules that expose every given property.

F

byPrototypes(...prototypes: string[]): MetroFilter

Builds a filter matching a module whose prototype exposes all of the given method names.

Returns

A MetroFilter matching modules whose prototype exposes every given method.

F

byTypeName(name: string): MetroFilter

Builds a filter matching a wrapped component, like one from React.memo, whose inner type has the given name.

Returns

A MetroFilter matching the module whose type has that name.

Builds a filter matching a module the given filter does not match.

Returns

A MetroFilter keyed by the part's key, or unkeyed when the part is.

Types

A module predicate, carrying its cache key and a raw flag, produced by every by* helper.