# fmp-ws

> foolishchow midway playground for websocket

Latest version **0.0.2** (published 2020-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install fmp-ws
pnpm add fmp-ws
yarn add fmp-ws
bun add fmp-ws
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-03-26 |
| First published | 2020-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | foolishchow |
| Maintainers | foolishchow |

## Links

- npm: https://www.npmjs.com/package/fmp-ws
- Repository: https://github.com/foolishchow/fmp-ws
- Homepage: https://github.com/foolishchow/fmp-ws#readme
- Issues: https://github.com/foolishchow/fmp-ws/issues
- npm.io page: https://npm.io/package/fmp-ws

## Dependencies (1)

- [ws](https://npm.io/package/ws.md) ^7.2.3

## Recent versions

- 0.0.2 (latest) — 2020-03-26
- 0.0.1 — 2020-03-16

## README

# fmp-ws

> midway playground for websoket dependency on ws

# enable in config
```typescript
import { EggPlugin } from 'midway';
export default {
  static: true, // default is true
  fmpws: {
    enable: true,
    package: "fmp-ws"
  }
} as EggPlugin;
```

# use an websocket class
```typescript
import { Context, inject, provide, query } from "midway";
import { websockets, websocket, WebSocket } from "fmp-ws";

interface WebsocketQuery {
  name: string,
  id: string
}

@provide()
@websockets("/prefix")
export class WsSocketsController {

  @inject() ctx: Context;

  @websocket("/exec")
  async exec(@query() data: WebsocketQuery) {
    let ws: WebSocket = this.ctx.webSocket;
    //...
  }


  @websocket("/attach")
  async attach(@query() data: WebsocketQuery) {
    let ws: WebSocket = this.ctx.webSocket;
    // ...

  }


}
```

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