@portkey-v1/socket
v1.5.4-alpha.22
Published
![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) [![NPM Package Version][npm-image-version]][npm-url]
Downloads
102
Readme
@portkey-v1/socket
It is already possible to follow the standard abp tutorial to add SignalR to your application. However, Portkey provides SignalR integration packages those simplify the integration and usage.
Installation
Using NPM
npm install @portkey-v1/socket
Using Yarn
yarn add @portkey-v1/socket
Prerequisites
Package.json Scripts
| Script | Description |
| -------- | -------------------------------------------------- |
| clean | Uses rm
to remove dist/
|
| build | Uses tsc
to build package and dependent packages |
| lint | Uses eslint
to lint package |
| lint:fix | Uses eslint
to check and fix any warnings |
| format | Uses prettier
to format the code |
Basic Usage
import { DIDSignalr } from '@portkey-v1/socket'
// new signalr instance
const didSignalr = new DIDSignalr();
// open link
didSignalr.doOpen({ url: 'your did signalr url', clientId: 'your clientId' });
// Scan code feedback
didSignalr.onScanLogin(({ body }) => console.log(body));