Skip to main content
Version: v2

Interface: SubscriberObject<T>

Type parameters#

NameType
Tunknown

Hierarchy#

  • Omit<SubscriberMetadata, "options">

  • MessageHandler<T>

  • FlexibleObject

    ↳ SubscriberObject

Properties#

description#

• Optional description: string

Inherited from#

Omit.description

Defined in#

src/subscriber/subscriberV2.ts:113


options#

• Optional options: SubscriberOptions

Defined in#

src/subscriber/subscriberV2.ts:142


subscriptionName#

• subscriptionName: string

Inherited from#

Omit.subscriptionName

Defined in#

src/subscriber/subscriberV2.ts:111


topicName#

• topicName: string

Inherited from#

Omit.topicName

Defined in#

src/subscriber/subscriberV2.ts:110

Methods#

handleError#

â–¸ Optional handleError(error): void

If passed, it would serve as the error handler method for internal google pubsub errors

Parameters#

NameType
errorError

Returns#

void

Inherited from#

MessageHandler.handleError

Defined in#

src/subscriber/subscriberV2.ts:130


handleMessage#

â–¸ handleMessage(message): void

will run every time a message is received

Parameters#

NameType
messageMessage<T>

Returns#

void

Inherited from#

MessageHandler.handleMessage

Defined in#

src/subscriber/subscriberV2.ts:120


init#

â–¸ Optional init(): void

will run before the message handler is attached to the subscription

Returns#

void

Inherited from#

MessageHandler.init

Defined in#

src/subscriber/subscriberV2.ts:125