Class BoolFilter<T>

A filter which work with booleans

Type parameters

T: Types

Hierarchy

BoolFilter

Index

Constructors

constructor

Properties

Accessors

Methods

compare

Constructors

constructor

new BoolFilter<T>(path: string, filter: Filter<Document<T>>, expr: Record<string, unknown>): BoolFilter<T>

- Defined in query/Bool.ts:11
Type parameters
- T: unknown
Parameters
- path: string
- filter: Filter<Document<T>>
- expr: Record<string, unknown>
Returns BoolFilter<T>

Properties

Protected Readonly expr

expr: Record<string, unknown>

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly path

path: string

Accessors

falsy

get falsy(): Match<T>

- Defined in query/Bool.ts:27
Filter if the boolean is falsy

Returns Match<T>

truthy

get truthy(): Match<T>

- Defined in query/Bool.ts:22
Filter if the boolean is truthy

Returns Match<T>

Methods

compare

compare(bool: boolean): Match<T>

- Defined in query/Bool.ts:32
Filter if the comparison returns true

Parameters
- bool: boolean
Returns Match<T>

Generated using TypeDoc