guacamole-client-typedefs/lib/Parser.d.ts

Work in progress typescript definitions based on http://guacamole.apache.org/doc/guacamole-common-js/

declare module 'guacamole-client' {
  /**
   * Simple Guacamole protocol parser that invokes an oninstruction event when
   * full instructions are available from data received via receive().
   * @constructor
   */
  export class Parser {
    /**
     * Appends the given instruction data packet to the internal buffer of
     * this Guacamole.Parser, executing all completed instructions at
     * the beginning of this buffer, if any.
     * @param packet The instruction data to receive.
     */
    receive(packet: string): void;

    /**
     * Fired once for every complete Guacamole instruction received, in order.
     * @event
     * @param {String} opcode The Guacamole instruction opcode.
     * @param {Array} parameters The parameters provided for the instruction, if any.
     */
    oninstruction: null | ((opcode: string, params: unknown[]) => void);
  }
}