# @advanced-rest-client/web-socket

> A web component wrapper for web socket.

Latest version **3.1.0** (published 2020-06-30) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @advanced-rest-client/web-socket
pnpm add @advanced-rest-client/web-socket
yarn add @advanced-rest-client/web-socket
bun add @advanced-rest-client/web-socket
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2020-06-30 |
| First published | 2019-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 39.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | jarrodek, lbauret, twoplustwoone |
| Keywords | web-components, web-socket, arc-components, advanced-rest-client, socket |

## Links

- npm: https://www.npmjs.com/package/@advanced-rest-client/web-socket
- Repository: https://github.com/advanced-rest-client/web-socket
- Homepage: https://github.com/advanced-rest-client/web-socket#readme
- Issues: https://github.com/advanced-rest-client/web-socket/issues
- npm.io page: https://npm.io/package/@advanced-rest-client/web-socket

## Dependencies (1)

- [lit-element](https://npm.io/package/lit-element.md) ^2.3.1

## 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

- 3.1.0 (latest) — 2020-06-30
- 3.0.2 — 2020-03-31
- 3.0.1 — 2019-07-24
- 3.0.0 — 2019-07-24
- 3.0.0-preview.1 — 2019-04-05

## README

[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/web-socket.svg)](https://www.npmjs.com/package/@advanced-rest-client/web-socket)

[![Build Status](https://travis-ci.com/advanced-rest-client/api-url-data-model.svg)](https://travis-ci.com/advanced-rest-client/web-socket)

# web-socket

A web component wrapper for web socket.

## Usage

### Installation
```
npm install --save @advanced-rest-client/web-socket
```

### In a LitElement

```js
import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/web-socket/web-socket.js';

class SampleElement extends LitElement {
  render() {
    return html`
    <web-socket auto url="wss://echo.websocket.org"></web-socket>
    `;
  }
}
customElements.define('sample-element', SampleElement);
```

## Development

```sh
git clone https://github.com/advanced-rest-client/web-socket
cd web-socket
npm install
```

### Running the demo locally

```sh
npm start
```

### Running the tests
```sh
npm test
```

---
_Source: https://npm.io/package/@advanced-rest-client/web-socket · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._