Installation

npm install --save @types/stompjs

Summary

This package contains type definitions for stompjs (https://github.com/jmesnil/stomp-websocket).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stompjs.

index.d.ts

1/// <reference types="node" />
2
3export const VERSIONS: {
4    V1_0: string;
5    V1_1: string;
6    V1_2: string;
7    supportedVersions: () => string[];
8};
9
10export class Client {
11    connected: boolean;
12    counter: number;
13    heartbeat: {
14        incoming: number;
15        outgoing: number;
16    };
17    maxWebSocketFrameSize: number;
18    subscriptions: {};
19    ws: WebSocket;
20
21    debug(...args: string[]): any;
22
23    connect(
24        headers: { login: string; passcode: string; host?: string | undefined },
25        connectCallback: (frame?: Frame) => any,
26        errorCallback?: (error: Frame | string) => any,
27    ): any;
28    connect(headers: {}, connectCallback: (frame?: Frame) => any, errorCallback?: (error: Frame | string) => any): any;
29    connect(
30        login: string,
31        passcode: string,
32        connectCallback: (frame?: Frame) => any,
33        errorCallback?: (error: Frame | string) => any,
34        host?: string,
35    ): any;
36    disconnect(disconnectCallback: () => any, headers?: {}): any;
37
38    send(destination: string, headers?: {}, body?: string): any;
39    subscribe(destination: string, callback?: (message: Message) => any, headers?: {}): Subscription;
40    unsubscribe(id: string): void;
41
42    begin(transaction: string): any;
43    commit(transaction: string): any;
44    abort(transaction: string): any;
45
46    ack(messageID: string, subscription: string, headers?: {}): any;
47    nack(messageID: string, subscription: string, headers?: {}): any;
48}
49
50export interface Subscription {
51    id: string;
52    unsubscribe(): void;
53}
54
55export interface Message extends Frame {
56    ack(headers?: {}): any;
57    nack(headers?: {}): any;
58}
59
60export class Frame {
61    command: string;
62    headers: {};
63    body: string;
64    constructor(command: string, headers?: {}, body?: string);
65
66    toString(): string;
67    static sizeOfUTF8(s: string): number;
68    static unmarshall(datas: any): any;
69    static marshall(command: string, headers?: {}, body?: string): any;
70}
71
72export function client(url: string, protocols?: string | string[]): Client;
73export function over(ws: WebSocket): Client;
74export function overTCP(host: string, port: number): Client;
75export function overWS(url: string): Client;
76export function setInterval(interval: number, f: (...args: any[]) => void): NodeJS.Timer;
77export function clearInterval(id: NodeJS.Timer): void;
78

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: @types/node

Credits

These definitions were written by Jimi Charalampidis, and Stefan Erichsen.