Skip to main content

StringValue

The StringValue type is used to define conditions for string fields in a query.

Type Definition​

type StringValue =
  | RequireAtLeastOne<
      Record<'$contains' | '$endsWith' | '$not' | '$startsWith', string> &
        Record<'$in' | '$notIn', Array<string>>
    >
  | string;

Properties​

$contains, $endsWith, $not, $startsWith​

  • Type: string
  • Optional: Yes

Defines contains, ends with, not, and starts with conditions for string fields.

$in, $notIn​

  • Type: string[]
  • Optional: Yes

Defines inclusion and exclusion conditions for string fields.

Example Usage​

Here is an example of how to define conditions for a string field:

const stringCondition: StringValue = {
  $startsWith: 'A'
};

In this example:

  • The query filters records where the name field starts with 'A'.