npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

retsly-js-sdk

v0.8.6

Published

Retsly JavaScript SDK

Downloads

32

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

victorsavictorsanicktrskzillownicktrskzillowaustinpaustinpxinzgxinzgretslybotretslybotjay.leejay.leejwleddyjwleddychrislauechrislauejkhwanjkhwantheo-ngtheo-ngenfinlayenfinlay

Keywords

retslysdkbrowsercommonjsbrowserify

Readme

wercker status

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.

To use this you will need to create an application of Retsly

You can learn more from our API Docs.

Installation

Quick start

  1. Include the hosted retsly-js-sdk in your <head> tag.
<head>
  <!-- Include the SDK -->
  <script 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>

NOTE:

If you are testing on localhost. It is important to update your Http Referrer Domain and OAuth settings in your application settings to match you testing url.

Use with Browserify

  1. First install with npm:
$ npm install retsly-js-sdk
  1. Next, anywhere that you want to use the retsly-js-sdk simply require('retsly-js-sdk'). Below is an example of using this in main.js
/**
 * main.js
 */

// Dependency
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);
  });
});
  1. When you are ready to start compiling, follow the general Browserify procedure. Here is an example with compiling main.js to target.js
$ browserify main.js -o target.js

For More information on how to use browserify, go to the docs

  1. Finally, drop a single <script> tag into your html file with the compiled script:
<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)

Copyright (c) 2014 Retsly Software Inc [email protected]

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.