Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/x/mqttbreadcrumb arrow Clientbreadcrumb arrow Client.unsubscribeAsync( topics, [options] )
Open source

Client.unsubscribeAsync()

Unsubscribe from topics asynchronously.

Signature

JavaScript
await client.unsubscribeAsync(topics, options)

Parameters

ParameterTypeDescription
topicsstring | string[]Topic or array of topics to unsubscribe from
optionsobjectOptional unsubscribe configuration
options.tagsobjectCustom tags for metrics (key-value pairs)

Returns

A promise that resolves when the unsubscription is complete.