Home > @imqueue/core > RedisQueue > destroy

RedisQueue.destroy() method

Gracefully destroys this queue handle. Does not remove queue data from redis unless clearData is explicitly set to true, so that destroying one handle (e.g., on scale-down) never wipes messages still pending for other producers/consumers.

Signature:

destroy(clearData?: boolean): Promise<void>;

Parameters

Parameter

Type

Description

clearData

boolean

(Optional) when true, also clears queue data

Returns:

Promise<void>

{Promise}