@sugoi/socket
sugoi framework socket handler, based on socket.io
Last updated 6 months ago by o.b.one .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @sugoi/socket 
SYNC missed versions from official npm registry.

@Sugoi\socket

Sugoi logo

npm version Build Status codecov

Introduction

SugoiJS is a minimal modular framework.

SugoiJS gives you the ability to use only what you need and do it fast.

this is a standalone module that can be functional on its own (as all of the SugoiJS modules).

The SugoiJS socket module uses the socket.io.

Installation

npm install --save @sugoi/socket

Bootstrapping

Bootstrapping done by:

import {SocketHandler} from "@sugoi/socket";

// serverInstance is express\koa instance
// in case you are using @socket\server, the instance returns from the 'listen' method
SocketHandler.init(serverInstance);

Socket Options

Init socket server with:

namespace - assign different endpoint to the socket server, more info on socket.io documentation

socketOptions - the socket server configurations

SocketHandler.init(serverInstance, socketConfig: SocketIOStatic.ServerOptions, namespace: string): SocketIOStatic.Server

The socketOptions variable interface is the same as on socket.io documentation

 socketOptions:{
      path: string,
      serveClient: boolean,
      adapter:Adapter,
      origins:string,
      parser:Parser
 }

Listen to events

SugoiJS socket module provides you the @SocketOn(event:string, namespace:string) decorator.

This decorator registers the callback for an event.

Example:

// SocketOn(event: string, namespace: string = "/", ...middlewares:Array<ISocketMiddleware>) {
@SocketOn('message',"/",(socket,data)=>{
    console.log("log message data: %s from socket id: %s",data,socket.id);
})
function(data,socket){
    socket.to(data.room).emit('message',data.message)
}

You can use as many decorators as you want.

Get instance

For getting the socketIO server instance, use the getServer() method of the SocketHandler instance method.

const io:SocketIOStatic.Server = SocketHandler.getHandler().getServer();

Documentation

You can find further information on Sugoi official website

Current Tags

  • 4.1.1                                ...           latest (6 months ago)

30 Versions

  • 4.1.1                                ...           6 months ago
  • 4.1.0                                ...           8 months ago
  • 4.0.3                                ...           8 months ago
  • 4.0.2                                ...           9 months ago
  • 4.0.1                                ...           9 months ago
  • 4.0.0                                ...           9 months ago
  • 3.2.0                                ...           a year ago
  • 3.1.4                                ...           a year ago
  • 3.1.3                                ...           a year ago
  • 3.1.2                                ...           a year ago
  • 3.1.1                                ...           a year ago
  • 3.1.0                                ...           a year ago
  • 3.0.0                                ...           a year ago
  • 2.0.0                                ...           2 years ago
  • 1.2.2                                ...           2 years ago
  • 1.2.1-b7                                ...           2 years ago
  • 1.2.1-b6                                ...           2 years ago
  • 1.2.1-b5                                ...           2 years ago
  • 1.2.1-b4                                ...           2 years ago
  • 1.2.1-b3                                ...           2 years ago
  • 1.2.1-b2                                ...           2 years ago
  • 1.2.1-b1                                ...           2 years ago
  • 1.2.1                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 0.0.8                                ...           2 years ago
  • 0.0.7                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 31
Dependencies (5)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |