ui/build/collection-table/collection-table-row-query

Classes

CollectionFilterPathError

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:14

A filter whose path cannot be resolved against the row in hand.

This is thrown rather than answered with false because those two are not the same statement. "No row matched" is a result; "this predicate could not be evaluated" is a defect, and rendering it as an empty table shows a filter that looks like it worked and quietly hides every record. A caller filtering rows in memory should let this surface, or catch it and say the filter could not be applied — never fold it into the result set.

Extends

• Error

Constructors

Constructor

new CollectionFilterPathError(path, segment): CollectionFilterPathError;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:17

Parameters

Parameter	Type
path	readonly string[]
segment	string

Returns

CollectionFilterPathError

Overrides

Error.constructor

Properties

path

readonly path: readonly string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:15

segment

readonly segment: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:16

Variables

isPlainRecord

const isPlainRecord: <I>(input) => input is I & { [x: string]: unknown };

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:2

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
input	I

Returns

input is I & { [x: string]: unknown }

Functions

collectionTableRowMatchesFilters()

function collectionTableRowMatchesFilters(row, filters): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:24

Parameters

Parameter	Type
row	object
filters	readonly CollectionFilter[] | undefined

Returns

boolean

Throws

when a path cannot be resolved against row. A predicate that cannot be evaluated must not answer "did not match" — see the error's own note.

---

collectionTableRowMatchesSearch()

function collectionTableRowMatchesSearch(row, search): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:19

Parameters

Parameter	Type
row	object
search	string

Returns

boolean

---

collectionTableRowMatchesWhere()

function collectionTableRowMatchesWhere(row, where): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-row-query.d.ts:25

Parameters

Parameter	Type
row	object
where	Readonly<Record<string, unknown>> | undefined

Returns

boolean