Home > sculp-js > filterDeep

filterDeep() function

Tree filter function, can be used to filter Array and NodeList type data.

Signature:

export declare function filterDeep<V>(tree: ArrayLike<V>, predicate: (val: V, index: number, currentArr: ArrayLike<V>, tree: ArrayLike<V>, parent: V | null, level: number) => boolean | void, options?: {
    childField?: string;
    reverse?: boolean;
    breadthFirst?: boolean;
    isDomNode?: boolean;
}): V[];

Parameters

Parameter	Type	Description
tree	ArrayLike<V>	Tree data
predicate	(val: V, index: number, currentArr: ArrayLike<V>, tree: ArrayLike<V>, parent: V | null, level: number) => boolean | void	Predicate function
options	{ childField?: string; reverse?: boolean; breadthFirst?: boolean; isDomNode?: boolean; }	(Optional) Options to customize child element name, reverse traversal, breadth-first traversal. Default: { childField: 'children', reverse: false, breadthFirst: false, isDomNode: false, }

Returns:

V[]

{V[]}