# @portkey/socket

> ![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]

Latest version **2.23.0-alpha.15** (published 2026-01-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @portkey/socket
pnpm add @portkey/socket
yarn add @portkey/socket
bun add @portkey/socket
```

## Health

**Score 60/100 (C)** — status: stable.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.23.0-alpha.15 |
| Published | 2026-01-06 |
| First published | 2023-06-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 84.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | potterp, yellow.m, frankportkey, codingwizard-portkey, aurora_v5_ptk, carbon-lv, sarah999, portkey-zz |

## Links

- npm: https://www.npmjs.com/package/@portkey/socket
- Repository: https://github.com/Portkey-Wallet/portkey-web
- Homepage: https://portkey.finance/
- Issues: https://github.com/Portkey-Wallet/portkey-web/issues
- npm.io page: https://npm.io/package/@portkey/socket

## Dependencies (2)

- [@abp/signalr](https://npm.io/package/@abp/signalr.md) ^7.0.0
- [@portkey/utils](https://npm.io/package/@portkey/utils.md) ^2.23.0-alpha.15

## Recent versions

- 2.23.0-alpha.15 (latest) — 2026-01-06
- 2.23.0-alpha.13 — 2025-11-19
- 2.22.0-alpha.11 — 2025-11-19
- 2.24.0-alpha.1 — 2025-11-11
- 2.23.0-alpha.12 — 2025-10-22
- 2.22.0-alpha.10 — 2025-10-22
- 2.23.0-alpha.11 — 2025-10-16
- 2.22.0-alpha.9 — 2025-10-16
- 2.23.0-alpha.10 — 2025-10-15
- 2.23.0-alpha.9 — 2025-09-30
- 2.23.0-alpha.8 — 2025-09-29
- 2.23.0-alpha.7 — 2025-09-29
- 2.23.0-alpha.6 — 2025-09-29
- 2.23.0-alpha.5 — 2025-09-25
- 2.23.0-alpha.4 — 2025-09-25
- … 385 more at https://npm.io/package/@portkey/socket/versions

## README

# `@portkey/socket`

![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]


It is already possible to follow [the standard abp tutorial](https://docs.abp.io/en/abp/latest/SignalR-Integration) to add [SignalR](https://docs.abp.io/en/abp/latest/SignalR-Integration) to your application. However, Portkey provides SignalR integration packages those simplify the integration and usage.


## Installation

### Using NPM

```bash
npm install @portkey/socket
```

### Using Yarn

```bash
yarn add @portkey/socket
```

## Prerequisites

- :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium)
- :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/)

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

```typescript
import { DIDSignalr } from '@portkey/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));
```

[npm-image-version]: https://img.shields.io/npm/v/@portkey/socket
[npm-url]: https://npmjs.org/package/@portkey/socket

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