Skip to content

Latest commit

 

History

History
458 lines (259 loc) · 7.95 KB

ProducibleMessage.md

File metadata and controls

458 lines (259 loc) · 7.95 KB

RedisSMQ / Docs / API Reference / ProducibleMessage

Class: ProducibleMessage

Table of contents

Constructors

Methods

Constructors

constructor

new ProducibleMessage(): ProducibleMessage

Returns

ProducibleMessage

Methods

disablePriority

disablePriority(): ProducibleMessage

Returns

ProducibleMessage


getBody

getBody(): unknown

Returns

unknown


getConsumeTimeout

getConsumeTimeout(): number

Returns

number


getCreatedAt

getCreatedAt(): number

Returns

number


getExchange

getExchange(): null | TExchangeTransferable

Returns

null | TExchangeTransferable


getFanOut

getFanOut(): null | string

Returns

null | string


getPriority

getPriority(): null | EMessagePriority

Returns

null | EMessagePriority


getQueue

getQueue(): null | IQueueParams

Returns

null | IQueueParams


getRetryDelay

getRetryDelay(): number

Returns

number


getRetryThreshold

getRetryThreshold(): number

Returns

number


getScheduledCRON

getScheduledCRON(): null | string

Returns

null | string


getScheduledDelay

getScheduledDelay(): null | number

Returns

null | number


getScheduledRepeat

getScheduledRepeat(): number

Returns

number


getScheduledRepeatPeriod

getScheduledRepeatPeriod(): null | number

Returns

null | number


getTTL

getTTL(): number

Returns

number


getTopic

getTopic(): null | ITopicParams

Returns

null | ITopicParams


hasPriority

hasPriority(): boolean

Returns

boolean


resetScheduledParams

resetScheduledParams(): ProducibleMessage

Returns

ProducibleMessage


setBody

setBody(body): ProducibleMessage

Parameters

Name Type
body unknown

Returns

ProducibleMessage


setConsumeTimeout

setConsumeTimeout(timeout): ProducibleMessage

Parameters

Name Type Description
timeout number In milliseconds

Returns

ProducibleMessage


setFanOut

setFanOut(fanOutName): ProducibleMessage

Parameters

Name Type
fanOutName string

Returns

ProducibleMessage


setPriority

setPriority(priority): ProducibleMessage

Parameters

Name Type
priority EMessagePriority

Returns

ProducibleMessage


setQueue

setQueue(queueParams): ProducibleMessage

Parameters

Name Type
queueParams string | IQueueParams

Returns

ProducibleMessage


setRetryDelay

setRetryDelay(delay): ProducibleMessage

Parameters

Name Type Description
delay number In millis

Returns

ProducibleMessage


setRetryThreshold

setRetryThreshold(threshold): ProducibleMessage

Parameters

Name Type
threshold number

Returns

ProducibleMessage


setScheduledCRON

setScheduledCRON(cron): ProducibleMessage

Parameters

Name Type
cron string

Returns

ProducibleMessage


setScheduledDelay

setScheduledDelay(delay): ProducibleMessage

Parameters

Name Type Description
delay number In millis

Returns

ProducibleMessage


setScheduledRepeat

setScheduledRepeat(repeat): ProducibleMessage

Parameters

Name Type
repeat number

Returns

ProducibleMessage


setScheduledRepeatPeriod

setScheduledRepeatPeriod(period): ProducibleMessage

Parameters

Name Type Description
period number In millis

Returns

ProducibleMessage


setTTL

setTTL(ttl): ProducibleMessage

Parameters

Name Type Description
ttl number In milliseconds

Returns

ProducibleMessage


setTopic

setTopic(topicParams): ProducibleMessage

Parameters

Name Type
topicParams string | ITopicParams

Returns

ProducibleMessage


setDefaultConsumeOptions

setDefaultConsumeOptions(consumeOptions): void

Parameters

Name Type
consumeOptions Partial<TMessageConsumeOptions>

Returns

void