ns

nativescript-socketio

Socket.IO for nativescript

Showing:

Popularity

Downloads/wk

152

Maintenance

No Maintenance Data Available

Package

Dependencies

0

Size (min+gzip)

0.2KB

License

Apache-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

npm npm Build Status

nativescript-socketio

Usage

npm install nativescript-socketio

or

tns plugin add nativescript-socketio

NativeScript Core

Set connection string and options then connect

var SocketIO = require('nativescript-socketio').SocketIO; 
var socketIO = new SocketIO(url, opts);

Alternatively:

import { SocketIO } from 'nativescript-socketio';
var socketIO = new SocketIO(url, opts);

Connect to server

socketIO.connect()

Send data to the server

socketIO.emit(event,data)

Listen for data

socketIO.on(event,callback)

Set instance

new SocketIO(null,null,oldInstance)

Angular

// app.module.ts
import { SocketIOModule } from "nativescript-socketio/angular";

@NgModule({
  imports: [
    SocketIOModule.forRoot(server),
  ]
})
// app.component.ts
import { Component, OnInit, OnDestroy } from "@angular/core";
import { SocketIO } from "nativescript-socketio";

@Component({
  // ...
})
export class AppComponent implements OnInit, OnDestroy {
  constructor(private socketIO: SocketIO) { }

  ngOnInit() {
    this.socketIO.connect();
  }

  ngOnDestroy() {
    this.socketIO.disconnect();
  }
}
// test.component.ts
import { Component, OnInit, NgZone } from "@angular/core";
import { SocketIO } from "nativescript-socketio";

@Component({
  // ...
})
export class TestComponent implements OnInit {
  constructor(
    private socketIO: SocketIO,
    private ngZone: NgZone
  ) { }

  ngOnInit() {
    this.socketIO.on("test", data => {
      this.ngZone.run(() => {
        // Do stuff here
      });
    });
  }

  test() {
    this.socketIO.emit("test", { test: "test" });
  }
}

Running Demo

Start socketio server

cd demo/demo-server
npm install
node app

Api

MethodDefaultTypeDescription
constructor(url)voidCreates a SocketIO instance with a url
constructor(url, options:{})voidCreates a SocketIO instance with url and options
constructor(null,null,nativeSocket)voidCreates a SocketIO instance from a native socket instance
connect()voidConnect to the server.
disconnect()voidDisconnects the socket.
connected()booleanChecks if the socket is connected
on(event: string,(data: Object , ack? : Function))FunctionAdds a handler for a client event. Return a function to remove the handler.
once(event: string,(data: Object , ack? : Function))FunctionAdds a single-use handler for a client event. Return a function to remove the handler.
off(event: string)voidRemoves handler(s) based on an event name.
emit(event: string,data: {},ack?: Function)voidSend an event to the server, with optional data items.
joinNamespace(name: string)SocketIOReturn SocketIO instance with the namespace
leaveNamespace()voidCall when you wish to leave a namespace and disconnect this socket.

Example Image

socketio

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial