API Docs for:
Show:

LoopbackRelatedClient Class

Extends LoopbackClient
Defined in: src/loopback-related-client.coffee:5
Module: loopback-promised

Loopback Client to access to PersistedModel (or extenders) via one-to-many relation

Methods

count

(
  • [where]
)
Promise(Number)

Inherited from LoopbackClient: src/loopback-client.coffee:50

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

Parameters:

  • [where] Object optional

Returns:

Promise(Number):

create

(
  • data
)
Promise(Object)

Inherited from LoopbackClient: src/loopback-client.coffee:68

Create new instance of Model class, saved in database

Parameters:

  • data Object

Returns:

Promise(Object):

destroy

(
  • data
)
Promise

Inherited from LoopbackClient: src/loopback-client.coffee:207

Destroy model instance

Parameters:

  • data Object

Returns:

Promise:

destroyById

(
  • id
)
Promise

Inherited from LoopbackClient: src/loopback-client.coffee:190

Destroy model instance with the specified ID.

Parameters:

  • id String

Returns:

Promise:

exists

(
  • id
)
Promise(Object)

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:73

Check whether a model instance exists in database.

Parameters:

  • id String

Returns:

Promise(Object):

find

(
  • filter
)
Promise(Array(Object))

Inherited from LoopbackClient: src/loopback-client.coffee:142

Find all model instances that match filter specification.

Parameters:

  • filter Object

Returns:

Promise(Array(Object)):

findById

(
  • id
)
Promise(Object)

Inherited from LoopbackClient: src/loopback-client.coffee:124

Find object by ID.

Parameters:

  • id String

Returns:

Promise(Object):

findOne

(
  • filter
)
Promise(Object)

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:94

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

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:38

sends request to Loopback

Parameters:

  • path String
  • params Object

    request parameters

  • http_method String

    {GET|POST|PUT|DELETE}

Returns:

Promise(Object):

setAccessToken

(
  • id
)
Promise(Object)

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:28

set id of the "one" model

Parameters:

  • id Any

Returns:

Promise(Object):

updateAll

(
  • where
  • data
)
Promise(Array(Object))

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:108

Update multiple instances that match the where clause

Parameters:

  • where Object
  • data Object

Returns:

Promise(Array(Object)):

updateAttributes

(
  • data
)
Promise(Object)

Inherited from LoopbackClient: src/loopback-client.coffee:219

Update set of attributes.

Parameters:

  • data Object

Returns:

Promise(Object):

upsert

(
  • data
)
Promise(Object)

Inherited from LoopbackClient but overwritten in src/loopback-related-client.coffee:55

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):