NgDocFilterByTextPipe · API

Keeps the items that match a search term. By default an item matches when its string form equals the term.

Decorators: @Pipe
Generic types: T
Implements: PipeTransform

DeclarationTypeScript

@Pipe({ … })
export class NgDocFilterByTextPipe<T> implements PipeTransform { … }

Members

Methods

(…): readonly T[]

implements PipeTransform

—

Signature

transform(items: readonly T[], searchTerm: string, matcher: (item: T, searchTerm: string) => boolean = (item: T, s: string) => String(item) === s): readonly T[];

Parameters

Name	Type	Description
items	`readonly T[]`
searchTerm	`string`
matcher	`(item: T, searchTerm: string) => boolean`

Returns

readonly T[]

Symbol

Kind: Class
Decorators: @Pipe
Generic types: T
Implements: PipeTransform
Scope: @ng-doc/app

Edit this page