API Docs for:
Show:

LoopbackClient Class

Methods

count

(
  • [where]
)
Promise(Number)

Return the number of records that match the optional "where" filter.

Parameters:

  • [where] Object optional

Returns:

Promise(Number):

create

(
  • data
)
Promise(Object)

Create new instance of Model class, saved in database

Parameters:

  • data Object

Returns:

Promise(Object):

destroy

(
  • data
)
Promise

Destroy model instance

Parameters:

  • data Object

Returns:

Promise:

destroyById

(
  • id
)
Promise

Destroy model instance with the specified ID.

Parameters:

  • id String

Returns:

Promise:

exists

(
  • id
)
Promise(Object)

Check whether a model instance exists in database.

Parameters:

  • id String

Returns:

Promise(Object):

find

(
  • filter
)
Promise(Array(Object))

Find all model instances that match filter specification.

Parameters:

  • filter Object

Returns:

Promise(Array(Object)):

findById

(
  • id
)
Promise(Object)

Find object by ID.

Parameters:

  • id String

Returns:

Promise(Object):

findOne

(
  • filter
)
Promise(Object)

Find one model instance that matches filter specification. Same as find, but limited to one result

Parameters:

  • filter Object

Returns:

Promise(Object):

request

(
  • path
  • params
  • http_method
)
Promise(Object) private

sends request to Loopback

Parameters:

  • path String
  • params Object

    request parameters

  • http_method String

    {GET|POST|PUT|DELETE}

Returns:

Promise(Object):

setAccessToken

(
  • [accessToken]
)
Promise(Object)

sets Access Token

Parameters:

  • [accessToken] String optional

    Access Token

Returns:

Promise(Object):

updateAll

(
  • where
  • data
)
Promise

Update multiple instances that match the where clause

Parameters:

  • where Object
  • data Object

Returns:

Promise:

updateAttributes

(
  • data
)
Promise(Object)

Update set of attributes.

Parameters:

  • data Object

Returns:

Promise(Object):

upsert

(
  • data
)
Promise(Object)

Update or insert a model instance The update will override any specified attributes in the request data object. It won’t remove existing ones unless the value is set to null.

Parameters:

  • data Object

Returns:

Promise(Object):