WSgrok

WebSocket API wrapper for creating and managing WebSocket connections

Install

Install with npm or yarn via

yarn add wsgrok

or

npm i wsgrok

API

type Event = "connect" | "disconnect" | "message" | "verify"
interface WSgrok {
    url: string
    ready: boolean
    ws?: WebSocket
    pingInterval?: number
    pending: Map<string, {
        resolve: (a: any) => any
        reject: (a: any) => any
    }>
    messageTimeout: number
    connectionVerified: boolean
    verify(): void
    connect(): Promise<void>
    on(event: Event, f: Function): void
    onNext(event: Event, f: Function): void
    cleanup(): void
    ping(): void
    send(message: any, timeout?: number): Promise<any>
}

Usage

• Use WSgrok with events

  import WSgrok from 'wsgrok'
  
  const wsgrok = new WSgrok("wss://example.com/ws")
  
  // on connected to host
  wsgrok.on('connect', () => console.log("connected to a host"))
  
  // on disconnected from a host
  wsgrok.on('disconnect', () => console.log("disconnected from a host"))
  
  // on receiving a new message from host
  wsgrok.on('message', (message: any) => console.log("new message", message))
  
  // on verify a connection to host
  wsgrok.on('verify', () => console.log("connection is verified"))

• Make a request to host using wsgrok.Send() with Promise

  import WSgrok from 'wsgrok'
  export const invokeService = () => {
    const wsgrok = new WSgrok("wss://www.example.com/ws")
  
    wsgrok.send({
      type: "INVOKE_SERVICE",
      clientType: "XNGINX"
      payload: {
        initiatorId: "xxxx-xxxx-xxxx"
        reqToken: "xxxx-xxxx-xxxx"
      }
    })
      .then(response => {
        // do your work here
      })
      .catch(error => {
        // do your work here
      })
  }

  Or with async arrow style

  import WSgrok from 'wsgrok'
  
  export const invokeService = aysnc () => {
    const wsgrok = new WSgrok("wss://www.example.com/ws")
  
    try {
      const response = await wsgrok.send({
        type: "INVOKE_SERVICE",
        clientType: "XNGINX",
        payload: {
          initiatorId: "xxxx-xxxx-xxxx"
          reqToken: "xxxx-xxxx-xxxx"
        }
      })
  
      // handle server response here
  
    } catch(error) {
      // handle server error here
    }
  }