create typescript definition file

[pdeva]

if you could contribute a typescript definition file to the definitely typed repo it would be very helpful.
https://github.com/borisyankov/DefinitelyTyped

[jmesnil]

I'm not familiar with typescript definition but if you would be interested to contribute a patch, I'll review it.

[paulbakker]

I ran into the same issue and created a starting point for a definition. It's far from complete, but I'm not familiar enough with the API yet to complete it.

// Type definitions for stomp.js
// Custom type definition, not complete.

interface Stomp {
    over(socketType:any) : Client;
}

interface StompMessage {
    body : string;
}

interface HeartBeatConfig {
    incoming : number;
    outgoing : number;
}

interface Client {
    connect(user: string, password : string, onConnect: () => any, onError : () => any, path : string);
    subscribe(url : string, handler: (message : StompMessage) => any);
    heartbeat : HeartBeatConfig;
}

declare var Stomp : Stomp;

[dwasyluk]

It would be great to see this typedef fully completed. We're using SockJS in a current project, I'll use the base @paulbakker put together and try to complete it.

[atsu85]

I came up with following TypeScript definition (more than enough for me):

/**
 * it is possible to use other type of WebSockets by using the Stomp.over(ws) method. This method expects an object that conforms to the WebSocket definition.
 * TODO specifi minimal required object structure, see SockJS as an acceptable example: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/sockjs/sockjs.d.ts#L23
 */
declare type StompMinimalWebSocketDefinition = /* SockJS | */ any ;
declare type StompWebSocketDefinition = WebSocket | StompMinimalWebSocketDefinition;

declare type StompHeaders = { [key: string ]: string;};
declare type StompSubscriptions = { [key: string ]: string;};
declare type StompFrameCallback = (frame: StompFrame) => void;

interface StompFrame {
  command: string;
  headers: StompHeaders;
  body?: string;
}

interface StompStatic {
  over(webSocket: StompWebSocketDefinition): StompClient;
}

interface StompSubscription {
  id: any;
  unsubscribe: () => void;
}

interface HeartBeatConfig {
    incoming : number;
    outgoing : number;
}

interface StompClient {
  /* START: object internals, maybe not for public use
  connectCallback: StompFrameCallback;
  connected: boolean;
  counter: number;
  maxWebSocketFrameSize: number;
  partialData: string;
  serverActivity: number;
  subscriptions: { [key: string ]: StompFrameCallback;};
  ws: StompMinimalWebSocketDefinition;
  */
  debug: (msg: string) => void;
  heartbeat : HeartBeatConfig;
  connect(login: string, passcode: string, connectCallback?: () => void, errorCallback?: () => void, host?: string);
  connect(headers: StompHeaders, connectCallback?: StompFrameCallback, errorCallback?: StompFrameCallback);
  subscribe(destination: string, callback: (stompFrame: StompFrame, headers?: StompHeaders) => void): StompSubscription;
  disconnect(disconnectCallback?: () => void);
}

declare var Stomp: StompStatic;

(I'll also add the link in case i'll update it later: https://gist.github.com/atsu85/346b8794bf5d8b27772c)

[atsu85]

@jmesnil, Thanks for the effort with this project.
Could You take a look at the fields I've added and commented out from StompClient definition - what are the fields that are meant for internal use, and shouldn't be included in the TypeScript definitions?

I know You are not actively working on it right now, but i'd appreciate some feedback :)

[JimiC]

Typings for stompjs are now available at DefinitelyTyped types-2.0 branch.

[JimiC]

Type definitions are now available at @types/stompjs