@serenity-is/corelib / CriteriaBuilder
Class: CriteriaBuilder
CriteriaBuilder is a class that allows to build unary or binary criteria with completion support.
Hierarchy
Array
↳
CriteriaBuilder
Table of contents
Constructors
Methods
Constructors
constructor
• new CriteriaBuilder(arrayLength?
): CriteriaBuilder
Parameters
Name | Type |
---|---|
arrayLength? |
number |
Returns
Inherited from
Array.constructor
Defined in
../../../../../Users/volka/AppData/Local/pnpm/global/5/.pnpm/typescript@5.4.4/node_modules/typescript/lib/lib.es5.d.ts:1507
Methods
bw
▸ bw(fromInclusive
, toInclusive
): any
[]
Creates a between criteria.
Parameters
Name | Type | Description |
---|---|---|
fromInclusive |
any |
from value |
toInclusive |
any |
to value |
Returns
any
[]
Defined in
contains
▸ contains(value
): any
[]
Creates a contains criteria
Parameters
Name | Type | Description |
---|---|---|
value |
string |
contains value |
Returns
any
[]
Defined in
endsWith
▸ endsWith(value
): any
[]
Creates a endsWith criteria
Parameters
Name | Type | Description |
---|---|---|
value |
string |
endsWith value |
Returns
any
[]
Defined in
eq
▸ eq(value
): any
[]
Creates an equal (=) criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
equal value |
Returns
any
[]
Defined in
ge
▸ ge(value
): any
[]
Creates a greater than or equal criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
greater than or equal value |
Returns
any
[]
Defined in
gt
▸ gt(value
): any
[]
Creates a greater than criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
greater than value |
Returns
any
[]
Defined in
in
▸ in(values
): any
[]
Creates a in criteria
Parameters
Name | Type | Description |
---|---|---|
values |
any [] |
in values |
Returns
any
[]
Defined in
isNotNull
▸ isNotNull(): any
[]
Creates a IS NOT NULL criteria
Returns
any
[]
Defined in
isNull
▸ isNull(): any
[]
Creates a IS NULL criteria
Returns
any
[]
Defined in
le
▸ le(value
): any
[]
Creates a less than or equal to criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
less than or equal to value |
Returns
any
[]
Defined in
like
▸ like(value
): any
[]
Creates a LIKE criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
like value |
Returns
any
[]
Defined in
lt
▸ lt(value
): any
[]
Creates a less than criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
less than value |
Returns
any
[]
Defined in
ne
▸ ne(value
): any
[]
Creates a not equal criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
not equal value |
Returns
any
[]
Defined in
notIn
▸ notIn(values
): any
[]
Creates a NOT IN criteria
Parameters
Name | Type | Description |
---|---|---|
values |
any [] |
array of NOT IN values |
Returns
any
[]
Defined in
notLike
▸ notLike(value
): any
[]
Creates a NOT LIKE criteria
Parameters
Name | Type | Description |
---|---|---|
value |
any |
not like value |
Returns
any
[]
Defined in
startsWith
▸ startsWith(value
): any
[]
Creates a STARTS WITH criteria
Parameters
Name | Type | Description |
---|---|---|
value |
string |
startsWith value |
Returns
any
[]