# @aabegg/websocket

> Websocket-Service, Stellt die Verbindung zum Server her und löst entsprechende Broadcaster-Events aus.

Latest version **1.0.3** (published 2017-03-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install @aabegg/websocket
pnpm add @aabegg/websocket
yarn add @aabegg/websocket
bun add @aabegg/websocket
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-03-10 |
| First published | 2017-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| Author | apmatic GmbH |
| Maintainers | aabegg |

## Links

- npm: https://www.npmjs.com/package/@aabegg/websocket
- npm.io page: https://npm.io/package/@aabegg/websocket

## Dependencies (2)

- [@angular/core](https://npm.io/package/@angular/core.md) ^4.0.0-rc.2
- [@aabegg/broadcaster](https://npm.io/package/@aabegg/broadcaster.md) ^1.0.2

## Recent versions

- 1.0.3 (latest) — 2017-03-10
- 1.0.2 — 2017-03-10
- 1.0.1 — 2017-03-09
- 1.0.0 — 2017-03-09

## README

## Installation

```sh
npm install @aabegg/websocket
```
---

## Benutzung

Das `WsModule` muss im AppModule eingebunden werden.

```typescript
import { NgModule } from '@angular/core';
import { WsModule } from '@aabegg/websocket';

@NgModule({
  declarations: [],
  imports: [WsModule],
  providers: []
})
export class AppModule { }
```

##### Verbindung herstellen:
`this._ws.connect(`ws://localhost:9900?token=${token}`);`

Beispiel:

```typescript
import { Component, onInit } from '@angular/core';
import { Ws } from '@aabegg/websocket';

@Component({
  selector: 'demo-component',
  template: '<div>demo</div>',
  styleUrls: ['./demo.component.scss']
})
export class DemoComponent implements onInit { 
  
  constructor(private _ws: Ws) { }
  
  ngOnInit() {
    this._ws.connect(`ws://localhost:9900?token=${token}`);
  }
}
```

##### Lokale Events:

Der `Websocket` löst folgende `Broadcaster` Events aus:

- websocketConnected
- websocketDisconnected
- websocketDied (Dieser Event wird nach 5 Fehlversuchen ausgelöst.)

[Broadcaster Anleitung](https://www.npmjs.com/package/@aabegg/broadcaster)


##### Events vom Server:

Der Websocket leitet alle Events vom Websocket-Server an den Broadcaster weiter.
Die Daten welche vom Server kommen werden immer als JSON geparst.
Die Daten müssen wie folgt strukturiert sein:

```json
{"data": {
  "name": "demoEventName",
  "data": {"hallo": "Welt"}
}}
```

Dieser Event kann wie folgt empfangen werden:
 
```typescript
this._bc.on('demoEventName').subscribe((data: any) => {
  console.log(data); // => {"hallo": "Welt"}
});
```

[Broadcaster Anleitung](https://www.npmjs.com/package/@aabegg/broadcaster)



---

## Versionen

### 1.0.0
- Initiale Version

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