Class TestHarness

constructor

• new TestHarness(options?: TestHarnessOptions): TestHarness

  Create a new test harness.

  Parameters

  • options: TestHarnessOptions = {}

  Returns TestHarness

ReadonlyhookCalls

ReadonlyreceivedPackets

ReadonlysentPackets

Readonlywire

lastSentPacket

• get lastSentPacket(): SentPacketRecord | undefined

  Get the last sent packet.

  Returns SentPacketRecord | undefined

version

• get version(): ProtocolVersion

  Get the protocol version (set after CONNECT).

  Returns ProtocolVersion

clear

• clear(): void

  Clear all recorded packets and hook calls.

  Returns void

clientConnect

• clientConnect(options?: Partial<ConnectPacket>): Promise<void>

  Simulate client sending CONNECT.

  Parameters

  • options: Partial<ConnectPacket> = {}

  Returns Promise<void>

clientDisconnect

• clientDisconnect(reasonCode?: ReasonCode): Promise<void>

  Simulate client sending DISCONNECT.

  Parameters

  • reasonCode: ReasonCode = 0x00

  Returns Promise<void>

clientPing

• clientPing(): Promise<void>

  Simulate client sending PINGREQ.

  Returns Promise<void>

clientPublish

• clientPublish(
      topic: string,
      payload: string | Uint8Array<ArrayBufferLike>,
      options?: {
          dup?: boolean;
          packetId?: number;
          properties?: PublishProperties;
          qos?: QoS;
          retain?: boolean;
      },
  ): Promise<void>

  Simulate client sending PUBLISH.

  Parameters

  • topic: string
  • payload: string | Uint8Array<ArrayBufferLike>
  • options: {
        dup?: boolean;
        packetId?: number;
        properties?: PublishProperties;
        qos?: QoS;
        retain?: boolean;
    } = {}

  Returns Promise<void>

clientPubrel

• clientPubrel(packetId: number): Promise<void>

  Simulate client sending PUBREL (QoS 2 continuation).

  Parameters

  • packetId: number

  Returns Promise<void>

clientSubscribe

• clientSubscribe(
      subscriptions: string | { qos?: QoS; topicFilter: string }[],
      packetId?: number,
  ): Promise<void>

  Simulate client sending SUBSCRIBE.

  Parameters

  • subscriptions: string | { qos?: QoS; topicFilter: string }[]
  • packetId: number = 1

  Returns Promise<void>

clientUnsubscribe

• clientUnsubscribe(
      topicFilters: string | string[],
      packetId?: number,
  ): Promise<void>

  Simulate client sending UNSUBSCRIBE.

  Parameters

  • topicFilters: string | string[]
  • packetId: number = 1

  Returns Promise<void>

getSentPacketsOfType

• getSentPacketsOfType<T extends PacketType>(type: T): PacketOfType<T>[]

  Get all sent packets of a specific type.

  Type Parameters

  • T extends PacketType

  Parameters

  • type: T

  Returns PacketOfType<T>[]

lastSentPacketOfType

• lastSentPacketOfType<T extends PacketType>(type: T): PacketOfType<T> | undefined

  Get the last sent packet of a specific type.

  Type Parameters

  • T extends PacketType

  Parameters

  • type: T

  Returns PacketOfType<T> | undefined

sendBytes

• sendBytes(data: Uint8Array): Promise<void>

  Send raw bytes to the wire.

  Parameters

  • data: Uint8Array

  Returns Promise<void>

sendPacket

• sendPacket(packet: MqttPacket): Promise<void>

  Send a raw packet to the wire.

  Parameters

  • packet: MqttPacket

  Returns Promise<void>

setOnConnect

• setOnConnect(
      handler: (
          packet: ConnectPacket,
      ) => ConnackPacket | Promise<ConnackPacket>,
  ): this

  Set custom onConnect handler.

  Parameters

  • handler: (packet: ConnectPacket) => ConnackPacket | Promise<ConnackPacket>

  Returns this

  Example

  harness.setOnConnect((connect) => ({
    type: PacketType.CONNACK,
    sessionPresent: false,
    reasonCode: 0x87 // Reject
  }))
  Copy

setOnSubscribe

• setOnSubscribe(
      handler: (
          packet: SubscribePacket,
      ) => SubackPacket | Promise<SubackPacket>,
  ): this

  Set custom onSubscribe handler.

  Parameters

  • handler: (packet: SubscribePacket) => SubackPacket | Promise<SubackPacket>

  Returns this

setOnUnsubscribe

• setOnUnsubscribe(
      handler: (
          packet: UnsubscribePacket,
      ) => UnsubackPacket | Promise<UnsubackPacket>,
  ): this

  Set custom onUnsubscribe handler.

  Parameters

  • handler: (packet: UnsubscribePacket) => UnsubackPacket | Promise<UnsubackPacket>

  Returns this

waitFor

• waitFor(
      condition: () => boolean,
      options?: { interval?: number; timeout?: number },
  ): Promise<void>

  Wait for a specific condition.

  Parameters

  • condition: () => boolean
  • options: { interval?: number; timeout?: number } = {}

  Returns Promise<void>

waitForSentPacketOfType

• waitForSentPacketOfType(
      type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15,
      timeout?: number,
  ): Promise<void>

  Wait for a sent packet of a specific type.

  Parameters

  • type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
  • timeout: number = 1000

  Returns Promise<void>

waitForSentPackets

• waitForSentPackets(count: number, timeout?: number): Promise<void>

  Wait for a specific number of sent packets.

  Parameters

  • count: number
  • timeout: number = 1000

  Returns Promise<void>