loopback-nodejs-client

KO | EN

gitlite — search

#javascript #python #ai #go #rust #docker #nodejs #windows #cli #kubernetes #vue #pytorch #mcp #openai

loopback-nodejs-client

(★ 14)

A nodejs client to call loopback api server with official sdk methods

loopback-nodejs-client Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<big><h1 align="center">loopback-nodejs-client</h1></big>

</big></p>

> NodeJS client library with loopback SDK syntax

## Install

```sh
$ npm install --save loopback-nodejs-client
```

## Usage

### Without authentification

```js
var LoopbackClient = require('loopback-nodejs-client')

var loopbackClient = new LoopbackClient('http://localhost:3000/api');

var Customers = loopbackClient.getModel('customers')

Customers.create({name: 'ido4pro', city: 'plougonvelin'})
  .then(function (customer) {
    console.log(customer)

Customers.find({filter: {where: {name: 'ido4pro'}}})
      .then(function (customers) {
        console.log(customers)

})
      .catch(function (err) {
        console.log(err)
      })

Customers.count({where: {name: 'ido4pro'}})
      .then(function (customers) {
        console.log(customers)

})
      .catch(function (err) {
        console.log(err)
      })

})
  .catch(function (err) {
    console.log(err)
  })
```

### With authentification

```js
var loopbackClientWithAuth = new LoopbackClient('http://localhost:3000/api','xxx EMAIL USER xxx', 'xxx PASSWORD xxx')

loopbackClientWithAuth.createToken()
  .then(function()
  {
      
       var Customers = loopbackClientWithAuth.getModel('customers')
       
       Customers.count({where: {name: 'ido4pro'}})
            .then(function (customers) {
              console.log(customers)
      
            })
            .catch(function (err) {
              console.log(err)
            })
      
  })

```

### With custom login path

```js

var loopbackClientWithAuth = new LoopbackClient('http://localhost:3000/api','xxx EMAIL USER xxx', 'xxx PASSWORD xxx')

// Default Value is : '/users/login?include=user'
loopbackClientWithAuth.setCustomLoginPath('/user/login?include=user')

loopbackClientWithAuth.createToken()
  .then(function()
  {
      
       var Customers = loopbackClientWithAuth.getModel('customers')
       
       Customers.count({where: {name: 'ido4pro'}})
            .then(function (customers) {
              console.log(customers)
      
            })
            .catch(function (err) {
              console.log(err)
            })
      
  })

```

# Methods

Try to be compliant with https://loopback.io/doc/en/lb3/Working-with-data.html
  
  create(data) --> data = { id: 'xxx', filter: {...} } (filter is optional)

count(query) --> query = { where : {name: 'xxx'} }, where = { where: {and: [{name: 'xxx'},{city: 'xxx'}]

*NOT AVAILABLE IN LOOPBACK EXTERNALY * updateAll(query,data)

updateById(id,data)

updateAttributesById(id,data)

find(filter)
   
  findById(data)

findOne(query)

deleteById(id)

replaceOrCreate(data)

upsertWithWhere(query,data) --> query = { where : {name: 'xxx'} }

replaceOrCreate(data)

remote(customRoute,data) -> your customRoute name (example: greet) see https://loopback.io/doc/en/lb3/Remote-methods.html

remote(customRoute,query,data) -> your customRoute name (example: greet) see https://loopback.io/doc/en/lb3/Remote-methods.html

remoteGet(customRoute,query)

remotePut(customRoute,data)

remotePatch(customRoute,data)

# Options

All methods accepts an option object to define timeout and/or additionnals headers

find({},{ timeout:2000, headers:{'TAG_ID':'146464646464}})

# Unit Tests

Check the test/index.js

# DEBUG

This lib use debug (https://github.com/visionmedia/debug) to log request

Activate log trace with environment variable "DEBUG=LoopBackClient"

example : DEBUG=LoopBackClient npm run test

# License

[npm-url]: https://npmjs.org/package/loopback-nodejs-client
[npm-image]: https://img.shields.io/npm/v/loopback-nodejs-client.svg?style=flat-square

[travis-url]: https://travis-ci.org/sguilly/loopback-nodejs-client
[travis-image]: https://img.shields.io/travis/sguilly/loopback-nodejs-client.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/sguilly/loopback-nodejs-client
[coveralls-image]: https://img.shields.io/coveralls/sguilly/loopback-nodejs-client.svg?style=flat-square

[depstat-url]: https://david-dm.org/sguilly/loopback-nodejs-client
[depstat-image]: https://david-dm.org/sguilly/loopback-nodejs-client.svg?style=flat-square

[download-badge]: http://img.shields.io/npm/dm/loopback-nodejs-client.svg?style=flat-square

loopback-nodejs-client

loopback-nodejs-client Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

loopback-nodejs-client

loopback-nodejs-client Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README