Skip to content
On this page

Interface: Subscription

Defined in: index.ts:898 (opens in a new tab)

MethodsLink to this section

getHealth()Link to this section

TypeScript
getHealth(): {
  connected: number;
  total: number;
};

Defined in: index.ts:902 (opens in a new tab)

Relays whose subscription is currently open.

ReturnsLink to this section

TypeScript
{
  connected: number;
  total: number;
}
NameTypeDefined in
connectednumberindex.ts:902 (opens in a new tab)
totalnumberindex.ts:902 (opens in a new tab)

stop()Link to this section

TypeScript
stop(): void;

Defined in: index.ts:900 (opens in a new tab)

CLOSE the subscription on every relay and stop reconnecting.

ReturnsLink to this section

void