API Docs for:
Show:

LoopbackPromised Class

Defined in: src/loopback-promised.coffee:23
Module: loopback-promised

LoopbackPromised

Methods

createClient

(
  • pluralModelName
  • [options]
)
LoopbackClient

Defined in src/loopback-promised.coffee:186

creates client for Loopback

Parameters:

  • pluralModelName String
  • [options] Object optional
    • [belongsTo] Object optional

      key: pluralModelName (the "one" side of one-to-many relation), value: id

    • [isUserModel] Boolean optional

      true if user model

    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

Returns:

LoopbackClient:

createInstance

(
  • lbPromisedInfo
)
LoopbackPromised static

Defined in src/loopback-promised.coffee:32

creates an instance

Parameters:

  • lbPromisedInfo LoopbackPromised | Object
    • baseURL String

      base URL of Loopback

    • [logger] Object optional

      logger with info(), warn(), error(), trace().

    • [version] String optional

      version of Loopback API to access

Returns:

LoopbackPromised:

createPushManager

(
  • [clientInfo]
)
PushManager public

Defined in src/loopback-promised.coffee:266

creates push manager

Parameters:

  • [clientInfo] Object optional
    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

Returns:

PushManager:

createRelatedClient

(
  • options
)
LoopbackClient

Defined in src/loopback-promised.coffee:243

creates related client (one-to-many relation)

Parameters:

  • options Object
    • one String

      the "one" side plural model of one-to-many relationship

    • many String

      the "many" side plural model of one-to-many relationship

    • id Any

      the id of the "one" model

    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

Returns:

LoopbackClient:

createUserClient

(
  • pluralModelName
  • [clientInfo]
)
LoopbackClient

Defined in src/loopback-promised.coffee:223

creates user client for Loopback

Parameters:

  • pluralModelName String
  • [clientInfo] Object optional
    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

Returns:

LoopbackClient:

isDebugMode

(
  • debug
)
Boolean private static

Defined in src/loopback-promised.coffee:283

check environment variable concerning debug

Parameters:

  • debug Boolean

Returns:

Boolean:

shows debug log or not

request

(
  • pluralModelName
  • path
  • params
  • http_method
  • [clientInfo]
)
Promise(Object)

Defined in src/loopback-promised.coffee:63

sends request to Loopback

Parameters:

  • pluralModelName String
  • path String
  • params Object

    request parameters

  • http_method String

    {GET|POST|PUT|DELETE|HEAD}

  • [clientInfo] LoopbackClient | Object optional
    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

Returns:

Promise(Object):

requestStatic

(
  • endpoint
  • [params]
  • http_method
  • [clientInfo]
  • lbPromisedInfo
)
Promise(Object) static

Defined in src/loopback-promised.coffee:85

calls rest api directly

Parameters:

  • endpoint String
  • [params] Object optional
  • http_method String

    {GET|POST|PUT|DELETE|HEAD}

  • [clientInfo] LoopbackClient | Object optional
    • [accessToken] String optional

      Access Token

    • [debug] Boolean optional

      shows debug log if true

  • lbPromisedInfo LoopbackPromised | Object
    • baseURL String

      base URL of Loopback

    • [version] String optional

      version of Loopback API to access

    • [logger] Object optional

      logger with info(), warn(), error(), trace().

Returns:

Promise(Object):