Skip to content

Commit 18a357c

Browse files
authoredAug 5, 2024··
fix(types): unsubscribe options type (#1921)
* Improve unsubscribe typing * Update async unsubscribe too * Lint
1 parent dec1012 commit 18a357c

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed
 

‎src/lib/client.ts

+13-6
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ export interface IClientReconnectOptions {
323323
}
324324
export interface IClientSubscribeProperties {
325325
/*
326-
* MQTT 5.0 properies object of subscribe
326+
* MQTT 5.0 properties object of subscribe
327327
* */
328328
properties?: ISubscribePacket['properties']
329329
}
@@ -370,6 +370,13 @@ export type ISubscriptionMap = {
370370
resubscribe?: boolean
371371
}
372372

373+
export interface IClientUnsubscribeProperties {
374+
/*
375+
* MQTT 5.0 properties object for unsubscribe
376+
* */
377+
properties?: IUnsubscribePacket['properties']
378+
}
379+
373380
export { IConnackPacket, IDisconnectPacket, IPublishPacket, Packet }
374381
export type OnConnectCallback = (packet: IConnackPacket) => void
375382
export type OnDisconnectCallback = (packet: IDisconnectPacket) => void
@@ -1300,20 +1307,20 @@ export default class MqttClient extends TypedEventEmitter<MqttClientEventCallbac
13001307
public unsubscribe(topic: string | string[]): MqttClient
13011308
public unsubscribe(
13021309
topic: string | string[],
1303-
opts?: IClientSubscribeOptions,
1310+
opts?: IClientUnsubscribeProperties,
13041311
): MqttClient
13051312
public unsubscribe(
13061313
topic: string | string[],
13071314
callback?: PacketCallback,
13081315
): MqttClient
13091316
public unsubscribe(
13101317
topic: string | string[],
1311-
opts?: IClientSubscribeOptions,
1318+
opts?: IClientUnsubscribeProperties,
13121319
callback?: PacketCallback,
13131320
): MqttClient
13141321
public unsubscribe(
13151322
topic: string | string[],
1316-
opts?: IClientSubscribeOptions | PacketCallback,
1323+
opts?: IClientUnsubscribeProperties | PacketCallback,
13171324
callback?: PacketCallback,
13181325
): MqttClient {
13191326
if (typeof topic === 'string') {
@@ -1395,11 +1402,11 @@ export default class MqttClient extends TypedEventEmitter<MqttClientEventCallbac
13951402
): Promise<Packet | undefined>
13961403
public unsubscribeAsync(
13971404
topic: string | string[],
1398-
opts?: IClientSubscribeOptions,
1405+
opts?: IClientUnsubscribeProperties,
13991406
): Promise<Packet | undefined>
14001407
public unsubscribeAsync(
14011408
topic: string | string[],
1402-
opts?: IClientSubscribeOptions,
1409+
opts?: IClientUnsubscribeProperties,
14031410
): Promise<Packet | undefined> {
14041411
return new Promise((resolve, reject) => {
14051412
this.unsubscribe(topic, opts, (err, packet) => {

0 commit comments

Comments
 (0)