Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

retsly-js-sdk

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

retsly-js-sdk

Retsly JavaScript SDK

0.8.2
Source
npm

Version published: 9 years ago

Weekly downloads: 20; increased by900%

Maintainers: 1

Weekly downloads

Created: 10 years ago

Source

retsly-js-sdk

Retsly core SDK. Useful for clientside integration with Retsly.

The Retsly JavaScript SDK is a toolkit that allows you to build robust realtime applications without the need for a database or a server. On top of this SDK is a component system that allows developers to create reusable plug and play components.

This component explicitly provides low-level access to the socket API. For a higher-level component, use retsly/retsly-js-backbone.

After you get an API Key you can check out the API Docs.

Installation

Quick start

Include the hosted retsly-js-sdk in your <head> tag.

<head>
  <!-- Include the SDK -->
  <script type="type/javascript" src='https://rets.ly/js/sdk'></script>
</head>

<body>
  <!-- Content -->
</body>

<!-- Get listing data from "test" vendor -->
<script type="text/javascript">
  var retsly = new Retsly(YOUR_CLIENT_ID, YOUR_JS_TOKEN);
  retsly.ready(function(){
    // '/api/v1/<vendor>/<resource>.json'
    retsly.get('/api/v1/test/listings.json', {limit: 10}, function(res){
      if (!res.success) throw new Error(res.bundle);
      console.log(res);
    });
  });
</script>

Use with Browserify

First install with npm:

$ npm install retsly-js-sdk

Next, in any of your files used to compile your client-side application, make sure to insert the dependency with:

/**
 * main.js
 */
var Retsly = require('retsly-js-sdk');

var retsly = new Retsly(YOUR_CLIENT_ID, YOUR_JS_TOKEN);
retsly.ready(function(){
  // '/api/v1/<vendor>/<resource>.json'
  retsly.get('/api/v1/test/listings.json', {limit: 10}, function(res){
    if (!res.success) throw new Error(res.bundle);
    console.log(res);
  });
});

Now you will be able to use this module to interact with our API.

When you are ready to start compiling, follow the general Browserify procedure to collect all of the required modules starting at main.js using:

$ browserify main.js -o target.js

Finally, drop a single <script> tag into your html file:

<script src="target.js"></script>

Now you should be able to make use of all of the Retsly API endpoints via the retsly-js-sdk

Build from source

Clone the repo and build the standalone file retsly.js:

$ git clone https://github.com/Retsly/retsly-js-sdk
$ cd retsly-js-sdk
$ make dist

Include in your project:

<script src='/path/to/retsly.js'></script>

This will export the client SDK as an AMD or CommonJS module, or window.Retsly.

Use with Phonegap

You'll need to add rets.ly and rets.io to your application's whitelist. See the Whitelist Guide for instructions.

Repo Owner

Jason Wan

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Keywords

FAQs

What is retsly-js-sdk?

Is retsly-js-sdk popular?

Is retsly-js-sdk well maintained?

Package last updated on 30 Oct 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install