@stomp/stompjs 7.0.0-beta2 → 7.0.0-beta4

package/src/types.ts

@@ -4,7 +4,7 @@ import { StompHeaders } from './stomp-headers.js';
 import { Versions } from './versions.js';
 
 /**
- * This callback will receive a `string` as parameter.
+ * This callback will receive a `string` as a parameter.
  *
  * Part of `@stomp/stompjs`.
  */
@@ -22,7 +22,7 @@ export type messageCallbackType = (message: IMessage) => void;
  *
  * Part of `@stomp/stompjs`.
  */
-export type frameCallbackType = (receipt: IFrame) => void;
+export type frameCallbackType = ((frame: IFrame) => void) | (() => void);
 
 /**
  * This callback will receive a [CloseEvent]{@link https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent}
@@ -64,7 +64,7 @@ export interface IPublishParams {
    */
   binaryBody?: Uint8Array;
   /**
-   * By default a `content-length` header will be added in the Frame to the broker.
+   * By default, a `content-length` header will be added in the Frame to the broker.
    * Set it to `true` for the header to be skipped.
    */
   skipContentLengthHeader?: boolean;
@@ -110,17 +110,18 @@ export interface IStompSocketMessageEvent {
  * @internal
  */
 export interface IStompSocket {
-  onclose: ((this: IStompSocket, ev?: any) => any) | null;
-  onerror: ((this: IStompSocket, ev: any) => any) | null;
-  onmessage: ((this: IStompSocket, ev: IStompSocketMessageEvent) => any) | null;
-  onopen: ((this: IStompSocket, ev?: any) => any) | null;
-  terminate?: ((this: IStompSocket) => any) | null;
+  url: string;
+  onclose: ((ev?: any) => any) | undefined | null;
+  onerror: ((ev: any) => any) | undefined | null;
+  onmessage: ((ev: IStompSocketMessageEvent) => any) | undefined | null;
+  onopen: ((ev?: any) => any) | undefined | null;
+  terminate?: (() => any) | undefined | null;
 
   /**
    * Returns a string that indicates how binary data from the socket is exposed to scripts:
    * We support only 'arraybuffer'.
    */
-  binaryType: 'arraybuffer';
+  binaryType?: string;
 
   /**
    * Returns the state of the socket connection. It can have the values of StompSocketState.

package/src/versions.ts

@@ -27,10 +27,10 @@ export class Versions {
   ]);
 
   /**
-   * Takes an array of string of versions, typical elements '1.0', '1.1', or '1.2'
+   * Takes an array of versions, typical elements '1.2', '1.1', or '1.0'
    *
-   * You will an instance if this class if you want to override supported versions to be declared during
-   * STOMP handshake.
+   * You will be creating an instance of this class if you want to override
+   * supported versions to be declared during STOMP handshake.
    */
   constructor(public versions: string[]) {}