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

syncano-client

v0.2.9

Published

Interact with your Syncano Sockets.

Downloads

23

Readme

CircleCI codecov

Syncano Client Library

This library enables you to interact with the Syncano Sockets via Javascript.

Getting started

Installing from NPM

npm install syncano-client --save

Also available at UNPKG

<script src="https://unpkg.com/syncano-client"></script>

Usage

The library supports the CommonJS syntax:

var Syncano = require('syncano-client')

You can also use it with ES6 modules:

import Syncano from 'syncano-client'

Creating a connection

To create a connection, simply initialize the Syncano object with instance name:

const s = new Syncano('MY_INSTANCE_NAME')

Constructor

Syncano(instanceName, options?)

| Parameter | Type | Description | |-----------|------|-------------| | instanceName | String | Syncano instance name. You can create one using Syncano CLI. | | options | Object | Optional connection config. | | options.host | String | Syncano host name. | | options.token | String | Allows you to initialize authorized connection. | | options.loginMethod | Function | Define custom login method |

Methods

s(endpoint, data?, options?)

Alias of s.post method.

s.login(username, password)

Before you can send authorized requests, you need to login user with username and password. This method will automatically save user token for future requests.

s.login('john.doe', 'secret')
  .then(user => console.log(`Hello ${user.first_name}`))
  .catch(() => console.log('Invalid username or password.'))

s.logout()

Remove user token for future requests.

s.setToken(token)

Used to restore client session with token.

| Parameter | Type | Description | |-----------|------|-------------| | token | String | User token used to authorize requests. |

To remove token, call setToken without parameter:

s.setToken()

s.get(endpoint, data?, options?)

Send GET request to Syncano socket.

| Parameter | Type | Description | |-----------|------|-------------| | endpoint | String | Name of socket and endpoint joined with '/': | | data | Object | Optional object send with request. | | options | Object | Optional request configuration. |

// countries - socket name
// list - endpoint name
s.get('countries/list')

// Pass additional data to request
s.get('countries/list', { order_by: 'name' })

// Configure request
s.get('countries/list', {}, {
  headers: {
    'Content-Type': 'application/json'
  }
})

For more options, view axios documentation

s.post(endpoint, data?, options?)

Send POST request to Syncano Socket. View s.get method for more info.

s.delete(endpoint, data?, options?)

Send DELETE request to Syncano Socket. View s.get method for more info.

s.put(endpoint, data?, options?)

Send PUT request to Syncano Socket. View s.get method for more info.

s.patch(endpoint, data?, options?)

Send PATCH request to Syncano Socket. View s.get method for more info.

s.subscribe(endpoint, data?, callback)

Subscribe to given Syncano endpoint. Callback is fired each time something is pushed to channel bound to endpoint.

// your-client-side-file.js
// chat - socket name
// poll-messages - endpoint name
s.subscribe('chat/poll-messages', message => {
  // Handle message
})

Public channels

# chat/socket.yml
endpoints:
  global-messages:
    channel: global-messages
  create-message:
    file: scripts/create-message.js
// chat/scripts/create-message.js
import {data, channel} from 'syncano-server'

data.messages
  .create({
    content: ARGS.content,
    user: META.user.id
  })
  .then(message => {
    channel.publish(`global-messages`, message)
  })

Room channels

# chat/socket.yml
endpoints:
  private-messages:
    channel: private-messages.{room}
  create-message:
    file: scripts/create-message.js
// chat/scripts/create-message.js
import {data, channel} from 'syncano-server'

data.messages
  .create({
    room_id: ARGS.room_id,
    content: ARGS.content, 
    user: META.user.id
  })
  .then(message => {
    channel.publish(`private-messages.${ARGS.room_id}`, message)
  })
s.subscribe('chat/private-messages', {room: 1}, message => {
  // Handle message
})

User channels

First, you have to use special variable {user} in your channel name. It'll be used to check if user trying to access endpoint have rights to do it.

# notifications/socket.yml
endpoints:
  get:
    channel: notifications.{user}
  notify:
    file: scripts/notify.js

Then you can subscribe to channel by passing socket and endpoint name. User channels require user_key to be send in payload.

s.subscribe('notifications/get', {user_key: 'USER_KEY'}, notification => {
  // Handle notification
})

To publish to the user channel, you have to know it's username.

In channel name notifications.{user} - {user} must always be username, not id or any other property.

// notifications/scripts/notify.js
import {data, channel} from 'syncano-server'

data.notifications
  .create({
    content: ARGS.content,
    username: ARGS.username
  })
  .then(notification => {
    channel.publish(`notifications.${ARGS.username}`, notification)
  })

s.subscribe.once(endpoint, data?, callback)

Sometimes you want to listen only for one event and after that stop handling new events.

s.subscribe.('user-auth/verify', isVerified => {
  // Handle verification
})