# zsockets

> Fully standard and standalone socket lib based on net from node

Latest version **1.0.7** (published 2019-03-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install zsockets
pnpm add zsockets
yarn add zsockets
bun add zsockets
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-03-28 |
| First published | 2019-03-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ZAUB1 |
| Maintainers | zaub1 |

## Links

- npm: https://www.npmjs.com/package/zsockets
- Repository: https://github.com/zaub1/ZSockets
- Homepage: https://github.com/zaub1/ZSockets#readme
- Issues: https://github.com/zaub1/ZSockets/issues
- npm.io page: https://npm.io/package/zsockets

## Recent versions

- 1.0.7 (latest) — 2019-03-28
- 1.0.6 — 2019-03-27
- 1.0.5 — 2019-03-25
- 1.0.4 — 2019-03-10
- 1.0.3 — 2019-03-10
- 1.0.2 — 2019-03-10
- 1.0.1 — 2019-03-10
- 1.0.0 — 2019-03-10

## README

# ZSockets

ZSockets is a fully standalone socket library allowing both TCP and Websocket protocol.


## How to use
ZSockets is fairly simple to use, here are few examples on the way to use it :
### Installation
```
# Installs the lib
$ npm install zsockets
```
### Server example
Sample code:

```js
const Socket = require("zsockets");
const port = 500;

const Server = new Socket.Server(port, () => { //Creates the server
    console.log("Server listening on port", port); //Callback when server is running
});

Server.OnInternal("connection", (c) => { //Triggered when a client connects
    console.log("New client connected:", c.ip);

    setTimeout(() => {
	c.Emit("testevent", {}); //Trigger an event on this specific client
    }, 500);

    c.On("testbackclient", () => { //Event triggered from this client to the server
	console.log("Back from specific client");
    });
});

setInterval(() => {
   Server.EmitToAll("testall", {}); //Event triggered on all clients
}, 1000);
```
### Websocket server example
```js
const Socket = require("zsockets");

const WSS = new Socket.WebSocketServer(8080, () => {
    console.log("Listening on port 8080");
});

WSS.OnInternal("connection", (c) => {
    c.Emit("blblbl");

    c.On("test", () => {
        console.log("Back from client");
    });
});
```
### Client example
Sample code:

```js
const Socket = require("zsockets");
const Client = new Socket.Client("127.0.0.1", 500); //Connecting to the server

Client.On("testevent", () => { //Event triggered from server
    console.log("It works UwU");

    Client.Emit("testbackclient", {}) //Trigger event on server
});

//Event triggered from server (in this case the server is triggering on all clients)
Client.On("testall", () => {
    console.log("All clients yay !");
});
```
### Web Client
=> https://github.com/ZAUB1/zsockets-webclient
## Documentation
### Table of Contents

  - [Class: Server](#server)
    - [new Socket.Server(port[, callback])](#new-socketserverport-callback)
    - [Server.OnInternal(event[, callback])](#serveroninternalevent-callback)
    - [Server.EmitToAll(event[, object])](#serveremittoallevent-object)
  - [Class: Websocket Server](#websocket-server)
    - [new Socket.Server(port[, callback])](#new-socketwebsocketserverport-callback)
    - [Server.OnInternal(event[, callback])](#websocketserveroninternalevent-callback)
    - [Server.EmitToAll(event[, object])](#serveremittoallevent-object-1)
  - [Class: Client object (Server Side)](#client-object-server-side-both-tcp--websocket)
    - [Client.On(event[, callback])](#clientonevent-callback)
    - [Client.Emit(event[, object])](#clientemitevent-object)
    - [Client.Ip](#clientip-string)
  - [Class: Client](#client)
    - [new Socket.Client(ip, port)](#new-socketclientip-port)
    - [Client.On(event[, callback])](#clientonevent-callback-1)
    - [Client.Emit(event[, object])](#clientemitevent-object-1)
### Server

#### new Socket.Server(port[, callback])
  - `port` _(int)_ The port on which the clients will connect to the server.
  - `callback` _(function)_
#### Server.OnInternal(event[, callback])
- `event` _(string)_ The internal event name to listen to
	- `"connection"`: Triggered when a new client connects
		- Callback contains client _(Object)_
	- `"disconnected"`: Triggered when a client disconnects
		- Callback contains client _(Object)_
	- `"error"`: Triggered when the server occurs an error
		- Callback contains error _(Object)_
	- `"cerror"`: Triggered when one of the clients occurs an error
		- Callback contains error _(Object)_
	
- `callback` _(function)_
#### Server.EmitToAll(event[, object])
- `event` _(string)_ Event name to trigger on all clients connected
- `object` _(Object)_

### Websocket server
#### new Socket.WebSocketServer(port[, callback])
  - `port` _(int)_ The port on which the clients will connect to the server.
  - `callback` _(function)_
#### WebSocketServer.OnInternal(event[, callback])
- `event` _(string)_ The internal event name to listen to
	- `"connection"`: Triggered when a new client connects
		- Callback contains client _(Object)_
	- `"disconnected"`: Triggered when a client disconnects
		- Callback contains client _(Object)_
#### Server.EmitToAll(event[, object])
- `event` _(string)_ Event name to trigger on all clients connected
- `object` _(Object)_

### Client object (server side, both TCP & WebSocket)

#### Client.On(event[, callback])
- `event` _(string)_ The server event name to listen for client trigger
- `callback` _(function)_
#### Client.Emit(event[, object])
- `event` _(string)_ Event name to trigger on client
- `object` _(Object)_
#### Client.ip _(string)_
Contains the client ip.
#### Client.id _(int)_
Contains the client unique id.

### Client
#### new Socket.Client(ip, port)
  - `ip` _(string)_ The ip of the server
  - `port` _(int)_ The port of the server
#### Client.On(event[, callback])
- `event` _(string)_ The client event name to listen for server trigger
	- `"connect"`: Triggered when connected to server
	- `"disconnect"`: Triggered when disconnected from server
- `callback` _(function)_
#### Client.Emit(event[, object])
- `event` _(string)_ Event name to trigger on server
- `object` _(Object)_

---
_Source: https://npm.io/package/zsockets · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._