Home Reference Source 
import ParamBuilder from 'spaceinvoices-api-client/src/services/paramBuilder.js'
public class | source

ParamBuilder

Constructor Summary

Public Constructor
public

Member Summary

Private Members
private

_filter: *

Method Summary

Public Methods
public

between(valFrom: *, valTo: *): *

True if the value is between the two specified values greater than or equal to first value and less than or equal to second value.
public

eq(value: *): FilterBuilder

Equivalence
public

gt(value: string | number | Date): *

Numerical greather than (>) Valid for numberical and date values.
public

gte(value: string | number | Date): *

Numerical greater than of equal (>=) Valid for numberical and date values.
public

inq(values: *): *

In an array of values.
public

like(value: string): *

LIKE operators for use with regular expressions
public

lt(value: string | number | Date): *

Numerical less than (<) Valid only for numerical and date values.
public

lte(value: string | number | Date): *

Numerical less than or equal (<=) Valid only for numerical and date values.
public

near(near: string, maxDistance: number, unit: string): *

For geolocations, return the closest points, sorted in order of distance.
public

neq(value: *): *

Not equal (!=)
public

nin(values: *): *

Not in an array of values.
public

nlike(value: string): *

NOT LIKE operators for use with regular expressions
public

regexp(regexp: string): *

Regular expression
Private Methods
private

_setValue(value: *)

Sets the value to the filter builder

Public Constructors

public constructor(filter: FilterBuilder) source

Params:

NameTypeAttributeDescription
filter FilterBuilder

Private Members

private _filter: * source

Public Methods

public between(valFrom: *, valTo: *): * source

True if the value is between the two specified values greater than or equal to first value and less than or equal to second value.

Params:

NameTypeAttributeDescription
valFrom *
valTo *

Return:

*

public eq(value: *): FilterBuilder source

Equivalence

Params:

NameTypeAttributeDescription
value *

Return:

FilterBuilder

public gt(value: string | number | Date): * source

Numerical greather than (>) Valid for numberical and date values. For Geopoint values, the units are in miles by default.

Params:

NameTypeAttributeDescription
value string | number | Date

Return:

*

public gte(value: string | number | Date): * source

Numerical greater than of equal (>=) Valid for numberical and date values. For Geopoint values, the units are in miles by default.

Params:

NameTypeAttributeDescription
value string | number | Date

Return:

*

public inq(values: *): * source

In an array of values.

Params:

NameTypeAttributeDescription
values *

Return:

*

public like(value: string): * source

LIKE operators for use with regular expressions

Params:

NameTypeAttributeDescription
value string

Return:

*

public lt(value: string | number | Date): * source

Numerical less than (<) Valid only for numerical and date values. For Geopoint values, the units are in miles by default.

Params:

NameTypeAttributeDescription
value string | number | Date

Return:

*

public lte(value: string | number | Date): * source

Numerical less than or equal (<=) Valid only for numerical and date values. For Geopoint values, the units are in miles by default.

Params:

NameTypeAttributeDescription
value string | number | Date

Return:

*

public near(near: string, maxDistance: number, unit: string): * source

For geolocations, return the closest points, sorted in order of distance. Use with limit to return the n closest points. maxDistance and unit can also be passed on same level as near to configure the search.

Params:

NameTypeAttributeDescription
near string
maxDistance number
unit string

miles or meters. Default: miles

Return:

*

public neq(value: *): * source

Not equal (!=)

Params:

NameTypeAttributeDescription
value *

Return:

*

public nin(values: *): * source

Not in an array of values.

Params:

NameTypeAttributeDescription
values *

Return:

*

public nlike(value: string): * source

NOT LIKE operators for use with regular expressions

Params:

NameTypeAttributeDescription
value string

Return:

*

public regexp(regexp: string): * source

Regular expression

Params:

NameTypeAttributeDescription
regexp string

Return:

*

Private Methods

private _setValue(value: *) source

Sets the value to the filter builder

Params:

NameTypeAttributeDescription
value *