Skip to content
A simple, restful, message-based wrapper around client.
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


This library is part of the Aurelia platform and contains a simple, restful, message-based wrapper around client.

To keep up to date on Aurelia, please visit and subscribe to the official blog. If you have questions, we invite you to join us on Join the chat at


  • Depending on target browser(s), core-js may be required for Promise support.


Used By

This library is used directly by applications only.

Platform Support

This library can be used in the browser only.

Building The Code

To build the code, follow these steps.

  1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
  2. From the project folder, execute the following command:
npm install
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

  1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
  1. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. You can now run the tests with this command:
karma start


Load the plugin

During bootstrapping phase, you can now include the sails socket client plugin:

import { CSRFInterceptor, LoggerInterceptor } from 'aurelia-sails-socket-client';

export function configure(aurelia) {
    .plugin('aurelia-sails-socket-client', (sails, io) => {
      sails.configure(x => {

        // Example for CSRFInterceptor - if you are using Sails CSRF protection
        x.withInterceptor(new CSRFInterceptor('/csrfToken', sails));
        x.withInterceptor(new LoggerInterceptor());


  aurelia.start().then(a => a.setRoot('app', document.body));

Now you can use it in you classes:

import { inject } from 'aurelia-framework';
import { SailsSocketClient } from 'aurelia-sails-socket-client';

export class Login {

  constructor(sails) {
    this.sails = sails;

  login(credentials) {"/login", credentials)
      .then((response) => alert("Success login"))
      .catch((response) => alert("Wrong credentials"));

You can’t perform that action at this time.