Enumeration Operator

Operators for building filter expressions in Lime CRM queries.

The Operator enum defines all available operators for constructing Expressions. Operators are divided into four categories:

Logical operators - Combine multiple expressions (AND, OR, NOT)
Comparison operators - Compare property values (=, !=, <, >, <=, >=)
Text operators - Match part of a text value (BEGINS, LIKE, ENDS)
Membership operator - Check against multiple values (IN)

The same operators are used in filters the server evaluates, such as Query.filter and LoadOptions.filter, and in filters the web client evaluates locally against an object it has already loaded. The two do not compare text the same way. The client ignores case, while the server compares as the database does. Treat case sensitivity as unspecified and do not build logic that depends on it.

Each operator carries its own example below. This one shows what a single member cannot, how the categories combine into one filter.

Example: Complex real-world example, find high-priority open deals

import { Expression, Operator } from '@limetech/lime-web-components';

const highPriorityOpenDeals: Expression = {
    op: Operator.AND,
    exp: [
        {
            op: Operator.OR,
            exp: [
                { key: 'status', op: Operator.EQUALS, exp: 'open' },
                { key: 'status', op: Operator.EQUALS, exp: 'in_progress' },
            ],
        },
        { key: 'value', op: Operator.GREATER_OR_EQUAL, exp: 100_000 },
        { key: 'company.name', op: Operator.LIKE, exp: 'Tech' },
        {
            op: Operator.NOT,
            exp: { key: 'is_archived', op: Operator.EQUALS, exp: true },
        },
    ],
};

See

Expression for building filter expressions
BasicExpression for simple comparisons
AndOrExpression for combining expressions
NotExpression for negation
InExpression for list membership

Index

Enumeration Members

AND BEGINS ENDS EQUALS GREATER GREATER_OR_EQUAL IN LESS LESS_OR_EQUAL LIKE NOT NOT_EQUALS OR

Enumeration Members

AND

AND: "AND"

Logical AND: All sub-expressions must be true.

Used in AndOrExpression to require all conditions to match.

Example: Active deals worth over $50k

import { AndOrExpression, Operator } from '@limetech/lime-web-components';

const activeAndWorthOver50k: AndOrExpression = {
    op: Operator.AND,
    exp: [
        { key: 'status', op: Operator.EQUALS, exp: 'active' },
        { key: 'value', op: Operator.GREATER, exp: 50_000 },
    ],
};

BEGINS

BEGINS: "=?"

Text operator: Property begins with value.

Matches objects where the text property starts with the specified value. The operator already decides where the value has to appear, so pass the fragment on its own rather than a pattern.

Example: Email starts with a support prefix

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const supportAddress: BasicExpression = {
    key: 'email',
    op: Operator.BEGINS,
    exp: 'support@',
};

ENDS

ENDS: "=$"

Text operator: Property ends with value.

Matches objects where the text property ends with the specified value. The operator already decides where the value has to appear, so pass the fragment on its own rather than a pattern.

Example: Email ends with the acme.com domain

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const acmeAddress: BasicExpression = {
    key: 'email',
    op: Operator.ENDS,
    exp: '@acme.com',
};

EQUALS

EQUALS: "="

Equality operator: Property equals value.

Matches objects where the property equals the specified value. Works with strings, numbers, booleans, and null.

When the web client evaluates the filter and the property holds several values, such as a relation, the comparison matches if any one of them equals the value.

Example: Status equals 'active'

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const statusIsActive: BasicExpression = {
    key: 'status',
    op: Operator.EQUALS,
    exp: 'active',
};

GREATER

GREATER: ">"

Greater than operator: Property is greater than value.

Matches objects where the property value is strictly greater than the specified value. Works with numbers and with dates.

Example: Value over 50000

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const worthOver50k: BasicExpression = {
    key: 'value',
    op: Operator.GREATER,
    exp: 50_000,
};

GREATER_OR_EQUAL

GREATER_OR_EQUAL: ">="

Greater than or equal operator: Property is greater than or equal to value.

Matches objects where the property value is greater than or equal to the specified value.

