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

FilterBuilder

Static Method Summary

Static Public Methods
public static

new(): *

Constructor Summary

Public Constructor
public

Member Summary

Private Members
private
private

_fields: *

private
private

_limit: *

private

_order: *

private

_param: *

private

_skip: *

private

_where: {}

Method Summary

Public Methods
public

and(fields: string): *

Logical AND operator
public
public

buildUri(endpoint: string, decode: boolean): *

public

deleted(): *

Also return deleted records.
public

fields(fields: *): *

Include or exclude certain fields
public

include(model: *): *

Used to include related models
public

limit(limit: number): *

Limit amount of data returned
public

or(fields: string): *

Logical OR operator
public

order(field: string, sort: string): *

Order results by property
public

reset()

public

skip(skip: number): *

Number of results to skip
public

where(fields: *): *

Where query filter Accepts operators, see Where operators section for details.
Private Methods
private

_flattenFilter(ob: *, lvl: number): *

private

_operator(operation: *, fields: *)

Static Public Methods

public static new(): * source

Return:

*

Public Constructors

public constructor() source

Private Members

private _deleted: * source

private _fields: * source

private _include: * source

private _limit: * source

private _order: * source

private _param: * source

private _skip: * source

private _where: {} source

Public Methods

public and(fields: string): * source

Logical AND operator

Params:

NameTypeAttributeDescription
fields string

Return:

*

public buildObject(): * source

Return:

*

public buildUri(endpoint: string, decode: boolean): * source

Params:

NameTypeAttributeDescription
endpoint string
  • optional
  • default:
decode boolean
  • optional
  • default: false

Return:

*

public deleted(): * source

Also return deleted records. Only available on models that implement soft delete

Return:

*

public fields(fields: *): * source

Include or exclude certain fields

Params:

NameTypeAttributeDescription
fields *

Return:

*

public include(model: *): * source

Used to include related models

Params:

NameTypeAttributeDescription
model *

Return:

*

public limit(limit: number): * source

Limit amount of data returned

Params:

NameTypeAttributeDescription
limit number

Return:

*

public or(fields: string): * source

Logical OR operator

Params:

NameTypeAttributeDescription
fields string

Return:

*

public order(field: string, sort: string): * source

Order results by property

Params:

NameTypeAttributeDescription
field string
sort string

ASC or DESC

Return:

*

public reset() source

public skip(skip: number): * source

Number of results to skip

Params:

NameTypeAttributeDescription
skip number

Return:

*

public where(fields: *): * source

Where query filter Accepts operators, see Where operators section for details.

Params:

NameTypeAttributeDescription
fields *

Return:

*

Private Methods

private _flattenFilter(ob: *, lvl: number): * source

Params:

NameTypeAttributeDescription
ob *
lvl number
  • optional
  • default: 0

Return:

*

private _operator(operation: *, fields: *) source

Params:

NameTypeAttributeDescription
operation *
fields *