Skip to main content

Class Filter

Less than 1 minute

Class Filter

Declared in packages/core/echo/echo-schema/dist/types/src/query/filter.d.ts:23

Constructors

constructor(params, [options])

Returns: Filter<T>

Arguments:

params: FilterParams<T>

options: QueryOptions

Properties

and

Type: Filter<EchoObject>[]

not

Type: boolean

options

Type: QueryOptions

or

Type: Filter<EchoObject>[]

predicate

Type: OperatorFilter<any>

properties

Type: Record<string, any>

text

Type: string

type

Type: Reference

spaceKeys

Type: undefined | PublicKey[]

Methods

toProto()

Returns: Filter

Arguments: none

and(filters)

Returns: Filter<T>

Arguments:

filters: FilterSource<T>[]

from([source], [options])

Returns: Filter<T>

Arguments:

source: FilterSource<T>

options: QueryOptions

fromProto(proto)

Returns: Filter<EchoObject>

Arguments:

proto: Filter

not(source)

Returns: Filter<T>

Arguments:

source: Filter<T>

or(filters)

Returns: Filter<T>

Arguments:

filters: FilterSource<T>[]

schema(schema, [filter])

Returns: Filter<Expando>

Arguments:

schema: Schema

filter: Record<string, any> | OperatorFilter<any>

typename(typename, [filter])

Returns: Filter<any>

Arguments:

typename: string

filter: Record<string, any> | OperatorFilter<any>