Example: Value of at least 50000

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const worthAtLeast50k: BasicExpression = {
    key: 'value',
    op: Operator.GREATER_OR_EQUAL,
    exp: 50_000,
};

IN

IN: "IN"

Membership operator: Property matches any value in a list or filter.

Used in InExpression to check if property equals any value in an array, or in InFilterExpression to check against results from a saved filter. Each value in the list is compared the same way Operator.EQUALS compares one.

Example: Check against a value list or against a filter

import {
    InExpression,
    InFilterExpression,
    Operator,
} from '@limetech/lime-web-components';

const inValueList: InExpression = {
    key: 'status',
    op: Operator.IN,
    exp: ['open', 'in_progress', 'waiting'],
};

const inFilterResult: InFilterExpression = {
    type: 'filter',
    key: 'owner',
    op: Operator.IN,
    exp: 'sales_team_filter',
};

LESS

LESS: "<"

Less than operator: Property is less than value.

Matches objects where the property value is strictly less than the specified value. Works with numbers and with dates.

Example: Value under 1000

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const worthUnder1k: BasicExpression = {
    key: 'value',
    op: Operator.LESS,
    exp: 1000,
};

LESS_OR_EQUAL

LESS_OR_EQUAL: "<="

Less than or equal operator: Property is less than or equal to value.

Matches objects where the property value is less than or equal to the specified value.

Example: Age up to 30

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const upToThirty: BasicExpression = {
    key: 'age',
    op: Operator.LESS_OR_EQUAL,
    exp: 30,
};

LIKE

LIKE: "?"

Text operator: Property contains value.

Matches objects where the text property contains the specified value anywhere in the string. The operator already decides where the value has to appear, so pass the fragment on its own rather than a pattern.

Example: Name contains 'Acme'

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const nameContainsAcme: BasicExpression = {
    key: 'name',
    op: Operator.LIKE,
    exp: 'Acme',
};

NOT

NOT: "!"

Logical NOT: Inverts the result of an expression.

Used in NotExpression to exclude matching objects. The exp must be another expression. To negate a single comparison, use Operator.NOT_EQUALS rather than wrapping it in a NOT.

Example: Exclude closed deals

import { NotExpression, Operator } from '@limetech/lime-web-components';

const notClosed: NotExpression = {
    op: Operator.NOT,
    exp: { key: 'status', op: Operator.EQUALS, exp: 'closed' },
};

NOT_EQUALS

NOT_EQUALS: "!="

Inequality operator: Property does not equal value.

Matches objects where the property is not equal to the specified value.

Example: Status is not 'closed'

import { BasicExpression, Operator } from '@limetech/lime-web-components';

const statusIsNotClosed: BasicExpression = {
    key: 'status',
    op: Operator.NOT_EQUALS,
    exp: 'closed',
};

OR

OR: "OR"

Logical OR: At least one sub-expression must be true.

Used in AndOrExpression to match if any condition is true.

Example: Urgent or high priority

import { AndOrExpression, Operator } from '@limetech/lime-web-components';

const urgentOrHighPriority: AndOrExpression = {
    op: Operator.OR,
    exp: [
        { key: 'priority', op: Operator.EQUALS, exp: 'urgent' },
        { key: 'priority', op: Operator.EQUALS, exp: 'high' },
    ],
};

Enumeration Operator

Example: Complex real-world example, find high-priority open deals

See

Index

Enumeration Members

Enumeration Members

AND

Example: Active deals worth over $50k

BEGINS

Example: Email starts with a support prefix

ENDS

Example: Email ends with the acme.com domain

EQUALS

Example: Status equals 'active'

GREATER

Example: Value over 50000

GREATER_OR_EQUAL

Example: Value of at least 50000

IN

Example: Check against a value list or against a filter

LESS

Example: Value under 1000

LESS_OR_EQUAL

Example: Age up to 30

LIKE

Example: Name contains 'Acme'

NOT

Example: Exclude closed deals

NOT_EQUALS

Example: Status is not 'closed'

OR

Example: Urgent or high priority

Settings

On This Page