Interface MetadataFieldCondition

Defines conditions for filtering metadata fields during a query. Each property represents a comparison operator.

MetadataFieldCondition

Example

// Find documents where 'year' >= 2022
{ year: { $gte: 2022 } }
// Find documents where 'tags' array contains 'typescript'
{ tags: { $contains: 'typescript' } }
// Find documents where 'status' is 'published'
{ status: { $eq: 'published' } } // or simply { status: 'published' }
interface MetadataFieldCondition {
    $eq?: MetadataScalarValue;
    $ne?: MetadataScalarValue;
    $gt?: number;
    $gte?: number;
    $lt?: number;
    $lte?: number;
    $in?: MetadataScalarValue[];
    $nin?: MetadataScalarValue[];
    $exists?: boolean;
    $contains?: MetadataScalarValue;
    $all?: MetadataScalarValue[];
    $textSearch?: string;
}

Properties

$eq? $ne? $gt? $gte? $lt? $lte? $in? $nin? $exists? $contains? $all? $textSearch?

Properties

Optional $eq

$eq?: MetadataScalarValue

Optional $ne

$ne?: MetadataScalarValue

Optional $gt

$gt?: number

Optional $gte

$gte?: number

Optional $lt

$lt?: number

Optional $lte

$lte?: number

Optional $in

$in?: MetadataScalarValue[]

Optional $nin

$nin?: MetadataScalarValue[]

Optional $exists

$exists?: boolean

Optional $contains

$contains?: MetadataScalarValue

Optional $all

$all?: MetadataScalarValue[]

Optional $textSearch

$textSearch?: string

Settings

Member Visibility

Theme

On This Page

$eq$ne$gt$gte$lt$lte$in$nin$exists$contains$all$textSearch