API Docs for:
Show:

ResourceClientInterface Class

Defined in: /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:3
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
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:18

Create new instance of Model class, saved in database

Parameters:

  • data Object

Returns:

Object | Promise(Object):

destroyById

(
  • data
)
public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:64

Destroy model instance

Parameters:

  • data Object

destroyById

(
  • id
)
public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:72

Destroy model instance with the specified ID.

Parameters:

  • id String | Number

find

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

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:46

Find all model instances that match filter specification.

Parameters:

  • filter Object

Returns:

Array(Object) | Promise(Array(Object)):

findById

(
  • id
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:37

Find object by ID.

Parameters:

  • id String | Number

Returns:

Object | Promise(Object):

findOne

(
  • filter
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:55

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

Parameters:

  • filter Object

Returns:

Object | Promise(Object):

updateAttributes

(
  • data
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:80

Update set of attributes.

Parameters:

  • data Object

Returns:

Object | Promise(Object):

upsert

(
  • data
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/interface/resource-client-interface.coffee:27

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:

Object | Promise(Object):