Interface: SubscriberObject<T>

Type parameters

Name	Type
T	unknown

Hierarchy

• SubscriberMetadata

• MessageHandler<T>

• FlexibleObject

  ↳ SubscriberObject

Properties

description

• Optional description: string

Inherited from

SubscriberMetadata.description

Defined in

src/subscriber/subscriberV2.ts:110

---

options

• Optional options: SubscriberOptions

Inherited from

SubscriberMetadata.options

Defined in

src/subscriber/subscriberV2.ts:111

---

subscriptionName

• subscriptionName: string

Inherited from

SubscriberMetadata.subscriptionName

Defined in

src/subscriber/subscriberV2.ts:109

---

topicName

• topicName: string

Inherited from

SubscriberMetadata.topicName

Defined in

src/subscriber/subscriberV2.ts:108

Methods

handleError

▸ Optional handleError(error): void

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

Parameters

Name	Type
error	Error

Returns

void

Inherited from

MessageHandler.handleError

Defined in

src/subscriber/subscriberV2.ts:128

---

handleMessage

▸ handleMessage(message): void

will run every time a message is received

Parameters

Name	Type
message	Message<T>

Returns

void

Inherited from

MessageHandler.handleMessage

Defined in

src/subscriber/subscriberV2.ts:118

---

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:123