loop54-js-connector
Advanced tools
Comparing version 1.11.154 to 1.11.158
@@ -65,3 +65,3 @@ 'use strict'; | ||
versions: { | ||
libVersion: "1.11.154", //"154" will be replaced by teamcity. also in package.json | ||
libVersion: "1.11.158", //"158" will be replaced by teamcity. also in package.json | ||
apiVersion: "V3" | ||
@@ -68,0 +68,0 @@ }, |
{ | ||
"name": "loop54-js-connector", | ||
"version": "1.11.154", | ||
"version": "1.11.158", | ||
"description": "JS Wrapper for Loop54 JSON API", | ||
@@ -5,0 +5,0 @@ "license": "BSD-3-Clause", |
@@ -35,3 +35,3 @@ # JS-Connector | ||
If you're using NPM to include the connector in your build pipeline, (for instance using Rollup or Webpack), | ||
note that the module is exported as a pure ES6 module, and it is not bundled with dependencies, transpiled or otherwise prepared for live environment. | ||
note that the module is exported as a pure ES6 module, and it is not bundled with dependencies, transpiled or otherwise prepared for live environment. | ||
You will need to make those preparations as part of your own pipeline. | ||
@@ -43,13 +43,17 @@ | ||
If you included `loop54-js-connector.js` (or `loop54-js-connector.min.js`) in a script tag, | ||
If you included `loop54-js-connector.js` (or `loop54-js-connector.min.js`) in a script tag, | ||
you can get a configured client from the global Loop54 object: | ||
__Get client from global Loop54 object__ | ||
``` | ||
```js | ||
var client = Loop54.getClient('URL_TO_YOUR_ENDPOINT'); | ||
``` | ||
If you imported the connector as an ECMAScript module (with require('loop54-js-connector') or equivalent), | ||
If you imported the connector as an ECMAScript module (with require('loop54-js-connector') or equivalent), | ||
you can call the getClient function directly: | ||
__Get client from imported function__ | ||
``` | ||
```js | ||
var client = getClient('URL_TO_YOUR_ENDPOINT'); | ||
@@ -61,3 +65,4 @@ ``` | ||
__Search example with promise__ | ||
``` | ||
```js | ||
var options = {skip:0,take:20}; //this will take the first 20 results | ||
@@ -76,3 +81,4 @@ | ||
__Search example with callback__ | ||
``` | ||
```js | ||
var options = {skip:0,take:20}; //this will take the first 20 results | ||
@@ -101,3 +107,4 @@ | ||
Using promise: | ||
``` | ||
```js | ||
const request = client.search("R2 droids", {}); //create request | ||
@@ -109,3 +116,4 @@ request.then(response => if(!response.cancelled) console.log('done')); //attach continuation | ||
Using callback: | ||
``` | ||
```js | ||
var callback = function(response) { if(!response.cancelled) console.log('done'); } //create callback | ||
@@ -118,3 +126,3 @@ const request = client.search("R2 droids", {}, callback); //create request | ||
``` | ||
```js | ||
var entity = {type:"Product",id:"1234"}; | ||
@@ -142,3 +150,4 @@ | ||
__Configuration example with custom user ID__ | ||
``` | ||
```js | ||
var client = Loop54.getClient('URL_TO_YOUR_ENDPOINT','YOUR_USER_ID'); | ||
@@ -145,0 +154,0 @@ ``` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1012699
194