Class: Topic<P>

Type parameters

Name	Type
P	extends PayloadPayload

Constructors

constructor

• new Topic<P>()

Type parameters

Name	Type
P	extends PayloadPayload

Defined in

src/topic/index.ts:59

Properties

options

• options: TopicOptions

Defined in

src/topic/index.ts:42

---

project

▪ Static Optional project: GooglePubSubProject

Defined in

src/topic/index.ts:40

---

topicName

▪ Static Readonly topicName: string

Defined in

src/topic/index.ts:39

Methods

publish

▸ publish(message, options?): Promise<string>

Parameters

Name	Type
message	PayloadInput<P>
options?	TopicPublishOptions

Returns

Promise<string>

Defined in

src/topic/index.ts:85

---

validateMessage

▸ validateMessage(message): void

This is run before publishing any messages, it is a no-op by default. Can overwrite to perform checks against payload before publishing

Parameters

Name	Type	Description
message	PayloadInput<P>	Message to be published

Returns

void

Defined in

src/topic/index.ts:81

---

validateTopic

▸ Static validateTopic(name): void

This is run once when Topic is init to verify topic name

Parameters

Name	Type	Description
name	string	topicName

Returns

void

Defined in

src/topic/index.ts:70