promise-ws

WebJar for promise-ws

License	MIT
GroupId	org.webjars.npm
ArtifactId	promise-ws
Last Version	1.0.0-1
Release Date	Apr 30, 2020
Type	jar
Description	promise-ws WebJar for promise-ws
Project URL	https://www.webjars.org
Source Code Management	https://github.com/cantonjs/promise-ws

Download promise-ws

Filename	Size
promise-ws-1.0.0-1.pom
promise-ws-1.0.0-1.jar	5 KB
promise-ws-1.0.0-1-sources.jar	22 bytes
promise-ws-1.0.0-1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/promise-ws/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>promise-ws</artifactId>
    <version>1.0.0-1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/promise-ws/
implementation 'org.webjars.npm:promise-ws:1.0.0-1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/promise-ws/
implementation ("org.webjars.npm:promise-ws:1.0.0-1")

Apache Buildr

'org.webjars.npm:promise-ws:jar:1.0.0-1'

Apache Ivy

<dependency org="org.webjars.npm" name="promise-ws" rev="1.0.0-1">
  <artifact name="promise-ws" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='promise-ws', version='1.0.0-1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "promise-ws" % "1.0.0-1"

Leiningen

[org.webjars.npm/promise-ws "1.0.0-1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : pify	jar	[3.0.0,4)
org.webjars.npm : ws	jar	[6.0.0,7)

Project Modules

There are no modules declared in this project.

promise-ws

A promise based WebSocket implementation for Node.js. Built on top of ws

Table of Contents

• Table of Contents
• Usage examples
  • Simple client
  • Simple server
• Installation
• API Reference
• License

Usage examples

Simple client

import WebSocket from "promise-ws";

(async function() {
  const ws = await WebSocket.create("ws://www.host.com/path");

  ws.on("message", function incoming(data) {
    console.log(data);
  });

  await ws.send("something");
})();

Simple server

import WebSocket from "promise-ws";

(async function() {
  const wss = await WebSocket.Server.create({ port: 8080 });

  wss.on("connection", async function connection(ws) {
    ws.on("message", function incoming(message) {
      console.log("received: %s", message);
    });

    await ws.send("something");
  });
})();

Installation

$ npm install promise-ws

API Reference

promise-ws API is almost the same with ws except that:

• websocket.ping([data[, mask]]) returns a promise
• websocket.pong([data[, mask]]) returns a promise
• websocket.send(data[, options]) returns a promise
• 🆕 WebSocket.Server.create(options), returns a promise of listened WebSocket.Server instance
• 🆕 WebSocket.create(options), returns a promise of opened WebSocket instance

For more WebSocket API, please checkout the API doc.

License

MIT

undefined

Versions

Version
1.0.0-1 Apr 30, 2020