Skip to content package
syncano-client v0.2.6-0 Interact with your Syncano Sockets.
node any 1 deps cjs
overview readme
license MIT
deps 1
unpacked Unknown
files Unknown
node any $ npm install syncano-client@0.2.6-0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
install size Estimated unpacked size across 14 packages.
2.4 MB
Includes dependencies.
dependencies 1 direct · 1 outdated
versions Latest published Sep 22, 2017
maintainers Registry package owners.
contents Getting started Constructor Syncano(instanceName, options?) Methods s(endpoint, data?, options?) s.login(username, password) s.logout() s.setToken(token) s.get(endpoint, data?, options?) s.post(endpoint, data?, options?) s.delete(endpoint, data?, options?) s.put(endpoint, data?, options?) s.patch(endpoint, data?, options?) s.subscribe(endpoint, data?, callback) s.subscribe.once(endpoint, data?, callback)
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 copy
Also available at UNPKG
syncano-devops
devops@syncano.com
<script src="https://unpkg.com/syncano-client"></script> copy The library supports the CommonJS syntax:
var Syncano = require ( 'syncano-client' ) copy You can also use it with ES6 modules:
import Syncano from 'syncano-client' copy To create a connection, simply initialize the Syncano object with instance name:
const s = new Syncano ( 'MY_INSTANCE_NAME' ) copy
Constructor
Syncano(instanceName, options?)Parameter Type Description instanceNameString Syncano instance name. You can create one using Syncano CLI . optionsObject Optional connection config. options.hostString Syncano host name. options.tokenString Allows you to initialize authorized connection. options.loginMethodFunction Define custom login method
Methods
s(endpoint, data?, options?)
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.' )) copy
s.logout()Remove user token for future requests.
s.setToken(token)Used to restore client session with token.
Parameter Type Description tokenString User token used to authorize requests.
To remove token, call setToken without parameter:
s.get(endpoint, data?, options?)Send GET request to Syncano socket.
Parameter Type Description endpointString Name of socket and endpoint joined with '/': dataObject Optional object send with request. optionsObject 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'
}
}) copy
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
}) copy # chat/socket.yml
endpoints :
global-messages :
channel : global-messages
create-message :
file : scripts/create-message.js copy // 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)
}) copy # chat/socket.yml
endpoints :
private-messages :
channel : private-messages.{room}
create-message :
file : scripts/create-message.js copy // 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)
}) copy s. subscribe ( 'chat/private-messages' , {room: 1 }, message => {
// Handle message
}) copy 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 copy 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
}) copy 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)
}) copy
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
}) copy