commercetools-where-builder

A simple programmatic builder for CommerceTools where Query Predicates

Performs stringification and quote escaping for string, boolean and numerical values

Usage

``typescript
import { Field, Equals, And } from "commercetools-where-builder";

Field(
"masterData",
"current",
"masterVariant",
And(
Equals("key", "my-variant-key"),
Field(
"attributes",
And(
Equals("name", "my-attribute-key"),
Equals("value", "my-attribute-value")
)
)
)
);
`

This snippet builds the following where query string

`
masterData(current(masterVariant((key = "my-variant-key") and (attributes((name = "my-attribute-key") and (value = "my-attribute-value"))))))
`

Predicates

$3

`typescript
Field("bar", "baz", "foo"); // bar(baz(foo)))
`

$3

`typescript
And("bar", "baz"); // (bar) and (baz)
`

$3

`typescript
Or("bar", "baz"); // (bar) or (baz)
`

$3

`typescript
Compare("bar", "<=", 5); // bar <= 5
`

$3

`typescript
Equals("bar", 5); // bar = 5
`

$3

`typescript
NotEquals("bar", 5); // bar != 5
`

$3

`typescript
GreaterThan("bar", 5); // bar > 5
`

$3

`typescript
LessThan("bar", 5); // bar > 5
`

$3

`typescript
GreaterOrEqualThan("bar", 5); // bar >= 5
`

$3

`typescript
LessOrEqualThan("bar", 5); // bar <= 5
`

$3

`typescript
Contains("bar", "any", ["str", 123, true]); // bar contains any ("str", 123, true)
`

$3

`typescript
ContainsAll("bar", ["str", 123, true]); // bar contains all ("str", 123, true)
`

$3

`typescript
ContainsAny("bar", ["str", 123, true]); // bar contains any ("str", 123, true)
`

$3

`typescript
IsDefined("bar"); // bar is defined
`

$3

`typescript
IsNotDefined("bar"); // bar is defined
`

$3

`typescript
HasChanged("bar"); // bar has changed
`

$3

`typescript
HasNotChanged("bar"); // bar has not changed
`

$3

`typescript
WithinCircle("bar", 75.2345, 12.2345, 100); // bar within circle(75.2345, 12.2345, 100)
``