API Docs for:
Show:

ResourceClientInterface Class

Defined in: src/lib/resource-client-interface.coffee:2
Module: base-domain

interface of client accessing to resource. Used in BaseRepository

LoopBackClient in loopback-promised package implements this interface.

see https://github.com/CureApp/loopback-promised

Methods

create

(
  • data
)
Promise(Object) public

Defined in src/lib/resource-client-interface.coffee:18

Create new instance of Model class, saved in database

Parameters:

  • data Object

Returns:

Promise(Object):

destroyById

(
  • data
)
Promise public

Defined in src/lib/resource-client-interface.coffee:81

Destroy model instance

Parameters:

  • data Object

Returns:

Promise:

destroyById

(
  • id
)
Promise public

Defined in src/lib/resource-client-interface.coffee:93

Destroy model instance with the specified ID.

Parameters:

  • id String

Returns:

Promise:

find

(
  • filter
)
Promise(Array(Object)) public

Defined in src/lib/resource-client-interface.coffee:58

Find all model instances that match filter specification.

Parameters:

  • filter Object

Returns:

Promise(Array(Object)):

findById

(
  • id
)
Promise(Object) public

Defined in src/lib/resource-client-interface.coffee:45

Find object by ID.

Parameters:

  • id String

Returns:

Promise(Object):

findOne

(
  • filter
)
Promise(Object) public

Defined in src/lib/resource-client-interface.coffee:69

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

Parameters:

  • filter Object

Returns:

Promise(Object):

mock

() private

Defined in src/lib/resource-client-interface.coffee:118

return Promise object as mock

updateAttributes

(
  • data
)
Promise(Object) public

Defined in src/lib/resource-client-interface.coffee:105

Update set of attributes.

Parameters:

  • data Object

Returns:

Promise(Object):

upsert

(
  • data
)
Promise(Object) public

Defined in src/lib/resource-client-interface.coffee:31

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