# vlix

> A library that lets you communicate to other computers.

Latest version **1.0.2** (published 2022-04-27) · ISC license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2022-04-27 |
| First published | 2022-04-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | diegab |
| Keywords | communication, library, ws, websocket |

## Links

- npm: https://www.npmjs.com/package/vlix
- npm.io page: https://npm.io/package/vlix

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) ^8.5.0
- [express](https://npm.io/package/express.md) ^4.18.0
- [express-ws](https://npm.io/package/express-ws.md) ^5.0.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-04-27
- 1.0.1 — 2022-04-27
- 1.0.0 — 2022-04-27

## README

# Vlix
A library that lets you communicate to other computers.

# Examples
## Create server

```js
var Vlix = require("vlix");
var {
    Server
} = new Vlix();
var server = new Server(8080);
server.on("hello", function(message, client){
  client.send("Hello " + message + "!");
})
server.run();
```

## Connect to server
```js
var Vlix = require("vlix");
var {
    Client
} = new Vlix();
var server = new Client("<URL of server here>");
server.send("hello", "World", function(msg) {
    console.log(msg); // Hello World!
    server.close();
});
```

# License
```
MIT License

Copyright (c) 2022 Unzor

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

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