## Overview
WS-User module is a library that manages user data over the websocket protocol.
Used when building a **single-page application** (**SPA**), this library offers a modern approach.
Now using the specially designed module [`ws13`](https://www.npmjs.com/package/ws13) to get a better and more stable connection.
It frontends and backends for user data management libraries.
`browser.js` is a frontend library that provides a user interface for managing user data.
`index.js` is a backend library that provides managing user data over the websocket protocol in real-time.
This module is part of the ['conextra'](https://www.npmjs.com/package/conextra) framework,
which is a simple and easy-to-use single-page application (SPA) framework.
You have to try it! A different solution than MVC (model–view–controller).
## Features
- Create new user
- Login and logout user
- Retrieve user details
- Update existing user information
- Open data link over websocket. Used module [`ws13`](https://www.npmjs.com/package/ws13).
- and more...
## Installation
You can install `ws-user` using this command:
`npm install ws-user`
## Configuration
You can configure the `ws-user` module using the `config-sets.json` file:
```json
{
"isProduction": true,
"production": {
"ws-user": {
"pathToFrontendErrors": "log/frontend_errors.log",
"pathToLoggedUsers": "logged_users.json",
"pathToUsersDir": "users"
},
"nodemailer": {
"host": "smtp-mail.outlook.com",
"port": 587,
"secureConnection": false,
"tls": {
"ciphers": "SSLv3"
},
"auth": {
"user": "*user*@outlook.com",
"pass": ""
}
}
},
"development": {}
}
```
## Usage
On the server side, you can use the following code to start the server:
```javascript
const CreateWsUser = require('ws-user');
const wsUser = CreateWsUser(options);
if (wsUser) {
wsUser.onerror = (error) => {
console.error(error);
};
wsUser.onopen = () => {
console.log('Server started');
};
wsUser.onclose = () => {
console.log('Server closed');
};
wsUser.onmessage = (event) => {
// Received message from client and websocket is paused, disable to receive messages
console.log(event.data);
wsUser.messageHandled(); // continue, websocket is open, enable to receive messages
};
wsUser.extensionCommands = {
'myCommand': (event) => {
console.log(event);
const myData = event.message; // Received `myData` from client
// Do something
// Send response to client
wsUser.send(`$myCommand:${myData}`);
event.done(); // or wsUser.messageHandled(); `myCommand` is handled > continue, websocket is open
}
};
}
```
On the client side, you can use the following code to connect to the server:
```html
WS-User
```
## License
This project is licensed under the MIT License.
Copyright © 2021 Manuel Lõhmus
[](https://www.paypal.com/donate?hosted_button_id=GJHV8E2DBBFJU)
Donations are welcome and will go towards further development of this project.