From 109f9e2d08881a3eccae15d12f92b038a0799600 Mon Sep 17 00:00:00 2001 From: rohit-gohri Date: Fri, 13 Sep 2024 09:10:22 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20delivery?= =?UTF-8?q?hero/hfc-pubsub@5acfee612e47c088757bf227d1712b0f4fb9efe3=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 8 ++++---- __docusaurus/debug/config/index.html | 8 ++++---- __docusaurus/debug/content/index.html | 8 ++++---- __docusaurus/debug/globalData/index.html | 8 ++++---- __docusaurus/debug/index.html | 8 ++++---- __docusaurus/debug/metadata/index.html | 10 +++++----- __docusaurus/debug/registry/index.html | 8 ++++---- __docusaurus/debug/routes/index.html | 8 ++++---- api/classes/Message/index.html | 12 ++++++------ api/classes/PubSubService/index.html | 10 +++++----- api/classes/SubscriptionService/index.html | 14 +++++++------- api/classes/Topic/index.html | 12 ++++++------ api/index.html | 10 +++++----- api/interfaces/Payload/index.html | 10 +++++----- api/interfaces/SubscriberMetadata/index.html | 10 +++++----- api/interfaces/SubscriberObject/index.html | 10 +++++----- api/interfaces/SubscriberOptions/index.html | 14 +++++++------- api/interfaces/TopicOptions/index.html | 10 +++++----- .../{13caf63c.6a54c260.js => 13caf63c.071d2e89.js} | 2 +- .../{157e1c0d.df0a2536.js => 157e1c0d.6ffacc77.js} | 2 +- .../{1c01e663.02b0d49e.js => 1c01e663.5b036185.js} | 2 +- .../{246f2c6f.d65c1318.js => 246f2c6f.9af9f1c9.js} | 2 +- assets/js/24bb654f.62c4ba33.js | 1 + assets/js/24bb654f.e76d3000.js | 1 - .../{5e8c322a.39808287.js => 5e8c322a.78ddeec3.js} | 2 +- .../{5f9e1e26.39d5b5a3.js => 5f9e1e26.c258bbb4.js} | 2 +- .../{6401c6ac.bf35ce5c.js => 6401c6ac.5f9a14b5.js} | 2 +- assets/js/9beb87c2.2570cf3d.js | 1 - assets/js/9beb87c2.fc40b1f0.js | 1 + .../{a8bbf00a.330c4b11.js => a8bbf00a.6967af67.js} | 2 +- assets/js/bf56a78d.04f6a55e.js | 1 - assets/js/bf56a78d.d028db7d.js | 1 + .../{f0debbde.5593c65f.js => f0debbde.27c2f0a0.js} | 2 +- assets/js/{main.ce3a225b.js => main.588d23b9.js} | 4 ++-- ...js.LICENSE.txt => main.588d23b9.js.LICENSE.txt} | 0 ...e~main.cd29fe83.js => runtime~main.d6c3a98e.js} | 2 +- changelog/index.html | 12 ++++++------ getting-started/installation/index.html | 8 ++++---- guides/cli/index.html | 8 ++++---- guides/drivers/index.html | 8 ++++---- guides/migrating-to-v2/index.html | 8 ++++---- guides/testing/index.html | 8 ++++---- index.html | 8 ++++---- options/index.html | 8 ++++---- publishing/attributes/index.html | 8 ++++---- publishing/publish-diff-project/index.html | 8 ++++---- publishing/retry-settings/index.html | 8 ++++---- publishing/topics/index.html | 8 ++++---- server/connect-database/index.html | 8 ++++---- server/custom-logger/index.html | 8 ++++---- server/graceful-shutdown/index.html | 8 ++++---- server/health-check/index.html | 8 ++++---- server/service/index.html | 8 ++++---- subscribing/Messages_compression/index.html | 8 ++++---- subscribing/dead-letter-policy/index.html | 8 ++++---- subscribing/error-handling/index.html | 8 ++++---- subscribing/labels/index.html | 8 ++++---- subscribing/message-ordering/index.html | 8 ++++---- subscribing/retry-policy/index.html | 8 ++++---- subscribing/subscriptions/index.html | 8 ++++---- v1/api/classes/Message/index.html | 8 ++++---- v1/api/classes/PubSubService/index.html | 8 ++++---- v1/api/classes/Subscriber/index.html | 8 ++++---- v1/api/classes/SubscriptionService/index.html | 8 ++++---- v1/api/classes/Topic/index.html | 8 ++++---- v1/api/index.html | 8 ++++---- .../Interfaces.BackoffSettings/index.html | 8 ++++---- .../Interfaces.GooglePubSubProject/index.html | 8 ++++---- .../Interfaces.PublishOptions/index.html | 8 ++++---- .../interfaces/Interfaces.RetryConfig/index.html | 8 ++++---- .../Interfaces.TopicPublishOptions/index.html | 8 ++++---- .../interfaces/Interfaces.pubSubClient/index.html | 8 ++++---- v1/api/interfaces/Payload/index.html | 8 ++++---- v1/api/interfaces/SubscriberOptions/index.html | 8 ++++---- v1/api/namespaces/Interfaces/index.html | 8 ++++---- v1/cli/index.html | 8 ++++---- v1/drivers/index.html | 8 ++++---- v1/getting-started/installation/index.html | 8 ++++---- v1/guides/testing/index.html | 8 ++++---- v1/index.html | 8 ++++---- v1/options/index.html | 8 ++++---- v1/publishing/attributes/index.html | 8 ++++---- v1/publishing/publish-diff-project/index.html | 8 ++++---- v1/publishing/retry-settings/index.html | 8 ++++---- v1/publishing/topics/index.html | 8 ++++---- v1/server/connect-database/index.html | 8 ++++---- v1/server/custom-logger/index.html | 8 ++++---- v1/server/graceful-shutdown/index.html | 8 ++++---- v1/server/health-check/index.html | 8 ++++---- v1/server/service/index.html | 8 ++++---- v1/subscribing/dead-letter-policy/index.html | 8 ++++---- v1/subscribing/error-handling/index.html | 8 ++++---- v1/subscribing/message-ordering/index.html | 8 ++++---- v1/subscribing/retry-policy/index.html | 8 ++++---- v1/subscribing/subscriptions/index.html | 8 ++++---- 95 files changed, 342 insertions(+), 342 deletions(-) rename assets/js/{13caf63c.6a54c260.js => 13caf63c.071d2e89.js} (93%) rename assets/js/{157e1c0d.df0a2536.js => 157e1c0d.6ffacc77.js} (94%) rename assets/js/{1c01e663.02b0d49e.js => 1c01e663.5b036185.js} (96%) rename assets/js/{246f2c6f.d65c1318.js => 246f2c6f.9af9f1c9.js} (99%) create mode 100644 assets/js/24bb654f.62c4ba33.js delete mode 100644 assets/js/24bb654f.e76d3000.js rename assets/js/{5e8c322a.39808287.js => 5e8c322a.78ddeec3.js} (77%) rename assets/js/{5f9e1e26.39d5b5a3.js => 5f9e1e26.c258bbb4.js} (88%) rename assets/js/{6401c6ac.bf35ce5c.js => 6401c6ac.5f9a14b5.js} (96%) delete mode 100644 assets/js/9beb87c2.2570cf3d.js create mode 100644 assets/js/9beb87c2.fc40b1f0.js rename assets/js/{a8bbf00a.330c4b11.js => a8bbf00a.6967af67.js} (94%) delete mode 100644 assets/js/bf56a78d.04f6a55e.js create mode 100644 assets/js/bf56a78d.d028db7d.js rename assets/js/{f0debbde.5593c65f.js => f0debbde.27c2f0a0.js} (95%) rename assets/js/{main.ce3a225b.js => main.588d23b9.js} (99%) rename assets/js/{main.ce3a225b.js.LICENSE.txt => main.588d23b9.js.LICENSE.txt} (100%) rename assets/js/{runtime~main.cd29fe83.js => runtime~main.d6c3a98e.js} (91%) diff --git a/404.html b/404.html index 8d57a817..857f85dc 100644 --- a/404.html +++ b/404.html @@ -6,13 +6,13 @@ Page Not Found | Pub/Sub Node.js Framework - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- - + + \ No newline at end of file diff --git a/__docusaurus/debug/config/index.html b/__docusaurus/debug/config/index.html index 67ac19ec..4f5d5899 100644 --- a/__docusaurus/debug/config/index.html +++ b/__docusaurus/debug/config/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Site config

- - + + \ No newline at end of file diff --git a/__docusaurus/debug/content/index.html b/__docusaurus/debug/content/index.html index 2d7c9af4..977c6661 100644 --- a/__docusaurus/debug/content/index.html +++ b/__docusaurus/debug/content/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Plugin content

docusaurus-plugin-content-docs

default
- - + + \ No newline at end of file diff --git a/__docusaurus/debug/globalData/index.html b/__docusaurus/debug/globalData/index.html index 5d74c872..3073fb28 100644 --- a/__docusaurus/debug/globalData/index.html +++ b/__docusaurus/debug/globalData/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Global data

- - + + \ No newline at end of file diff --git a/__docusaurus/debug/index.html b/__docusaurus/debug/index.html index c8d24b7b..05243c0b 100644 --- a/__docusaurus/debug/index.html +++ b/__docusaurus/debug/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Site config

- - + + \ No newline at end of file diff --git a/__docusaurus/debug/metadata/index.html b/__docusaurus/debug/metadata/index.html index 9e6aebc1..67d4b0cb 100644 --- a/__docusaurus/debug/metadata/index.html +++ b/__docusaurus/debug/metadata/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +
-

Site Metadata

Docusaurus Version: 2.0.0-beta.ff31de0ff
Site Version: 2.2.2

Plugins and themes

  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-docs
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-blog
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-pages
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-debug
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-sitemap
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-theme-classic
    Type: package
  • 0.16.3
    undefined
    Type: package
- - +

Site Metadata

Docusaurus Version: 2.0.0-beta.ff31de0ff
Site Version: 2.3.0

Plugins and themes

  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-docs
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-blog
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-content-pages
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-debug
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-plugin-sitemap
    Type: package
  • 2.0.0-beta.ff31de0ff
    docusaurus-theme-classic
    Type: package
  • 0.16.3
    undefined
    Type: package
+ + \ No newline at end of file diff --git a/__docusaurus/debug/registry/index.html b/__docusaurus/debug/registry/index.html index 911c3c01..0f5140b6 100644 --- a/__docusaurus/debug/registry/index.html +++ b/__docusaurus/debug/registry/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Registry

  • Aliased Path: @theme/DocItem
    Resolved Path: 4651
  • Aliased Path: @site/versioned_docs/version-v1/Drivers.md
    Resolved Path: 6804
  • Aliased Path: @site/versioned_docs/version-v1/api/classes/Topic.md
    Resolved Path: 1250
  • Aliased Path: @site/docs/publishing/Topics.md
    Resolved Path: 1773
  • Aliased Path: @site/docs/subscribing/Retry Policy.md
    Resolved Path: 3937
  • Aliased Path: @site/versioned_docs/version-v1/api/classes/Subscriber.md
    Resolved Path: 9804
  • Aliased Path: @site/docs/subscribing/Message Ordering.md
    Resolved Path: 3195
  • Aliased Path: @site/docs/api/interfaces/SubscriberOptions.md
    Resolved Path: 8582
  • Aliased Path: @site/versioned_docs/version-v1/publishing/Retry Settings.md
    Resolved Path: 7979
  • Aliased Path: @site/docs/api/interfaces/TopicOptions.md
    Resolved Path: 7588
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.BackoffSettings.md
    Resolved Path: 1449
  • Aliased Path: @site/versioned_docs/version-v1/publishing/Publish Diff Project.md
    Resolved Path: 8262
  • Aliased Path: @theme/DocPage
    Resolved Path: 4661
  • Aliased Path: @site/docs/api/interfaces/Payload.md
    Resolved Path: 9098
  • Aliased Path: @site/docs/server/Custom Logger.md
    Resolved Path: 5884
  • Aliased Path: @theme/DebugConfig
    Resolved Path: 1718
  • Aliased Path: ~debug/default/docusaurus-debug-all-content-673.json
    Resolved Path: 6267
  • Aliased Path: @site/docs/api/classes/SubscriptionService.md
    Resolved Path: 4033
  • Aliased Path: @site/versioned_docs/version-v1/server/Custom Logger.md
    Resolved Path: 292
  • Aliased Path: @site/docs/publishing/Retry Settings.md
    Resolved Path: 5254
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.GooglePubSubProject.md
    Resolved Path: 5730
  • Aliased Path: @site/docs/guides/Drivers.md
    Resolved Path: 9790
  • Aliased Path: @site/versioned_docs/version-v1/server/Connect Database.md
    Resolved Path: 9292
  • Aliased Path: @site/versioned_docs/version-v1/subscribing/Dead Letter Policy.md
    Resolved Path: 6732
  • Aliased Path: @site/docs/subscribing/Internal Error Handling.md
    Resolved Path: 3801
  • Aliased Path: @site/versioned_docs/version-v1/guides/Testing.md
    Resolved Path: 5184
  • Aliased Path: @site/docs/api/index.md
    Resolved Path: 3372
  • Aliased Path: @site/docs/api/classes/PubSubService.md
    Resolved Path: 8382
  • Aliased Path: @site/versioned_docs/version-v1/server/Health Check.md
    Resolved Path: 3002
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/SubscriberOptions.md
    Resolved Path: 5209
  • Aliased Path: @site/docs/api/classes/Topic.md
    Resolved Path: 6586
  • Aliased Path: @theme/DebugRegistry
    Resolved Path: 4430
  • Aliased Path: @site/docs/publishing/Attributes.md
    Resolved Path: 6837
  • Aliased Path: @theme/DebugSiteMetadata
    Resolved Path: 9424
  • Aliased Path: @site/docs/subscribing/Dead Letter Policy.md
    Resolved Path: 9489
  • Aliased Path: @site/versioned_docs/version-v1/api/namespaces/Interfaces.md
    Resolved Path: 5066
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.pubSubClient.md
    Resolved Path: 9304
  • Aliased Path: @site/versioned_docs/version-v1/api/index.md
    Resolved Path: 6818
  • Aliased Path: @site/docs/Options.md
    Resolved Path: 5902
  • Aliased Path: @site/versioned_docs/version-v1/api/classes/Message.md
    Resolved Path: 3500
  • Aliased Path: @site/versioned_docs/version-v1/server/Graceful Shutdown.md
    Resolved Path: 2601
  • Aliased Path: @site/versioned_docs/version-v1/subscribing/Message Ordering.md
    Resolved Path: 2393
  • Aliased Path: @site/docs/subscribing/Messages Compression.md
    Resolved Path: 7544
  • Aliased Path: @site/docs/subscribing/Labels.md
    Resolved Path: 2537
  • Aliased Path: @site/versioned_docs/version-v1/CLI.md
    Resolved Path: 5386
  • Aliased Path: @site/versioned_docs/version-v1/api/classes/SubscriptionService.md
    Resolved Path: 3939
  • Aliased Path: ~docs/default/version-current-metadata-prop-751.json
    Resolved Path: 1109
  • Aliased Path: @theme/DebugRoutes
    Resolved Path: 2383
  • Aliased Path: @site/docs/publishing/Publish Diff Project.md
    Resolved Path: 7571
  • Aliased Path: @site/versioned_docs/version-v1/subscribing/Subscriptions.md
    Resolved Path: 2884
  • Aliased Path: @site/docs/changelog.md
    Resolved Path: 7156
  • Aliased Path: @site/versioned_docs/version-v1/publishing/Attributes.md
    Resolved Path: 6792
  • Aliased Path: @site/docs/api/classes/Message.md
    Resolved Path: 9280
  • Aliased Path: @site/versioned_docs/version-v1/subscribing/Retry Policy.md
    Resolved Path: 747
  • Aliased Path: @site/docs/guides/Migrating to v2.mdx
    Resolved Path: 755
  • Aliased Path: @theme/DebugContent
    Resolved Path: 4709
  • Aliased Path: @site/docs/guides/CLI.md
    Resolved Path: 7194
  • Aliased Path: @site/docs/api/interfaces/SubscriberObject.md
    Resolved Path: 3478
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.PublishOptions.md
    Resolved Path: 2155
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Payload.md
    Resolved Path: 2303
  • Aliased Path: @site/versioned_docs/version-v1/Options.md
    Resolved Path: 2888
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.RetryConfig.md
    Resolved Path: 9159
  • Aliased Path: @site/versioned_docs/version-v1/api/classes/PubSubService.md
    Resolved Path: 4130
  • Aliased Path: @site/versioned_docs/version-v1/getting-started/Installation.md
    Resolved Path: 3398
  • Aliased Path: @site/docs/server/Health Check.md
    Resolved Path: 4980
  • Aliased Path: @site/versioned_docs/version-v1/subscribing/Internal Error Handling.md
    Resolved Path: 3124
  • Aliased Path: @site/versioned_docs/version-v1/Introduction.md
    Resolved Path: 5652
  • Aliased Path: @site/docs/server/Graceful Shutdown.md
    Resolved Path: 224
  • Aliased Path: @site/versioned_docs/version-v1/publishing/Topics.md
    Resolved Path: 1791
  • Aliased Path: @site/versioned_docs/version-v1/server/Service.md
    Resolved Path: 8028
  • Aliased Path: @site/docs/Introduction.md
    Resolved Path: 938
  • Aliased Path: ~docs/default/version-v-1-metadata-prop-085.json
    Resolved Path: 319
  • Aliased Path: @site/docs/server/Connect Database.md
    Resolved Path: 2407
  • Aliased Path: @site/docs/subscribing/Subscriptions.md
    Resolved Path: 5885
  • Aliased Path: @site/docs/getting-started/Installation.md
    Resolved Path: 1731
  • Aliased Path: @site/docs/server/Service.md
    Resolved Path: 754
  • Aliased Path: @theme/DebugGlobalData
    Resolved Path: 9205
  • Aliased Path: @site/docs/api/interfaces/SubscriberMetadata.md
    Resolved Path: 9227
  • Aliased Path: @site/docs/guides/Testing.md
    Resolved Path: 7201
  • Aliased Path: @site/versioned_docs/version-v1/api/interfaces/Interfaces.TopicPublishOptions.md
    Resolved Path: 966
- - + + \ No newline at end of file diff --git a/__docusaurus/debug/routes/index.html b/__docusaurus/debug/routes/index.html index ecd0a589..3d3f760a 100644 --- a/__docusaurus/debug/routes/index.html +++ b/__docusaurus/debug/routes/index.html @@ -6,13 +6,13 @@ Docusaurus debug panel - - + +

Routes

  • /hfc-pubsub/__docusaurus/debug
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/config
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/content
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/globalData
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/metadata
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/registry
    Is exact: true
  • /hfc-pubsub/__docusaurus/debug/routes
    Is exact: true
  • /hfc-pubsub/v1
    Is exact: false
    Child Routes:
  • /hfc-pubsub/
    Is exact: false
    Child Routes:
  • *
    Is exact: false
- - + + \ No newline at end of file diff --git a/api/classes/Message/index.html b/api/classes/Message/index.html index 2d864aaa..e026dbb9 100644 --- a/api/classes/Message/index.html +++ b/api/classes/Message/index.html @@ -6,14 +6,14 @@ Class: Message<T> | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Class: Message<T>

Type parameters#

NameType
Tunknown

Constructors#

constructor#

• new Message<T>()

Type parameters#

NameType
Tunknown

Properties#

data#

• data: Buffer

Defined in#

src/message/index.ts:6

gCloudMessage#

• Optional gCloudMessage: Message

Defined in#

src/message/index.ts:7

Methods#

ack#

▸ ack(): void

Returns#

void

Defined in#

src/message/index.ts:39

decompress#

▸ decompress(): Buffer

Returns#

Buffer

Defined in#

src/message/index.ts:57

modAck#

▸ modAck(deadline): void

Parameters#

NameType
deadlinenumber

Returns#

void

Defined in#

src/message/index.ts:45

nack#

▸ nack(): void

Returns#

void

Defined in#

src/message/index.ts:51

toJSON#

▸ toJSON(): T

Returns#

T

Defined in#

src/message/index.ts:31

from#

▸ Static from<M>(message): Message<M>

Builds a new message object in the synchronous driver. -Used by the eventBus.

Type parameters#

Name
M

Parameters#

NameTypeDescription
messageMany message that can be buffered

Returns#

Message<M>

Defined in#

src/message/index.ts:14

fromGCloud#

▸ Static fromGCloud(message): Message<unknown>

Builds a message for Google Cloud Driver

Parameters#

NameTypeDescription
messageMessageA valid Google Cloud message

Returns#

Message<unknown>

Defined in#

src/message/index.ts:24

- - +
Skip to main content
Version: v2

Class: Message<T>

Type parameters#

NameType
Tunknown

Constructors#

constructor#

• new Message<T>()

Type parameters#

NameType
Tunknown

Properties#

data#

• data: Buffer

Defined in#

src/message/index.ts:6

gCloudMessage#

• Optional gCloudMessage: Message

Defined in#

src/message/index.ts:7

Methods#

ack#

▸ ack(): void

Returns#

void

Defined in#

src/message/index.ts:39

decompress#

▸ decompress(): Buffer

Returns#

Buffer

Defined in#

src/message/index.ts:57

modAck#

▸ modAck(deadline): void

Parameters#

NameType
deadlinenumber

Returns#

void

Defined in#

src/message/index.ts:45

nack#

▸ nack(): void

Returns#

void

Defined in#

src/message/index.ts:51

toJSON#

▸ toJSON(): T

Returns#

T

Defined in#

src/message/index.ts:31

from#

▸ Static from<M>(message): Message<M>

Builds a new message object in the synchronous driver. +Used by the eventBus.

Type parameters#

Name
M

Parameters#

NameTypeDescription
messageMany message that can be buffered

Returns#

Message<M>

Defined in#

src/message/index.ts:14

fromGCloud#

▸ Static fromGCloud(message): Message<unknown>

Builds a message for Google Cloud Driver

Parameters#

NameTypeDescription
messageMessageA valid Google Cloud message

Returns#

Message<unknown>

Defined in#

src/message/index.ts:24

+ + \ No newline at end of file diff --git a/api/classes/PubSubService/index.html b/api/classes/PubSubService/index.html index f182f16c..1ea0baf3 100644 --- a/api/classes/PubSubService/index.html +++ b/api/classes/PubSubService/index.html @@ -6,13 +6,13 @@ Class: PubSubService | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Class: PubSubService

Properties#

client#

▪ Static Protected client: PubSubClientV2

Defined in#

src/service/pubsub.ts:13

driver#

▪ Static Protected driver: "synchronous" | "google"

Defined in#

src/service/pubsub.ts:15

instance#

▪ Static Protected instance: PubSubService

Defined in#

src/service/pubsub.ts:14

Methods#

closeAll#

▸ closeAll(): Promise<void>

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:123

getAllSubscriptions#

▸ getAllSubscriptions(): Promise<AllSubscriptions[]>

Retrieves a list of subscribers

Returns#

Promise<AllSubscriptions[]>

Defined in#

src/service/pubsub.ts:213

getSubscribers#

▸ getSubscribers(): Subscribers

Returns#

Subscribers

Defined in#

src/service/pubsub.ts:119

initClient#

▸ initClient(): void

Returns#

void

Defined in#

src/service/pubsub.ts:84

publish#

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

Publishes new orders to PubSub.

Type parameters#

NameType
Textends TopicProperties

Parameters#

NameType
topicT
messageRecord<string, unknown>
options?PublishOptions

Returns#

Promise<string>

Defined in#

src/service/pubsub.ts:102

startSubscriptions#

▸ startSubscriptions(): Promise<void>

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:144

subscribe#

▸ subscribe(subscription): Promise<void>

Subscribes to any given topic

Parameters#

NameType
subscriptionSubscriberTuple

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:206

getInstance#

▸ Static getInstance(): PubSubService

Returns#

PubSubService

Defined in#

src/service/pubsub.ts:92

isHealthy#

▸ Static isHealthy(): boolean

Returns#

boolean

Defined in#

src/service/pubsub.ts:48

- - +
Skip to main content
Version: v2

Class: PubSubService

Properties#

client#

▪ Static Protected client: PubSubClientV2

Defined in#

src/service/pubsub.ts:13

driver#

▪ Static Protected driver: "synchronous" | "google"

Defined in#

src/service/pubsub.ts:15

instance#

▪ Static Protected instance: PubSubService

Defined in#

src/service/pubsub.ts:14

Methods#

closeAll#

▸ closeAll(): Promise<void>

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:123

getAllSubscriptions#

▸ getAllSubscriptions(): Promise<AllSubscriptions[]>

Retrieves a list of subscribers

Returns#

Promise<AllSubscriptions[]>

Defined in#

src/service/pubsub.ts:213

getSubscribers#

▸ getSubscribers(): Subscribers

Returns#

Subscribers

Defined in#

src/service/pubsub.ts:119

initClient#

▸ initClient(): void

Returns#

void

Defined in#

src/service/pubsub.ts:84

publish#

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

Publishes new orders to PubSub.

Type parameters#

NameType
Textends TopicProperties

Parameters#

NameType
topicT
messageRecord<string, unknown>
options?PublishOptions

Returns#

Promise<string>

Defined in#

src/service/pubsub.ts:102

startSubscriptions#

▸ startSubscriptions(): Promise<void>

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:144

subscribe#

▸ subscribe(subscription): Promise<void>

Subscribes to any given topic

Parameters#

NameType
subscriptionSubscriberTuple

Returns#

Promise<void>

Defined in#

src/service/pubsub.ts:206

getInstance#

▸ Static getInstance(): PubSubService

Returns#

PubSubService

Defined in#

src/service/pubsub.ts:92

isHealthy#

▸ Static isHealthy(): boolean

Returns#

boolean

Defined in#

src/service/pubsub.ts:48

+ + \ No newline at end of file diff --git a/api/classes/SubscriptionService/index.html b/api/classes/SubscriptionService/index.html index e3b5b5f0..82808820 100644 --- a/api/classes/SubscriptionService/index.html +++ b/api/classes/SubscriptionService/index.html @@ -6,16 +6,16 @@ Class: SubscriptionService | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Class: SubscriptionService

Constructors#

constructor#

• new SubscriptionService()

Defined in#

src/service/subscription.ts:23

Properties#

defaultSubscriberOptions#

▪ Static defaultSubscriberOptions: SubscriberOptions

All subscriptions will inherit from this default options object

Defined in#

src/service/subscription.ts:21

subscribers#

▪ Static subscribers: SubscriberObject<any>[] = []

Defined in#

src/service/subscription.ts:14

Methods#

closeAll#

▸ Static closeAll(): Promise<void>

Call this function from a process exit handler to close all current subscriptions

Returns#

Promise<void>

Defined in#

src/service/subscription.ts:64

getSubscribers#

▸ Static getSubscribers(): Subscribers

Returns#

Subscribers

Defined in#

src/service/subscription.ts:68

handleError#

▸ Static handleError(err, metadata): void

If passed, it would serve as the default error handler for all subscriptions. +

Version: v2

Class: SubscriptionService

Constructors#

constructor#

• new SubscriptionService()

Defined in#

src/service/subscription.ts:23

Properties#

defaultSubscriberOptions#

▪ Static defaultSubscriberOptions: SubscriberOptions

All subscriptions will inherit from this default options object

Defined in#

src/service/subscription.ts:21

subscribers#

▪ Static subscribers: SubscriberObject<any>[] = []

Defined in#

src/service/subscription.ts:14

Methods#

closeAll#

▸ Static closeAll(): Promise<void>

Call this function from a process exit handler to close all current subscriptions

Returns#

Promise<void>

Defined in#

src/service/subscription.ts:64

getSubscribers#

▸ Static getSubscribers(): Subscribers

Returns#

Subscribers

Defined in#

src/service/subscription.ts:68

handleError#

▸ Static handleError(err, metadata): void

If passed, it would serve as the default error handler for all subscriptions. Applications should override this with custom error handling: log error, cleanup resources and exit the process. -Default logs the error and rethrows

Parameters#

NameType
errError
metadataSubscriberMetadata

Returns#

void

Defined in#

src/service/subscription.ts:51

init#

▸ Static init(): Promise<void>

Can be used to initialize process level globals (like DB Connections). -Default is a no-op

Returns#

Promise<void>

Defined in#

src/service/subscription.ts:42

loadSubscriptionService#

▸ Static loadSubscriptionService(): typeof SubscriptionService

Returns#

typeof SubscriptionService

Defined in#

src/service/subscription.ts:112

- - +Default logs the error and rethrows

Parameters#

NameType
errError
metadataSubscriberMetadata

Returns#

void

Defined in#

src/service/subscription.ts:51

init#

▸ Static init(): Promise<void>

Can be used to initialize process level globals (like DB Connections). +Default is a no-op

Returns#

Promise<void>

Defined in#

src/service/subscription.ts:42

loadSubscriptionService#

▸ Static loadSubscriptionService(): typeof SubscriptionService

Returns#

typeof SubscriptionService

Defined in#

src/service/subscription.ts:112

+ + \ No newline at end of file diff --git a/api/classes/Topic/index.html b/api/classes/Topic/index.html index e547c72e..a1431ff4 100644 --- a/api/classes/Topic/index.html +++ b/api/classes/Topic/index.html @@ -6,14 +6,14 @@ Class: Topic<P> | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Class: Topic<P>

Type parameters#

NameType
Pextends PayloadPayload

Constructors#

constructor#

• new Topic<P>()

Type parameters#

NameType
Pextends PayloadPayload

Defined in#

src/topic/index.ts:76

Properties#

options#

• options: TopicOptions = defaultOptions

Defined in#

src/topic/index.ts:73

project#

▪ Static Optional project: GooglePubSubProject

Defined in#

src/topic/index.ts:68

topicName#

▪ Static Readonly topicName: string

Defined in#

src/topic/index.ts:67

Methods#

publish#

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

Parameters#

NameType
messagePayloadInput<P>
options?TopicPublishOptions

Returns#

Promise<string>

Defined in#

src/topic/index.ts:127

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#

NameTypeDescription
messagePayloadInput<P>Message to be published

Returns#

void

Defined in#

src/topic/index.ts:99

validateTopic#

▸ Static validateTopic(name): void

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

Parameters#

NameTypeDescription
namestringtopicName

Returns#

void

Defined in#

src/topic/index.ts:88

- - +
Skip to main content
Version: v2

Class: Topic<P>

Type parameters#

NameType
Pextends PayloadPayload

Constructors#

constructor#

• new Topic<P>()

Type parameters#

NameType
Pextends PayloadPayload

Defined in#

src/topic/index.ts:76

Properties#

options#

• options: TopicOptions = defaultOptions

Defined in#

src/topic/index.ts:73

project#

▪ Static Optional project: GooglePubSubProject

Defined in#

src/topic/index.ts:68

topicName#

▪ Static Readonly topicName: string

Defined in#

src/topic/index.ts:67

Methods#

publish#

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

Parameters#

NameType
messagePayloadInput<P>
options?TopicPublishOptions

Returns#

Promise<string>

Defined in#

src/topic/index.ts:127

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#

NameTypeDescription
messagePayloadInput<P>Message to be published

Returns#

void

Defined in#

src/topic/index.ts:99

validateTopic#

▸ Static validateTopic(name): void

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

Parameters#

NameTypeDescription
namestringtopicName

Returns#

void

Defined in#

src/topic/index.ts:88

+ + \ No newline at end of file diff --git a/api/index.html b/api/index.html index 4aa7f12c..4b96e789 100644 --- a/api/index.html +++ b/api/index.html @@ -6,13 +6,13 @@ @honestfoodcompany/pubsub | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

@honestfoodcompany/pubsub

Classes#

Interfaces#

Functions#

isGzipCompressed#

▸ Const isGzipCompressed(buf): boolean

gzip files contain a 10-byte header, containing a:

  • magic number (1f 8b)
  • the compression method (08 for DEFLATE)
  • 1-byte of header flags, a 4-byte timestamp, compression flags and the operating system ID.

see https://en.wikipedia.org/wiki/Gzip#File_format

Parameters#

NameType
bufBuffer

Returns#

boolean

Defined in#

src/message/gzip.ts:9

setLogger#

▸ Const setLogger(logger): void

Parameters#

NameType
loggerLoggerOptions

Returns#

void

Defined in#

src/service/logger.ts:48

- - +
Skip to main content
Version: v2

@honestfoodcompany/pubsub

Classes#

Interfaces#

Functions#

isGzipCompressed#

▸ Const isGzipCompressed(buf): boolean

gzip files contain a 10-byte header, containing a:

  • magic number (1f 8b)
  • the compression method (08 for DEFLATE)
  • 1-byte of header flags, a 4-byte timestamp, compression flags and the operating system ID.

see https://en.wikipedia.org/wiki/Gzip#File_format

Parameters#

NameType
bufBuffer

Returns#

boolean

Defined in#

src/message/gzip.ts:9

setLogger#

▸ Const setLogger(logger): void

Parameters#

NameType
loggerLoggerOptions

Returns#

void

Defined in#

src/service/logger.ts:48

+ + \ No newline at end of file diff --git a/api/interfaces/Payload/index.html b/api/interfaces/Payload/index.html index e2359535..d64b7894 100644 --- a/api/interfaces/Payload/index.html +++ b/api/interfaces/Payload/index.html @@ -6,14 +6,14 @@ Interface: Payload | Pub/Sub Node.js Framework - - + +
Skip to main content
Version: v2

Interface: Payload

extend this interface to define your own payload -e.g.

interface YourTopicPayload extends Payload {
id: number;
action: string;
}

Properties#

_timestamp#

• Optional _timestamp: string

Defined in#

src/topic/index.ts:22

- - +e.g.

interface YourTopicPayload extends Payload {
id: number;
action: string;
}

Properties#

_timestamp#

• Optional _timestamp: string

Defined in#

src/topic/index.ts:22

+ + \ No newline at end of file diff --git a/api/interfaces/SubscriberMetadata/index.html b/api/interfaces/SubscriberMetadata/index.html index 222cf56f..66a35c3a 100644 --- a/api/interfaces/SubscriberMetadata/index.html +++ b/api/interfaces/SubscriberMetadata/index.html @@ -6,13 +6,13 @@ Interface: SubscriberMetadata | Pub/Sub Node.js Framework - - + +
-
Skip to main content
- - +
Skip to main content
+ + \ No newline at end of file diff --git a/api/interfaces/SubscriberObject/index.html b/api/interfaces/SubscriberObject/index.html index 82a6c828..84439ffa 100644 --- a/api/interfaces/SubscriberObject/index.html +++ b/api/interfaces/SubscriberObject/index.html @@ -6,13 +6,13 @@ Interface: SubscriberObject<T> | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Interface: SubscriberObject<T>

Type parameters#

NameType
Tunknown

Hierarchy#

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

- - +
Skip to main content
Version: v2

Interface: SubscriberObject<T>

Type parameters#

NameType
Tunknown

Hierarchy#

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

+ + \ No newline at end of file diff --git a/api/interfaces/SubscriberOptions/index.html b/api/interfaces/SubscriberOptions/index.html index 91a04d99..1fa170e6 100644 --- a/api/interfaces/SubscriberOptions/index.html +++ b/api/interfaces/SubscriberOptions/index.html @@ -6,20 +6,20 @@ Interface: SubscriberOptions | Pub/Sub Node.js Framework - - + +
-
Skip to main content
Version: v2

Interface: SubscriberOptions

Hierarchy#

  • GoogleCloudSubscriberOptions

    ↳ SubscriberOptions

Properties#

ackDeadline#

• Optional ackDeadline: number

Inherited from#

GoogleCloudSubscriberOptions.ackDeadline

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:105

batching#

• Optional batching: BatchOptions

Inherited from#

GoogleCloudSubscriberOptions.batching

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:106

deadLetterPolicy#

• Optional deadLetterPolicy: Object

Type declaration#

NameType
createDefaultSubscription?boolean
deadLetterTopicstring
maxDeliveryAttemptsnumber

Defined in#

src/subscriber/subscriberV2.ts:75

enableMessageOrdering#

• Optional enableMessageOrdering: boolean

If true, messages published with the same ordering_key in PubsubMessage +

Version: v2

Interface: SubscriberOptions

Hierarchy#

  • GoogleCloudSubscriberOptions

    ↳ SubscriberOptions

Properties#

ackDeadline#

• Optional ackDeadline: number

Inherited from#

GoogleCloudSubscriberOptions.ackDeadline

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:105

batching#

• Optional batching: BatchOptions

Inherited from#

GoogleCloudSubscriberOptions.batching

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:106

deadLetterPolicy#

• Optional deadLetterPolicy: Object

Type declaration#

NameType
createDefaultSubscription?boolean
deadLetterTopicstring
maxDeliveryAttemptsnumber

Defined in#

src/subscriber/subscriberV2.ts:75

enableMessageOrdering#

• Optional enableMessageOrdering: boolean

If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in -any order.

Defined in#

src/subscriber/subscriberV2.ts:106

enableOpenTelemetryTracing#

• Optional enableOpenTelemetryTracing: boolean

Inherited from#

GoogleCloudSubscriberOptions.enableOpenTelemetryTracing

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:110

filter#

• Optional filter: string

An expression written in the Pub/Sub filter +any order.

Defined in#

src/subscriber/subscriberV2.ts:106

enableOpenTelemetryTracing#

• Optional enableOpenTelemetryTracing: boolean

Inherited from#

GoogleCloudSubscriberOptions.enableOpenTelemetryTracing

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:110

filter#

• Optional filter: string

An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered -out.

Defined in#

src/subscriber/subscriberV2.ts:98

flowControl#

• Optional flowControl: FlowControlOptions

Inherited from#

GoogleCloudSubscriberOptions.flowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107

labels#

• Optional labels: null | { [k: string]: string; }

Defined in#

src/subscriber/subscriberV2.ts:74

project#

• Optional project: GooglePubSubProject

Defined in#

src/subscriber/subscriberV2.ts:73

retryPolicy#

• Optional retryPolicy: Object

Type declaration#

NameType
maximumBackoffObject
maximumBackoff.nanos?number
maximumBackoff.secondsnumber
minimumBackoffObject
minimumBackoff.nanos?number
minimumBackoff.secondsnumber

Defined in#

src/subscriber/subscriberV2.ts:80

streamingOptions#

• Optional streamingOptions: MessageStreamOptions

Inherited from#

GoogleCloudSubscriberOptions.streamingOptions

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:109

useLegacyFlowControl#

• Optional useLegacyFlowControl: boolean

Inherited from#

GoogleCloudSubscriberOptions.useLegacyFlowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:108

- - +out.

Defined in#

src/subscriber/subscriberV2.ts:98

flowControl#

• Optional flowControl: FlowControlOptions

Inherited from#

GoogleCloudSubscriberOptions.flowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107

labels#

• Optional labels: null | { [k: string]: string; }

Defined in#

src/subscriber/subscriberV2.ts:74

project#

• Optional project: GooglePubSubProject

Defined in#

src/subscriber/subscriberV2.ts:73

retryPolicy#

• Optional retryPolicy: Object

Type declaration#

NameType
maximumBackoffObject
maximumBackoff.nanos?number
maximumBackoff.secondsnumber
minimumBackoffObject
minimumBackoff.nanos?number
minimumBackoff.secondsnumber

Defined in#

src/subscriber/subscriberV2.ts:80

streamingOptions#

• Optional streamingOptions: MessageStreamOptions

Inherited from#

GoogleCloudSubscriberOptions.streamingOptions

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:109

useLegacyFlowControl#

• Optional useLegacyFlowControl: boolean

Inherited from#

GoogleCloudSubscriberOptions.useLegacyFlowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:108

+ + \ No newline at end of file diff --git a/api/interfaces/TopicOptions/index.html b/api/interfaces/TopicOptions/index.html index 3fd0dc6a..ef0d408e 100644 --- a/api/interfaces/TopicOptions/index.html +++ b/api/interfaces/TopicOptions/index.html @@ -6,13 +6,13 @@ Interface: TopicOptions | Pub/Sub Node.js Framework - - + +
-
Skip to main content
- - +
Skip to main content
+ + \ No newline at end of file diff --git a/assets/js/13caf63c.6a54c260.js b/assets/js/13caf63c.071d2e89.js similarity index 93% rename from assets/js/13caf63c.6a54c260.js rename to assets/js/13caf63c.071d2e89.js index 5095109d..e2f782ec 100644 --- a/assets/js/13caf63c.6a54c260.js +++ b/assets/js/13caf63c.071d2e89.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[835],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},b=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),b=d(n),c=i,m=b["".concat(p,".").concat(c)]||b[c]||u[c]||a;return n?r.createElement(m,l(l({ref:t},s),{},{components:n})):r.createElement(m,l({ref:t},s))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=b;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{default:()=>u,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),l=["components"],o={id:"SubscriberOptions",title:"Interface: SubscriberOptions",sidebar_label:"SubscriberOptions",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/interfaces/SubscriberOptions",id:"api/interfaces/SubscriberOptions",isDocsHomePage:!1,title:"Interface: SubscriberOptions",description:"Hierarchy",source:"@site/docs/api/interfaces/SubscriberOptions.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions",editUrl:null,version:"current",sidebar_label:"SubscriberOptions",sidebarPosition:0,frontMatter:{id:"SubscriberOptions",title:"Interface: SubscriberOptions",sidebar_label:"SubscriberOptions",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject"},next:{title:"Interface: TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions"}},d=[{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Properties",id:"properties",children:[{value:"ackDeadline",id:"ackdeadline",children:[]},{value:"batching",id:"batching",children:[]},{value:"deadLetterPolicy",id:"deadletterpolicy",children:[]},{value:"enableMessageOrdering",id:"enablemessageordering",children:[]},{value:"enableOpenTelemetryTracing",id:"enableopentelemetrytracing",children:[]},{value:"filter",id:"filter",children:[]},{value:"flowControl",id:"flowcontrol",children:[]},{value:"labels",id:"labels",children:[]},{value:"project",id:"project",children:[]},{value:"retryPolicy",id:"retrypolicy",children:[]},{value:"streamingOptions",id:"streamingoptions",children:[]},{value:"useLegacyFlowControl",id:"uselegacyflowcontrol",children:[]}]}],s={toc:d};function u(e){var t=e.components,n=(0,i.Z)(e,l);return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"GoogleCloudSubscriberOptions")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SubscriberOptions"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"ackdeadline"},"ackDeadline"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ackDeadline"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.ackDeadline"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:105"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"batching"},"batching"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"batching"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"BatchOptions")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.batching"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:106"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"deadletterpolicy"},"deadLetterPolicy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"deadLetterPolicy"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"createDefaultSubscription?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"deadLetterTopic")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maxDeliveryAttempts")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L75"},"src/subscriber/subscriberV2.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enablemessageordering"},"enableMessageOrdering"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"enableMessageOrdering"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null," If true, messages published with the same ",(0,a.kt)("inlineCode",{parentName:"p"},"ordering_key")," in ",(0,a.kt)("inlineCode",{parentName:"p"},"PubsubMessage"),"\nwill be delivered to the subscribers in the order in which they\nare received by the Pub/Sub system. Otherwise, they may be delivered in\nany order."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L106"},"src/subscriber/subscriberV2.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enableopentelemetrytracing"},"enableOpenTelemetryTracing"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"enableOpenTelemetryTracing"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.enableOpenTelemetryTracing"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:110"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"filter"},"filter"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"filter"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null," An expression written in the Pub/Sub ",(0,a.kt)("a",{parentName:"p",href:"https://cloud.google.com/pubsub/docs/filtering"},"filter\nlanguage"),". If non-empty,\nthen only ",(0,a.kt)("inlineCode",{parentName:"p"},"PubsubMessage"),"s whose ",(0,a.kt)("inlineCode",{parentName:"p"},"attributes")," field matches the filter are\ndelivered on this subscription. If empty, then no messages are filtered\nout."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L98"},"src/subscriber/subscriberV2.ts:98")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"flowcontrol"},"flowControl"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"flowControl"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"FlowControlOptions")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.flowControl"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"labels"},"labels"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"labels"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," { ","[k: string]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"; }"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L74"},"src/subscriber/subscriberV2.ts:74")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"project"},"project"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"project"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GooglePubSubProject")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L73"},"src/subscriber/subscriberV2.ts:73")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"retrypolicy"},"retryPolicy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"retryPolicy"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff.nanos?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff.seconds")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff.nanos?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff.seconds")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L80"},"src/subscriber/subscriberV2.ts:80")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamingoptions"},"streamingOptions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"streamingOptions"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MessageStreamOptions")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.streamingOptions"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:109"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uselegacyflowcontrol"},"useLegacyFlowControl"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"useLegacyFlowControl"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.useLegacyFlowControl"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:108"))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[835],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>b});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=d(n),b=i,m=c["".concat(p,".").concat(b)]||c[b]||u[b]||a;return n?r.createElement(m,l(l({ref:t},s),{},{components:n})):r.createElement(m,l({ref:t},s))}));function b(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{default:()=>u,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),l=["components"],o={id:"SubscriberOptions",title:"Interface: SubscriberOptions",sidebar_label:"SubscriberOptions",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/interfaces/SubscriberOptions",id:"api/interfaces/SubscriberOptions",isDocsHomePage:!1,title:"Interface: SubscriberOptions",description:"Hierarchy",source:"@site/docs/api/interfaces/SubscriberOptions.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions",editUrl:null,version:"current",sidebar_label:"SubscriberOptions",sidebarPosition:0,frontMatter:{id:"SubscriberOptions",title:"Interface: SubscriberOptions",sidebar_label:"SubscriberOptions",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject"},next:{title:"Interface: TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions"}},d=[{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Properties",id:"properties",children:[{value:"ackDeadline",id:"ackdeadline",children:[]},{value:"batching",id:"batching",children:[]},{value:"deadLetterPolicy",id:"deadletterpolicy",children:[]},{value:"enableMessageOrdering",id:"enablemessageordering",children:[]},{value:"enableOpenTelemetryTracing",id:"enableopentelemetrytracing",children:[]},{value:"filter",id:"filter",children:[]},{value:"flowControl",id:"flowcontrol",children:[]},{value:"labels",id:"labels",children:[]},{value:"project",id:"project",children:[]},{value:"retryPolicy",id:"retrypolicy",children:[]},{value:"streamingOptions",id:"streamingoptions",children:[]},{value:"useLegacyFlowControl",id:"uselegacyflowcontrol",children:[]}]}],s={toc:d};function u(e){var t=e.components,n=(0,i.Z)(e,l);return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"GoogleCloudSubscriberOptions")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SubscriberOptions"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"ackdeadline"},"ackDeadline"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ackDeadline"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.ackDeadline"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:105"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"batching"},"batching"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"batching"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"BatchOptions")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.batching"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:106"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"deadletterpolicy"},"deadLetterPolicy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"deadLetterPolicy"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"createDefaultSubscription?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"deadLetterTopic")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maxDeliveryAttempts")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L75"},"src/subscriber/subscriberV2.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enablemessageordering"},"enableMessageOrdering"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"enableMessageOrdering"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null," If true, messages published with the same ",(0,a.kt)("inlineCode",{parentName:"p"},"ordering_key")," in ",(0,a.kt)("inlineCode",{parentName:"p"},"PubsubMessage"),"\nwill be delivered to the subscribers in the order in which they\nare received by the Pub/Sub system. Otherwise, they may be delivered in\nany order."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L106"},"src/subscriber/subscriberV2.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enableopentelemetrytracing"},"enableOpenTelemetryTracing"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"enableOpenTelemetryTracing"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.enableOpenTelemetryTracing"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:110"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"filter"},"filter"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"filter"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null," An expression written in the Pub/Sub ",(0,a.kt)("a",{parentName:"p",href:"https://cloud.google.com/pubsub/docs/filtering"},"filter\nlanguage"),". If non-empty,\nthen only ",(0,a.kt)("inlineCode",{parentName:"p"},"PubsubMessage"),"s whose ",(0,a.kt)("inlineCode",{parentName:"p"},"attributes")," field matches the filter are\ndelivered on this subscription. If empty, then no messages are filtered\nout."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L98"},"src/subscriber/subscriberV2.ts:98")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"flowcontrol"},"flowControl"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"flowControl"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"FlowControlOptions")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.flowControl"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"labels"},"labels"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"labels"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," { ","[k: string]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"; }"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L74"},"src/subscriber/subscriberV2.ts:74")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"project"},"project"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"project"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"GooglePubSubProject")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L73"},"src/subscriber/subscriberV2.ts:73")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"retrypolicy"},"retryPolicy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"retryPolicy"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff.nanos?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"maximumBackoff.seconds")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff.nanos?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"minimumBackoff.seconds")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L80"},"src/subscriber/subscriberV2.ts:80")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamingoptions"},"streamingOptions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"streamingOptions"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MessageStreamOptions")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.streamingOptions"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:109"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uselegacyflowcontrol"},"useLegacyFlowControl"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"useLegacyFlowControl"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"GoogleCloudSubscriberOptions.useLegacyFlowControl"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,"node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:108"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/157e1c0d.df0a2536.js b/assets/js/157e1c0d.6ffacc77.js similarity index 94% rename from assets/js/157e1c0d.df0a2536.js rename to assets/js/157e1c0d.6ffacc77.js index a4c1302f..183b6efd 100644 --- a/assets/js/157e1c0d.df0a2536.js +++ b/assets/js/157e1c0d.6ffacc77.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[139],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,s=a(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,b=u["".concat(l,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(b,p(p({ref:t},s),{},{components:n})):r.createElement(b,p({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,p=new Array(o);p[0]=u;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a.mdxType="string"==typeof e?e:i,p[1]=a;for(var c=2;c{n.r(t),n.d(t,{default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(7462),i=n(3366),o=(n(7294),n(3905)),p=["components"],a={id:"TopicOptions",title:"Interface: TopicOptions",sidebar_label:"TopicOptions",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/TopicOptions",id:"api/interfaces/TopicOptions",isDocsHomePage:!1,title:"Interface: TopicOptions",description:"Properties",source:"@site/docs/api/interfaces/TopicOptions.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions",editUrl:null,version:"current",sidebar_label:"TopicOptions",sidebarPosition:0,frontMatter:{id:"TopicOptions",title:"Interface: TopicOptions",sidebar_label:"TopicOptions",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions"},next:{title:"Changelog",permalink:"/hfc-pubsub/changelog"}},c=[{value:"Properties",id:"properties",children:[{value:"addTimeStamp",id:"addtimestamp",children:[]},{value:"enableGZipCompression",id:"enablegzipcompression",children:[]},{value:"labels",id:"labels",children:[]},{value:"retryConfig",id:"retryconfig",children:[]}]}],s={toc:c};function d(e){var t=e.components,n=(0,i.Z)(e,p);return(0,o.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"addtimestamp"},"addTimeStamp"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"addTimeStamp"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L30"},"src/topic/index.ts:30")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"enablegzipcompression"},"enableGZipCompression"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"enableGZipCompression"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L33"},"src/topic/index.ts:33")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"labels"},"labels"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"labels"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"null")," ","|"," { ","[k: string]",": ",(0,o.kt)("inlineCode",{parentName:"p"},"string"),"; }"),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L31"},"src/topic/index.ts:31")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"retryconfig"},"retryConfig"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"retryConfig"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"RetryConfig")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L32"},"src/topic/index.ts:32")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[139],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,s=a(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,b=u["".concat(l,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(b,p(p({ref:t},s),{},{components:n})):r.createElement(b,p({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,p=new Array(o);p[0]=u;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a.mdxType="string"==typeof e?e:i,p[1]=a;for(var c=2;c{n.r(t),n.d(t,{default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(7462),i=n(3366),o=(n(7294),n(3905)),p=["components"],a={id:"TopicOptions",title:"Interface: TopicOptions",sidebar_label:"TopicOptions",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/TopicOptions",id:"api/interfaces/TopicOptions",isDocsHomePage:!1,title:"Interface: TopicOptions",description:"Properties",source:"@site/docs/api/interfaces/TopicOptions.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions",editUrl:null,version:"current",sidebar_label:"TopicOptions",sidebarPosition:0,frontMatter:{id:"TopicOptions",title:"Interface: TopicOptions",sidebar_label:"TopicOptions",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions"},next:{title:"Changelog",permalink:"/hfc-pubsub/changelog"}},c=[{value:"Properties",id:"properties",children:[{value:"addTimeStamp",id:"addtimestamp",children:[]},{value:"enableGZipCompression",id:"enablegzipcompression",children:[]},{value:"labels",id:"labels",children:[]},{value:"retryConfig",id:"retryconfig",children:[]}]}],s={toc:c};function d(e){var t=e.components,n=(0,i.Z)(e,p);return(0,o.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"addtimestamp"},"addTimeStamp"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"addTimeStamp"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L30"},"src/topic/index.ts:30")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"enablegzipcompression"},"enableGZipCompression"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"enableGZipCompression"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L33"},"src/topic/index.ts:33")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"labels"},"labels"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"labels"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"null")," ","|"," { ","[k: string]",": ",(0,o.kt)("inlineCode",{parentName:"p"},"string"),"; }"),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L31"},"src/topic/index.ts:31")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"retryconfig"},"retryConfig"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"retryConfig"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"RetryConfig")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L32"},"src/topic/index.ts:32")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1c01e663.02b0d49e.js b/assets/js/1c01e663.5b036185.js similarity index 96% rename from assets/js/1c01e663.02b0d49e.js rename to assets/js/1c01e663.5b036185.js index b969cac5..aa0605b2 100644 --- a/assets/js/1c01e663.02b0d49e.js +++ b/assets/js/1c01e663.5b036185.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[3680],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,m=d["".concat(l,".").concat(f)]||d[f]||u[f]||i;return r?n.createElement(m,o(o({ref:t},s),{},{components:r})):n.createElement(m,o({ref:t},s))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=d;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var c=2;c{r.r(t),r.d(t,{default:()=>u,frontMatter:()=>p,metadata:()=>l,toc:()=>c});var n=r(7462),a=r(3366),i=(r(7294),r(3905)),o=["components"],p={id:"Payload",title:"Interface: Payload",sidebar_label:"Payload",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/Payload",id:"api/interfaces/Payload",isDocsHomePage:!1,title:"Interface: Payload",description:"extend this interface to define your own payload",source:"@site/docs/api/interfaces/Payload.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Payload",permalink:"/hfc-pubsub/api/interfaces/Payload",editUrl:null,version:"current",sidebar_label:"Payload",sidebarPosition:0,frontMatter:{id:"Payload",title:"Interface: Payload",sidebar_label:"Payload",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: Topic

",permalink:"/hfc-pubsub/api/classes/Topic"},next:{title:"Interface: SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata"}},c=[{value:"Properties",id:"properties",children:[{value:"_timestamp",id:"_timestamp",children:[]}]}],s={toc:c};function u(e){var t=e.components,r=(0,a.Z)(e,o);return(0,i.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"extend this interface to define your own payload\ne.g."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-typescript"}," interface YourTopicPayload extends Payload {\n id: number;\n action: string;\n }\n")),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_timestamp"},"_","timestamp"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"_","timestamp"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L22"},"src/topic/index.ts:22")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[3680],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,m=d["".concat(l,".").concat(f)]||d[f]||u[f]||i;return r?n.createElement(m,o(o({ref:t},s),{},{components:r})):n.createElement(m,o({ref:t},s))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=d;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var c=2;c{r.r(t),r.d(t,{default:()=>u,frontMatter:()=>p,metadata:()=>l,toc:()=>c});var n=r(7462),a=r(3366),i=(r(7294),r(3905)),o=["components"],p={id:"Payload",title:"Interface: Payload",sidebar_label:"Payload",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/Payload",id:"api/interfaces/Payload",isDocsHomePage:!1,title:"Interface: Payload",description:"extend this interface to define your own payload",source:"@site/docs/api/interfaces/Payload.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Payload",permalink:"/hfc-pubsub/api/interfaces/Payload",editUrl:null,version:"current",sidebar_label:"Payload",sidebarPosition:0,frontMatter:{id:"Payload",title:"Interface: Payload",sidebar_label:"Payload",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: Topic

",permalink:"/hfc-pubsub/api/classes/Topic"},next:{title:"Interface: SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata"}},c=[{value:"Properties",id:"properties",children:[{value:"_timestamp",id:"_timestamp",children:[]}]}],s={toc:c};function u(e){var t=e.components,r=(0,a.Z)(e,o);return(0,i.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"extend this interface to define your own payload\ne.g."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-typescript"}," interface YourTopicPayload extends Payload {\n id: number;\n action: string;\n }\n")),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_timestamp"},"_","timestamp"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"_","timestamp"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L22"},"src/topic/index.ts:22")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/246f2c6f.d65c1318.js b/assets/js/246f2c6f.9af9f1c9.js similarity index 99% rename from assets/js/246f2c6f.d65c1318.js rename to assets/js/246f2c6f.9af9f1c9.js index 127bc955..f06dd430 100644 --- a/assets/js/246f2c6f.d65c1318.js +++ b/assets/js/246f2c6f.9af9f1c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[9285],{6267:e=>{e.exports=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","versionLabel":"v2","versionPath":"/hfc-pubsub/","versionEditUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs","versionEditUrlLocalized":"https://github.com/deliveryhero/hfc-pubsub/edit/main/i18n/en/docusaurus-plugin-content-docs/current","isLast":true,"routePriority":-1,"contentPath":"/home/runner/work/hfc-pubsub/hfc-pubsub/docs","contentPathLocalized":"/home/runner/work/hfc-pubsub/hfc-pubsub/i18n/en/docusaurus-plugin-content-docs/current","mainDocId":"introduction","sidebars":{"defaultSidebar":[{"type":"doc","id":"introduction"},{"type":"category","label":"Getting Started","items":[{"type":"doc","id":"getting-started/installation"}],"collapsed":false},{"type":"category","label":"Subscribing","items":[{"type":"doc","id":"subscribing/subscriptions"},{"type":"doc","id":"subscribing/dead-letter-policy","label":"Dead Letter Policy"},{"type":"doc","id":"subscribing/Messages_compression"},{"type":"doc","id":"subscribing/error-handling","label":"Error Handling"},{"type":"doc","id":"subscribing/labels","label":"Labels"},{"type":"doc","id":"subscribing/retry-policy","label":"Retry Policy"},{"type":"doc","id":"subscribing/message-ordering","label":"Message Ordering"}],"collapsed":true},{"type":"category","label":"Publishing","items":[{"type":"doc","id":"publishing/topics"},{"type":"doc","id":"publishing/retry-settings","label":"Retry Settings"},{"type":"doc","id":"publishing/attributes","label":"Attributes"},{"type":"doc","id":"publishing/publish-diff-project","label":"Different GCP project"}],"collapsed":true},{"type":"category","label":"Server","items":[{"type":"doc","id":"server/service"},{"type":"doc","id":"server/custom-logger","label":"Custom Logger"},{"type":"doc","id":"server/connect-database","label":"Connect Database"},{"type":"doc","id":"server/graceful-shutdown"},{"type":"doc","id":"server/health-check"}],"collapsed":true},{"type":"category","label":"Guides","items":[{"type":"doc","id":"guides/cli"},{"type":"doc","id":"guides/drivers"},{"type":"doc","id":"guides/migrating-to-v2"},{"type":"doc","id":"guides/testing"}],"collapsed":true},{"type":"doc","id":"options"},{"type":"category","label":"API","items":[{"type":"doc","id":"api/index","label":"Exports"},{"type":"category","label":"Classes","items":[{"type":"doc","id":"api/classes/Message","label":"Message"},{"type":"doc","id":"api/classes/PubSubService","label":"PubSubService"},{"type":"doc","id":"api/classes/SubscriptionService","label":"SubscriptionService"},{"type":"doc","id":"api/classes/Topic","label":"Topic"}],"collapsed":true},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"api/interfaces/Payload","label":"Payload"},{"type":"doc","id":"api/interfaces/SubscriberMetadata","label":"SubscriberMetadata"},{"type":"doc","id":"api/interfaces/SubscriberObject","label":"SubscriberObject"},{"type":"doc","id":"api/interfaces/SubscriberOptions","label":"SubscriberOptions"},{"type":"doc","id":"api/interfaces/TopicOptions","label":"TopicOptions"}],"collapsed":true}],"collapsed":true},{"type":"doc","id":"changelog"}]},"permalinkToSidebar":{"/hfc-pubsub/api/classes/Message":"defaultSidebar","/hfc-pubsub/api/classes/PubSubService":"defaultSidebar","/hfc-pubsub/api/classes/SubscriptionService":"defaultSidebar","/hfc-pubsub/api/classes/Topic":"defaultSidebar","/hfc-pubsub/api/":"defaultSidebar","/hfc-pubsub/api/interfaces/Payload":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberMetadata":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberObject":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberOptions":"defaultSidebar","/hfc-pubsub/api/interfaces/TopicOptions":"defaultSidebar","/hfc-pubsub/changelog":"defaultSidebar","/hfc-pubsub/getting-started/installation":"defaultSidebar","/hfc-pubsub/guides/cli":"defaultSidebar","/hfc-pubsub/guides/drivers":"defaultSidebar","/hfc-pubsub/guides/migrating-to-v2":"defaultSidebar","/hfc-pubsub/guides/testing":"defaultSidebar","/hfc-pubsub/":"defaultSidebar","/hfc-pubsub/options":"defaultSidebar","/hfc-pubsub/publishing/attributes":"defaultSidebar","/hfc-pubsub/publishing/publish-diff-project":"defaultSidebar","/hfc-pubsub/publishing/retry-settings":"defaultSidebar","/hfc-pubsub/publishing/topics":"defaultSidebar","/hfc-pubsub/server/connect-database":"defaultSidebar","/hfc-pubsub/server/custom-logger":"defaultSidebar","/hfc-pubsub/server/graceful-shutdown":"defaultSidebar","/hfc-pubsub/server/health-check":"defaultSidebar","/hfc-pubsub/server/service":"defaultSidebar","/hfc-pubsub/subscribing/dead-letter-policy":"defaultSidebar","/hfc-pubsub/subscribing/error-handling":"defaultSidebar","/hfc-pubsub/subscribing/labels":"defaultSidebar","/hfc-pubsub/subscribing/message-ordering":"defaultSidebar","/hfc-pubsub/subscribing/Messages_compression":"defaultSidebar","/hfc-pubsub/subscribing/retry-policy":"defaultSidebar","/hfc-pubsub/subscribing/subscriptions":"defaultSidebar"},"docs":[{"unversionedId":"api/classes/Message","id":"api/classes/Message","isDocsHomePage":false,"title":"Class: Message","description":"Type parameters","source":"@site/docs/api/classes/Message.md","sourceDirName":"api/classes","slug":"/api/classes/Message","permalink":"/hfc-pubsub/api/classes/Message","editUrl":null,"version":"current","sidebar_label":"Message","sidebarPosition":0,"frontMatter":{"id":"Message","title":"Class: Message","sidebar_label":"Message","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/api/"},"next":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService"}},{"unversionedId":"api/classes/PubSubService","id":"api/classes/PubSubService","isDocsHomePage":false,"title":"Class: PubSubService","description":"Properties","source":"@site/docs/api/classes/PubSubService.md","sourceDirName":"api/classes","slug":"/api/classes/PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService","editUrl":null,"version":"current","sidebar_label":"PubSubService","sidebarPosition":0,"frontMatter":{"id":"PubSubService","title":"Class: PubSubService","sidebar_label":"PubSubService","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: Message","permalink":"/hfc-pubsub/api/classes/Message"},"next":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService"}},{"unversionedId":"api/classes/SubscriptionService","id":"api/classes/SubscriptionService","isDocsHomePage":false,"title":"Class: SubscriptionService","description":"Constructors","source":"@site/docs/api/classes/SubscriptionService.md","sourceDirName":"api/classes","slug":"/api/classes/SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService","editUrl":null,"version":"current","sidebar_label":"SubscriptionService","sidebarPosition":0,"frontMatter":{"id":"SubscriptionService","title":"Class: SubscriptionService","sidebar_label":"SubscriptionService","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService"},"next":{"title":"Class: Topic

","permalink":"/hfc-pubsub/api/classes/Topic"}},{"unversionedId":"api/classes/Topic","id":"api/classes/Topic","isDocsHomePage":false,"title":"Class: Topic

","description":"Type parameters","source":"@site/docs/api/classes/Topic.md","sourceDirName":"api/classes","slug":"/api/classes/Topic","permalink":"/hfc-pubsub/api/classes/Topic","editUrl":null,"version":"current","sidebar_label":"Topic","sidebarPosition":0,"frontMatter":{"id":"Topic","title":"Class: Topic

","sidebar_label":"Topic","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService"},"next":{"title":"Interface: Payload","permalink":"/hfc-pubsub/api/interfaces/Payload"}},{"unversionedId":"api/index","id":"api/index","isDocsHomePage":false,"title":"@honestfoodcompany/pubsub","description":"Classes","source":"@site/docs/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/hfc-pubsub/api/","editUrl":null,"version":"current","sidebar_label":"Exports","sidebarPosition":0.5,"frontMatter":{"id":"index","title":"@honestfoodcompany/pubsub","slug":"/api/","sidebar_label":"Exports","sidebar_position":0.5,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Other Options","permalink":"/hfc-pubsub/options"},"next":{"title":"Class: Message","permalink":"/hfc-pubsub/api/classes/Message"}},{"unversionedId":"api/interfaces/Payload","id":"api/interfaces/Payload","isDocsHomePage":false,"title":"Interface: Payload","description":"extend this interface to define your own payload","source":"@site/docs/api/interfaces/Payload.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Payload","permalink":"/hfc-pubsub/api/interfaces/Payload","editUrl":null,"version":"current","sidebar_label":"Payload","sidebarPosition":0,"frontMatter":{"id":"Payload","title":"Interface: Payload","sidebar_label":"Payload","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: Topic

","permalink":"/hfc-pubsub/api/classes/Topic"},"next":{"title":"Interface: SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata"}},{"unversionedId":"api/interfaces/SubscriberMetadata","id":"api/interfaces/SubscriberMetadata","isDocsHomePage":false,"title":"Interface: SubscriberMetadata","description":"Properties","source":"@site/docs/api/interfaces/SubscriberMetadata.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata","editUrl":null,"version":"current","sidebar_label":"SubscriberMetadata","sidebarPosition":0,"frontMatter":{"id":"SubscriberMetadata","title":"Interface: SubscriberMetadata","sidebar_label":"SubscriberMetadata","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: Payload","permalink":"/hfc-pubsub/api/interfaces/Payload"},"next":{"title":"Interface: SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject"}},{"unversionedId":"api/interfaces/SubscriberObject","id":"api/interfaces/SubscriberObject","isDocsHomePage":false,"title":"Interface: SubscriberObject","description":"Type parameters","source":"@site/docs/api/interfaces/SubscriberObject.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject","editUrl":null,"version":"current","sidebar_label":"SubscriberObject","sidebarPosition":0,"frontMatter":{"id":"SubscriberObject","title":"Interface: SubscriberObject","sidebar_label":"SubscriberObject","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata"},"next":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions"}},{"unversionedId":"api/interfaces/SubscriberOptions","id":"api/interfaces/SubscriberOptions","isDocsHomePage":false,"title":"Interface: SubscriberOptions","description":"Hierarchy","source":"@site/docs/api/interfaces/SubscriberOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions","editUrl":null,"version":"current","sidebar_label":"SubscriberOptions","sidebarPosition":0,"frontMatter":{"id":"SubscriberOptions","title":"Interface: SubscriberOptions","sidebar_label":"SubscriberOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject"},"next":{"title":"Interface: TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions"}},{"unversionedId":"api/interfaces/TopicOptions","id":"api/interfaces/TopicOptions","isDocsHomePage":false,"title":"Interface: TopicOptions","description":"Properties","source":"@site/docs/api/interfaces/TopicOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions","editUrl":null,"version":"current","sidebar_label":"TopicOptions","sidebarPosition":0,"frontMatter":{"id":"TopicOptions","title":"Interface: TopicOptions","sidebar_label":"TopicOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions"},"next":{"title":"Changelog","permalink":"/hfc-pubsub/changelog"}},{"unversionedId":"changelog","id":"changelog","isDocsHomePage":false,"title":"Changelog","description":"2.2.2","source":"@site/docs/changelog.md","sourceDirName":".","slug":"/changelog","permalink":"/hfc-pubsub/changelog","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/changelog.md","version":"current","frontMatter":{},"sidebar":"defaultSidebar","previous":{"title":"Interface: TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions"}},{"unversionedId":"getting-started/installation","id":"getting-started/installation","isDocsHomePage":false,"title":"Installation","description":"Requirements","source":"@site/docs/getting-started/Installation.md","sourceDirName":"getting-started","slug":"/getting-started/installation","permalink":"/hfc-pubsub/getting-started/installation","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/getting-started/Installation.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"installation","title":"Installation","slug":"/getting-started/installation","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Introduction","permalink":"/hfc-pubsub/"},"next":{"title":"Subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions"}},{"unversionedId":"guides/cli","id":"guides/cli","isDocsHomePage":false,"title":"CLI","description":"Prerequisites npm i -g npx","source":"@site/docs/guides/CLI.md","sourceDirName":"guides","slug":"/guides/cli","permalink":"/hfc-pubsub/guides/cli","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/CLI.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"cli","title":"CLI","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Health Checks","permalink":"/hfc-pubsub/server/health-check"},"next":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/guides/drivers"}},{"unversionedId":"guides/drivers","id":"guides/drivers","isDocsHomePage":false,"title":"PubSub Drivers","description":"Google PubSub Driver","source":"@site/docs/guides/Drivers.md","sourceDirName":"guides","slug":"/guides/drivers","permalink":"/hfc-pubsub/guides/drivers","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Drivers.md","version":"current","sidebarPosition":2,"frontMatter":{"id":"drivers","title":"PubSub Drivers","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"CLI","permalink":"/hfc-pubsub/guides/cli"},"next":{"title":"Migrating to v2","permalink":"/hfc-pubsub/guides/migrating-to-v2"}},{"unversionedId":"guides/migrating-to-v2","id":"guides/migrating-to-v2","isDocsHomePage":false,"title":"Migrating to v2","description":"We simplified and improved the experience of using PubSub Framework (especially for Typescript users) in v2, that meant changing the way we do a few things.","source":"@site/docs/guides/Migrating to v2.mdx","sourceDirName":"guides","slug":"/guides/migrating-to-v2","permalink":"/hfc-pubsub/guides/migrating-to-v2","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Migrating to v2.mdx","version":"current","sidebarPosition":3,"frontMatter":{"id":"migrating-to-v2","title":"Migrating to v2","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/guides/drivers"},"next":{"title":"Testing","permalink":"/hfc-pubsub/guides/testing"}},{"unversionedId":"guides/testing","id":"guides/testing","isDocsHomePage":false,"title":"Testing","description":"Unit Tests","source":"@site/docs/guides/Testing.md","sourceDirName":"guides","slug":"/guides/testing","permalink":"/hfc-pubsub/guides/testing","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Testing.md","version":"current","sidebarPosition":4,"frontMatter":{"id":"testing","title":"Testing","sidebar_position":4},"sidebar":"defaultSidebar","previous":{"title":"Migrating to v2","permalink":"/hfc-pubsub/guides/migrating-to-v2"},"next":{"title":"Other Options","permalink":"/hfc-pubsub/options"}},{"unversionedId":"introduction","id":"introduction","isDocsHomePage":false,"title":"Introduction","description":"@honestfoodcompany/pubsub","source":"@site/docs/Introduction.md","sourceDirName":".","slug":"/","permalink":"/hfc-pubsub/","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/Introduction.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"introduction","title":"Introduction","sidebar_position":0,"slug":"/"},"sidebar":"defaultSidebar","next":{"title":"Installation","permalink":"/hfc-pubsub/getting-started/installation"}},{"unversionedId":"options","id":"options","isDocsHomePage":false,"title":"Other Options","description":"","source":"@site/docs/Options.md","sourceDirName":".","slug":"/options","permalink":"/hfc-pubsub/options","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/Options.md","version":"current","sidebarPosition":6,"frontMatter":{"id":"options","title":"Other Options","sidebar_position":6},"sidebar":"defaultSidebar","previous":{"title":"Testing","permalink":"/hfc-pubsub/guides/testing"},"next":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/api/"}},{"unversionedId":"publishing/attributes","id":"publishing/attributes","isDocsHomePage":false,"title":"Publishing with Attributes","description":"See:","source":"@site/docs/publishing/Attributes.md","sourceDirName":"publishing","slug":"/publishing/attributes","permalink":"/hfc-pubsub/publishing/attributes","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Attributes.md","version":"current","sidebar_label":"Attributes","sidebarPosition":2,"frontMatter":{"id":"attributes","title":"Publishing with Attributes","sidebar_label":"Attributes","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/publishing/retry-settings"},"next":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/publishing/publish-diff-project"}},{"unversionedId":"publishing/publish-diff-project","id":"publishing/publish-diff-project","isDocsHomePage":false,"title":"Publishing on a Different GCP project","description":"`ts title=\\"/pubsub/topics/example-topic-with-custom-credentials.ts\\"","source":"@site/docs/publishing/Publish Diff Project.md","sourceDirName":"publishing","slug":"/publishing/publish-diff-project","permalink":"/hfc-pubsub/publishing/publish-diff-project","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Publish Diff Project.md","version":"current","sidebar_label":"Different GCP project","sidebarPosition":3,"frontMatter":{"id":"publish-diff-project","title":"Publishing on a Different GCP project","sidebar_label":"Different GCP project","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/publishing/attributes"},"next":{"title":"Subscription Service","permalink":"/hfc-pubsub/server/service"}},{"unversionedId":"publishing/retry-settings","id":"publishing/retry-settings","isDocsHomePage":false,"title":"Publishing a message with retry settings","description":"NOTE: This may not work right now, it is a known bug.","source":"@site/docs/publishing/Retry Settings.md","sourceDirName":"publishing","slug":"/publishing/retry-settings","permalink":"/hfc-pubsub/publishing/retry-settings","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Retry Settings.md","version":"current","sidebar_label":"Retry Settings","sidebarPosition":1,"frontMatter":{"id":"retry-settings","title":"Publishing a message with retry settings","sidebar_label":"Retry Settings","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Topics","permalink":"/hfc-pubsub/publishing/topics"},"next":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/publishing/attributes"}},{"unversionedId":"publishing/topics","id":"publishing/topics","isDocsHomePage":false,"title":"Topics","description":"Create a topic in PUBSUBROOTDIR/topics which extends Topic and a payload which extends Payload from package.","source":"@site/docs/publishing/Topics.md","sourceDirName":"publishing","slug":"/publishing/topics","permalink":"/hfc-pubsub/publishing/topics","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Topics.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"topics","title":"Topics","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/subscribing/message-ordering"},"next":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/publishing/retry-settings"}},{"unversionedId":"server/connect-database","id":"server/connect-database","isDocsHomePage":false,"title":"Connecting to a Database","description":"It is recommended to initialize a database connection in the subscription.service file in your PUBSUBROOTDIR. Insert your database connection logic in the init method.","source":"@site/docs/server/Connect Database.md","sourceDirName":"server","slug":"/server/connect-database","permalink":"/hfc-pubsub/server/connect-database","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Connect Database.md","version":"current","sidebar_label":"Connect Database","sidebarPosition":2,"frontMatter":{"id":"connect-database","title":"Connecting to a Database","sidebar_label":"Connect Database","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/server/custom-logger"},"next":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown"}},{"unversionedId":"server/custom-logger","id":"server/custom-logger","isDocsHomePage":false,"title":"Passing a Custom Logger","description":"In the main SubscriptionService before defining subscription class you can update the logger that is being used by the package for logging. It\'s an optional definition and by default it uses console.* for logging .info, .warn and .error these 3 function keys are a must have for the logger you pass.","source":"@site/docs/server/Custom Logger.md","sourceDirName":"server","slug":"/server/custom-logger","permalink":"/hfc-pubsub/server/custom-logger","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Custom Logger.md","version":"current","sidebar_label":"Custom Logger","sidebarPosition":1,"frontMatter":{"id":"custom-logger","title":"Passing a Custom Logger","sidebar_label":"Custom Logger","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscription Service","permalink":"/hfc-pubsub/server/service"},"next":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/server/connect-database"}},{"unversionedId":"server/graceful-shutdown","id":"server/graceful-shutdown","isDocsHomePage":false,"title":"Graceful Shutdown","description":"When gracefully shutting down a process, it is a good idea to first close all open subscriptions and DB connections. For this reason we have a static closeAll method in the SubscriptionService that can close all connections before shutting down. An example using it with process signal handlers:","source":"@site/docs/server/Graceful Shutdown.md","sourceDirName":"server","slug":"/server/graceful-shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Graceful Shutdown.md","version":"current","sidebarPosition":3,"frontMatter":{"id":"graceful-shutdown","title":"Graceful Shutdown","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/server/connect-database"},"next":{"title":"Health Checks","permalink":"/hfc-pubsub/server/health-check"}},{"unversionedId":"server/health-check","id":"server/health-check","isDocsHomePage":false,"title":"Health Checks","description":"For health checks and readiness probes you can enable the inbuilt health check http server by setting the following environment variables (or corresponding CLI option) :","source":"@site/docs/server/Health Check.md","sourceDirName":"server","slug":"/server/health-check","permalink":"/hfc-pubsub/server/health-check","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Health Check.md","version":"current","sidebarPosition":4,"frontMatter":{"id":"health-check","title":"Health Checks","sidebar_position":4},"sidebar":"defaultSidebar","previous":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown"},"next":{"title":"CLI","permalink":"/hfc-pubsub/guides/cli"}},{"unversionedId":"server/service","id":"server/service","isDocsHomePage":false,"title":"Subscription Service","description":"Extend and customize the behavior of the subscription server in the subscription.service file. Initialize a database connection, register subscribers, and define default subscriber options in the subscription service file.","source":"@site/docs/server/Service.md","sourceDirName":"server","slug":"/server/service","permalink":"/hfc-pubsub/server/service","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Service.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"service","title":"Subscription Service","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/publishing/publish-diff-project"},"next":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/server/custom-logger"}},{"unversionedId":"subscribing/dead-letter-policy","id":"subscribing/dead-letter-policy","isDocsHomePage":false,"title":"Subscriptions with a Dead-letter Policy","description":"It is possible to define a dead-letter policy for a subscription. If the dead letter topic does not exist, it will be created automatically by the framework.","source":"@site/docs/subscribing/Dead Letter Policy.md","sourceDirName":"subscribing","slug":"/subscribing/dead-letter-policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Dead Letter Policy.md","version":"current","sidebar_label":"Dead Letter Policy","sidebarPosition":1,"frontMatter":{"id":"dead-letter-policy","title":"Subscriptions with a Dead-letter Policy","sidebar_label":"Dead Letter Policy","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions"},"next":{"title":"Messages compression","permalink":"/hfc-pubsub/subscribing/Messages_compression"}},{"unversionedId":"subscribing/error-handling","id":"subscribing/error-handling","isDocsHomePage":false,"title":"Internal Error Handling","description":"To handle any internal error that might occur on pubsub side, the method handleError can be declared either in Subscriber Object or in SubscriptionService.","source":"@site/docs/subscribing/Internal Error Handling.md","sourceDirName":"subscribing","slug":"/subscribing/error-handling","permalink":"/hfc-pubsub/subscribing/error-handling","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Internal Error Handling.md","version":"current","sidebar_label":"Error Handling","sidebarPosition":2,"frontMatter":{"id":"error-handling","title":"Internal Error Handling","sidebar_label":"Error Handling","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Messages compression","permalink":"/hfc-pubsub/subscribing/Messages_compression"},"next":{"title":"Adding Labels","permalink":"/hfc-pubsub/subscribing/labels"}},{"unversionedId":"subscribing/labels","id":"subscribing/labels","isDocsHomePage":false,"title":"Adding Labels","description":"Global Labels","source":"@site/docs/subscribing/Labels.md","sourceDirName":"subscribing","slug":"/subscribing/labels","permalink":"/hfc-pubsub/subscribing/labels","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Labels.md","version":"current","sidebar_label":"Labels","sidebarPosition":2,"frontMatter":{"id":"labels","title":"Adding Labels","sidebar_label":"Labels","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/subscribing/error-handling"},"next":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/subscribing/retry-policy"}},{"unversionedId":"subscribing/message-ordering","id":"subscribing/message-ordering","isDocsHomePage":false,"title":"Subscription with Message Ordering","description":"Messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.","source":"@site/docs/subscribing/Message Ordering.md","sourceDirName":"subscribing","slug":"/subscribing/message-ordering","permalink":"/hfc-pubsub/subscribing/message-ordering","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Message Ordering.md","version":"current","sidebar_label":"Message Ordering","sidebarPosition":3,"frontMatter":{"id":"message-ordering","title":"Subscription with Message Ordering","sidebar_label":"Message Ordering","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/subscribing/retry-policy"},"next":{"title":"Topics","permalink":"/hfc-pubsub/publishing/topics"}},{"unversionedId":"subscribing/Messages_compression","id":"subscribing/Messages_compression","isDocsHomePage":false,"title":"Messages compression","description":"Framework supports gzip compression/decompression for messages.","source":"@site/docs/subscribing/Messages Compression.md","sourceDirName":"subscribing","slug":"/subscribing/Messages_compression","permalink":"/hfc-pubsub/subscribing/Messages_compression","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Messages Compression.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"Messages_compression","title":"Messages compression","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy"},"next":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/subscribing/error-handling"}},{"unversionedId":"subscribing/retry-policy","id":"subscribing/retry-policy","isDocsHomePage":false,"title":"Subscriptions with Retry Policy","description":"It is possible to define a retry configuration for a subscription:","source":"@site/docs/subscribing/Retry Policy.md","sourceDirName":"subscribing","slug":"/subscribing/retry-policy","permalink":"/hfc-pubsub/subscribing/retry-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Retry Policy.md","version":"current","sidebar_label":"Retry Policy","sidebarPosition":2,"frontMatter":{"id":"retry-policy","title":"Subscriptions with Retry Policy","sidebar_label":"Retry Policy","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Adding Labels","permalink":"/hfc-pubsub/subscribing/labels"},"next":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/subscribing/message-ordering"}},{"unversionedId":"subscribing/subscriptions","id":"subscribing/subscriptions","isDocsHomePage":false,"title":"Subscriptions","description":"Create a Subscriber to define a message handler for messages that are published on the corresponding topic.","source":"@site/docs/subscribing/Subscriptions.md","sourceDirName":"subscribing","slug":"/subscribing/subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Subscriptions.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"subscriptions","title":"Subscriptions","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Installation","permalink":"/hfc-pubsub/getting-started/installation"},"next":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy"}}]},{"versionName":"v1","versionLabel":"v1","versionPath":"/hfc-pubsub/v1","versionEditUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1","versionEditUrlLocalized":"https://github.com/deliveryhero/hfc-pubsub/edit/main/i18n/en/docusaurus-plugin-content-docs/version-v1","isLast":false,"sidebarFilePath":"/home/runner/work/hfc-pubsub/hfc-pubsub/versioned_sidebars/version-v1-sidebars.json","contentPath":"/home/runner/work/hfc-pubsub/hfc-pubsub/versioned_docs/version-v1","contentPathLocalized":"/home/runner/work/hfc-pubsub/hfc-pubsub/i18n/en/docusaurus-plugin-content-docs/version-v1","mainDocId":"introduction","sidebars":{"version-v1/defaultSidebar":[{"type":"doc","id":"version-v1/introduction"},{"type":"category","label":"Getting Started","items":[{"type":"doc","id":"version-v1/getting-started/installation"}],"collapsed":false},{"type":"category","label":"Subscribing","items":[{"type":"doc","id":"version-v1/subscribing/subscriptions"},{"type":"doc","id":"version-v1/subscribing/dead-letter-policy","label":"Dead Letter Policy"},{"type":"doc","id":"version-v1/subscribing/error-handling","label":"Error Handling"},{"type":"doc","id":"version-v1/subscribing/retry-policy","label":"Retry Policy"},{"type":"doc","id":"version-v1/subscribing/message-ordering","label":"Message Ordering"}],"collapsed":true},{"type":"category","label":"Publishing","items":[{"type":"doc","id":"version-v1/publishing/topics"},{"type":"doc","id":"version-v1/publishing/retry-settings","label":"Retry Settings"},{"type":"doc","id":"version-v1/publishing/attributes","label":"Attributes"},{"type":"doc","id":"version-v1/publishing/publish-diff-project","label":"Different GCP project"}],"collapsed":true},{"type":"category","label":"Server","items":[{"type":"doc","id":"version-v1/server/service"},{"type":"doc","id":"version-v1/server/custom-logger","label":"Custom Logger"},{"type":"doc","id":"version-v1/server/connect-database","label":"Connect Database"},{"type":"doc","id":"version-v1/server/graceful-shutdown"},{"type":"doc","id":"version-v1/server/health-check"}],"collapsed":true},{"type":"doc","id":"version-v1/cli"},{"type":"doc","id":"version-v1/drivers"},{"type":"doc","id":"version-v1/options"},{"type":"category","label":"Guides","items":[{"type":"doc","id":"version-v1/guides/testing"}],"collapsed":true},{"type":"category","label":"API","items":[{"type":"doc","id":"version-v1/api/index","label":"Exports"},{"type":"category","label":"Namespaces","items":[{"type":"doc","id":"version-v1/api/namespaces/Interfaces","label":"Interfaces"}],"collapsed":true},{"type":"category","label":"Classes","items":[{"type":"doc","id":"version-v1/api/classes/Message","label":"Message"},{"type":"doc","id":"version-v1/api/classes/PubSubService","label":"PubSubService"},{"type":"doc","id":"version-v1/api/classes/Subscriber","label":"Subscriber"},{"type":"doc","id":"version-v1/api/classes/SubscriptionService","label":"SubscriptionService"},{"type":"doc","id":"version-v1/api/classes/Topic","label":"Topic"}],"collapsed":true},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"version-v1/api/interfaces/Payload","label":"Payload"},{"type":"doc","id":"version-v1/api/interfaces/SubscriberOptions","label":"SubscriberOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.BackoffSettings","label":"BackoffSettings"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.GooglePubSubProject","label":"GooglePubSubProject"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.PublishOptions","label":"PublishOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.RetryConfig","label":"RetryConfig"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.TopicPublishOptions","label":"TopicPublishOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.pubSubClient","label":"pubSubClient"}],"collapsed":true}],"collapsed":true}]},"permalinkToSidebar":{"/hfc-pubsub/v1/api/classes/Message":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/PubSubService":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/Subscriber":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/SubscriptionService":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/Topic":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Payload":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/SubscriberOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/namespaces/Interfaces":"version-v1/defaultSidebar","/hfc-pubsub/v1/cli":"version-v1/defaultSidebar","/hfc-pubsub/v1/drivers":"version-v1/defaultSidebar","/hfc-pubsub/v1/getting-started/installation":"version-v1/defaultSidebar","/hfc-pubsub/v1/guides/testing":"version-v1/defaultSidebar","/hfc-pubsub/v1/":"version-v1/defaultSidebar","/hfc-pubsub/v1/options":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/attributes":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/publish-diff-project":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/retry-settings":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/topics":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/connect-database":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/custom-logger":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/graceful-shutdown":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/health-check":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/service":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/dead-letter-policy":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/error-handling":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/message-ordering":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/retry-policy":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/subscriptions":"version-v1/defaultSidebar"},"docs":[{"unversionedId":"api/classes/Message","id":"version-v1/api/classes/Message","isDocsHomePage":false,"title":"Class: Message","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/Message.md","sourceDirName":"api/classes","slug":"/api/classes/Message","permalink":"/hfc-pubsub/v1/api/classes/Message","editUrl":null,"version":"v1","sidebar_label":"Message","sidebarPosition":0,"frontMatter":{"id":"Message","title":"Class: Message","sidebar_label":"Message","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Namespace: Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces"},"next":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService"}},{"unversionedId":"api/classes/PubSubService","id":"version-v1/api/classes/PubSubService","isDocsHomePage":false,"title":"Class: PubSubService","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/PubSubService.md","sourceDirName":"api/classes","slug":"/api/classes/PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService","editUrl":null,"version":"v1","sidebar_label":"PubSubService","sidebarPosition":0,"frontMatter":{"id":"PubSubService","title":"Class: PubSubService","sidebar_label":"PubSubService","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Message","permalink":"/hfc-pubsub/v1/api/classes/Message"},"next":{"title":"Class: Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber"}},{"unversionedId":"api/classes/Subscriber","id":"version-v1/api/classes/Subscriber","isDocsHomePage":false,"title":"Class: Subscriber","description":"deprecated","source":"@site/versioned_docs/version-v1/api/classes/Subscriber.md","sourceDirName":"api/classes","slug":"/api/classes/Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber","editUrl":null,"version":"v1","sidebar_label":"Subscriber","sidebarPosition":0,"frontMatter":{"id":"Subscriber","title":"Class: Subscriber","sidebar_label":"Subscriber","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService"},"next":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService"}},{"unversionedId":"api/classes/SubscriptionService","id":"version-v1/api/classes/SubscriptionService","isDocsHomePage":false,"title":"Class: SubscriptionService","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/SubscriptionService.md","sourceDirName":"api/classes","slug":"/api/classes/SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService","editUrl":null,"version":"v1","sidebar_label":"SubscriptionService","sidebarPosition":0,"frontMatter":{"id":"SubscriptionService","title":"Class: SubscriptionService","sidebar_label":"SubscriptionService","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber"},"next":{"title":"Class: Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic"}},{"unversionedId":"api/classes/Topic","id":"version-v1/api/classes/Topic","isDocsHomePage":false,"title":"Class: Topic","description":"Implements","source":"@site/versioned_docs/version-v1/api/classes/Topic.md","sourceDirName":"api/classes","slug":"/api/classes/Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic","editUrl":null,"version":"v1","sidebar_label":"Topic","sidebarPosition":0,"frontMatter":{"id":"Topic","title":"Class: Topic","sidebar_label":"Topic","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService"},"next":{"title":"Interface: Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload"}},{"unversionedId":"api/index","id":"version-v1/api/index","isDocsHomePage":false,"title":"@honestfoodcompany/pubsub","description":"Namespaces","source":"@site/versioned_docs/version-v1/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/hfc-pubsub/v1/api/","editUrl":null,"version":"v1","sidebar_label":"Exports","sidebarPosition":0.5,"frontMatter":{"id":"index","title":"@honestfoodcompany/pubsub","slug":"/api/","sidebar_label":"Exports","sidebar_position":0.5,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Testing","permalink":"/hfc-pubsub/v1/guides/testing"},"next":{"title":"Namespace: Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces"}},{"unversionedId":"api/interfaces/Interfaces.BackoffSettings","id":"version-v1/api/interfaces/Interfaces.BackoffSettings","isDocsHomePage":false,"title":"Interface: BackoffSettings","description":"Interfaces.BackoffSettings","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.BackoffSettings.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings","editUrl":null,"version":"v1","sidebar_label":"BackoffSettings","frontMatter":{"id":"Interfaces.BackoffSettings","title":"Interface: BackoffSettings","sidebar_label":"BackoffSettings","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions"},"next":{"title":"Interface: GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject"}},{"unversionedId":"api/interfaces/Interfaces.GooglePubSubProject","id":"version-v1/api/interfaces/Interfaces.GooglePubSubProject","isDocsHomePage":false,"title":"Interface: GooglePubSubProject","description":"Interfaces.GooglePubSubProject","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.GooglePubSubProject.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject","editUrl":null,"version":"v1","sidebar_label":"GooglePubSubProject","frontMatter":{"id":"Interfaces.GooglePubSubProject","title":"Interface: GooglePubSubProject","sidebar_label":"GooglePubSubProject","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings"},"next":{"title":"Interface: PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.PublishOptions","id":"version-v1/api/interfaces/Interfaces.PublishOptions","isDocsHomePage":false,"title":"Interface: PublishOptions","description":"Interfaces.PublishOptions","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.PublishOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions","editUrl":null,"version":"v1","sidebar_label":"PublishOptions","frontMatter":{"id":"Interfaces.PublishOptions","title":"Interface: PublishOptions","sidebar_label":"PublishOptions","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject"},"next":{"title":"Interface: RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig"}},{"unversionedId":"api/interfaces/Interfaces.pubSubClient","id":"version-v1/api/interfaces/Interfaces.pubSubClient","isDocsHomePage":false,"title":"Interface: pubSubClient","description":"Interfaces.pubSubClient","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.pubSubClient.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.pubSubClient","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient","editUrl":null,"version":"v1","sidebar_label":"pubSubClient","frontMatter":{"id":"Interfaces.pubSubClient","title":"Interface: pubSubClient","sidebar_label":"pubSubClient","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.RetryConfig","id":"version-v1/api/interfaces/Interfaces.RetryConfig","isDocsHomePage":false,"title":"Interface: RetryConfig","description":"Interfaces.RetryConfig","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.RetryConfig.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig","editUrl":null,"version":"v1","sidebar_label":"RetryConfig","frontMatter":{"id":"Interfaces.RetryConfig","title":"Interface: RetryConfig","sidebar_label":"RetryConfig","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions"},"next":{"title":"Interface: TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.TopicPublishOptions","id":"version-v1/api/interfaces/Interfaces.TopicPublishOptions","isDocsHomePage":false,"title":"Interface: TopicPublishOptions","description":"Interfaces.TopicPublishOptions","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.TopicPublishOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions","editUrl":null,"version":"v1","sidebar_label":"TopicPublishOptions","frontMatter":{"id":"Interfaces.TopicPublishOptions","title":"Interface: TopicPublishOptions","sidebar_label":"TopicPublishOptions","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig"},"next":{"title":"Interface: pubSubClient","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient"}},{"unversionedId":"api/interfaces/Payload","id":"version-v1/api/interfaces/Payload","isDocsHomePage":false,"title":"Interface: Payload","description":"extend this interface to define your own payload","source":"@site/versioned_docs/version-v1/api/interfaces/Payload.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload","editUrl":null,"version":"v1","sidebar_label":"Payload","sidebarPosition":0,"frontMatter":{"id":"Payload","title":"Interface: Payload","sidebar_label":"Payload","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic"},"next":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions"}},{"unversionedId":"api/interfaces/SubscriberOptions","id":"version-v1/api/interfaces/SubscriberOptions","isDocsHomePage":false,"title":"Interface: SubscriberOptions","description":"Hierarchy","source":"@site/versioned_docs/version-v1/api/interfaces/SubscriberOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions","editUrl":null,"version":"v1","sidebar_label":"SubscriberOptions","sidebarPosition":0,"frontMatter":{"id":"SubscriberOptions","title":"Interface: SubscriberOptions","sidebar_label":"SubscriberOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload"},"next":{"title":"Interface: BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings"}},{"unversionedId":"api/namespaces/Interfaces","id":"version-v1/api/namespaces/Interfaces","isDocsHomePage":false,"title":"Namespace: Interfaces","description":"Interfaces","source":"@site/versioned_docs/version-v1/api/namespaces/Interfaces.md","sourceDirName":"api/namespaces","slug":"/api/namespaces/Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces","editUrl":null,"version":"v1","sidebar_label":"Interfaces","sidebarPosition":0,"frontMatter":{"id":"Interfaces","title":"Namespace: Interfaces","sidebar_label":"Interfaces","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/v1/api/"},"next":{"title":"Class: Message","permalink":"/hfc-pubsub/v1/api/classes/Message"}},{"unversionedId":"cli","id":"version-v1/cli","isDocsHomePage":false,"title":"CLI","description":"Prerequisites npm i -g npx","source":"@site/versioned_docs/version-v1/CLI.md","sourceDirName":".","slug":"/cli","permalink":"/hfc-pubsub/v1/cli","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/CLI.md","version":"v1","sidebarPosition":5,"frontMatter":{"id":"cli","title":"CLI","sidebar_position":5},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Health Checks","permalink":"/hfc-pubsub/v1/server/health-check"},"next":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/v1/drivers"}},{"unversionedId":"drivers","id":"version-v1/drivers","isDocsHomePage":false,"title":"PubSub Drivers","description":"Google PubSub Driver","source":"@site/versioned_docs/version-v1/Drivers.md","sourceDirName":".","slug":"/drivers","permalink":"/hfc-pubsub/v1/drivers","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Drivers.md","version":"v1","sidebarPosition":5,"frontMatter":{"id":"drivers","title":"PubSub Drivers","sidebar_position":5},"sidebar":"version-v1/defaultSidebar","previous":{"title":"CLI","permalink":"/hfc-pubsub/v1/cli"},"next":{"title":"Other Options","permalink":"/hfc-pubsub/v1/options"}},{"unversionedId":"getting-started/installation","id":"version-v1/getting-started/installation","isDocsHomePage":false,"title":"Installation","description":"Requirements","source":"@site/versioned_docs/version-v1/getting-started/Installation.md","sourceDirName":"getting-started","slug":"/getting-started/installation","permalink":"/hfc-pubsub/v1/getting-started/installation","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/getting-started/Installation.md","version":"v1","sidebarPosition":1,"frontMatter":{"id":"installation","title":"Installation","slug":"/getting-started/installation","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Introduction","permalink":"/hfc-pubsub/v1/"},"next":{"title":"Subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions"}},{"unversionedId":"guides/testing","id":"version-v1/guides/testing","isDocsHomePage":false,"title":"Testing","description":"Unit Tests","source":"@site/versioned_docs/version-v1/guides/Testing.md","sourceDirName":"guides","slug":"/guides/testing","permalink":"/hfc-pubsub/v1/guides/testing","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/guides/Testing.md","version":"v1","sidebarPosition":2,"frontMatter":{"id":"testing","title":"Testing","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Other Options","permalink":"/hfc-pubsub/v1/options"},"next":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/v1/api/"}},{"unversionedId":"introduction","id":"version-v1/introduction","isDocsHomePage":false,"title":"Introduction","description":"@honestfoodcompany/pubsub","source":"@site/versioned_docs/version-v1/Introduction.md","sourceDirName":".","slug":"/","permalink":"/hfc-pubsub/v1/","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Introduction.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"introduction","title":"Introduction","sidebar_position":0,"slug":"/"},"sidebar":"version-v1/defaultSidebar","next":{"title":"Installation","permalink":"/hfc-pubsub/v1/getting-started/installation"}},{"unversionedId":"options","id":"version-v1/options","isDocsHomePage":false,"title":"Other Options","description":"Enabling gRPC C++ bindings","source":"@site/versioned_docs/version-v1/Options.md","sourceDirName":".","slug":"/options","permalink":"/hfc-pubsub/v1/options","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Options.md","version":"v1","sidebarPosition":6,"frontMatter":{"id":"options","title":"Other Options","sidebar_position":6},"sidebar":"version-v1/defaultSidebar","previous":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/v1/drivers"},"next":{"title":"Testing","permalink":"/hfc-pubsub/v1/guides/testing"}},{"unversionedId":"publishing/attributes","id":"version-v1/publishing/attributes","isDocsHomePage":false,"title":"Publishing with Attributes","description":"See:","source":"@site/versioned_docs/version-v1/publishing/Attributes.md","sourceDirName":"publishing","slug":"/publishing/attributes","permalink":"/hfc-pubsub/v1/publishing/attributes","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Attributes.md","version":"v1","sidebar_label":"Attributes","sidebarPosition":2,"frontMatter":{"id":"attributes","title":"Publishing with Attributes","sidebar_label":"Attributes","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings"},"next":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project"}},{"unversionedId":"publishing/publish-diff-project","id":"version-v1/publishing/publish-diff-project","isDocsHomePage":false,"title":"Publishing on a Different GCP project","description":"`ts title=\\"/pubsub/topics/example-topic-with-customCredentials.ts\\"","source":"@site/versioned_docs/version-v1/publishing/Publish Diff Project.md","sourceDirName":"publishing","slug":"/publishing/publish-diff-project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Publish Diff Project.md","version":"v1","sidebar_label":"Different GCP project","sidebarPosition":3,"frontMatter":{"id":"publish-diff-project","title":"Publishing on a Different GCP project","sidebar_label":"Different GCP project","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/v1/publishing/attributes"},"next":{"title":"Subscription Service","permalink":"/hfc-pubsub/v1/server/service"}},{"unversionedId":"publishing/retry-settings","id":"version-v1/publishing/retry-settings","isDocsHomePage":false,"title":"Publishing a message with retry settings","description":"NOTE: This may not work right now, it is a known bug.","source":"@site/versioned_docs/version-v1/publishing/Retry Settings.md","sourceDirName":"publishing","slug":"/publishing/retry-settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Retry Settings.md","version":"v1","sidebar_label":"Retry Settings","sidebarPosition":1,"frontMatter":{"id":"retry-settings","title":"Publishing a message with retry settings","sidebar_label":"Retry Settings","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Topics","permalink":"/hfc-pubsub/v1/publishing/topics"},"next":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/v1/publishing/attributes"}},{"unversionedId":"publishing/topics","id":"version-v1/publishing/topics","isDocsHomePage":false,"title":"Topics","description":"Create a topic in PUBSUBROOTDIR/topics which extends Topic and a payload which extends Payload from package.","source":"@site/versioned_docs/version-v1/publishing/Topics.md","sourceDirName":"publishing","slug":"/publishing/topics","permalink":"/hfc-pubsub/v1/publishing/topics","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Topics.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"topics","title":"Topics","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering"},"next":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings"}},{"unversionedId":"server/connect-database","id":"version-v1/server/connect-database","isDocsHomePage":false,"title":"Connecting to a Database","description":"It is recommended to initialize a database connection in the subscription.service file in your PUBSUBROOTDIR. Insert your database connection logic in the init method.","source":"@site/versioned_docs/version-v1/server/Connect Database.md","sourceDirName":"server","slug":"/server/connect-database","permalink":"/hfc-pubsub/v1/server/connect-database","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Connect Database.md","version":"v1","sidebar_label":"Connect Database","sidebarPosition":2,"frontMatter":{"id":"connect-database","title":"Connecting to a Database","sidebar_label":"Connect Database","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/v1/server/custom-logger"},"next":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown"}},{"unversionedId":"server/custom-logger","id":"version-v1/server/custom-logger","isDocsHomePage":false,"title":"Passing a Custom Logger","description":"In the main SubscriptionService before defining subscription class you can update the logger that is being used by the package for logging. It\'s an optional definition and by default it uses console.* for logging .info, .warn and .error these 3 function keys are a must have for the logger you pass.","source":"@site/versioned_docs/version-v1/server/Custom Logger.md","sourceDirName":"server","slug":"/server/custom-logger","permalink":"/hfc-pubsub/v1/server/custom-logger","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Custom Logger.md","version":"v1","sidebar_label":"Custom Logger","sidebarPosition":1,"frontMatter":{"id":"custom-logger","title":"Passing a Custom Logger","sidebar_label":"Custom Logger","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscription Service","permalink":"/hfc-pubsub/v1/server/service"},"next":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/v1/server/connect-database"}},{"unversionedId":"server/graceful-shutdown","id":"version-v1/server/graceful-shutdown","isDocsHomePage":false,"title":"Graceful Shutdown","description":"When gracefully shutting down a process, it is a good idea to first close all open subscriptions and DB connections. For this reason we have a static closeAll method in the SubscriptionService that can close all connections before shutting down. An example using it with process signal handlers:","source":"@site/versioned_docs/version-v1/server/Graceful Shutdown.md","sourceDirName":"server","slug":"/server/graceful-shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Graceful Shutdown.md","version":"v1","sidebarPosition":3,"frontMatter":{"id":"graceful-shutdown","title":"Graceful Shutdown","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/v1/server/connect-database"},"next":{"title":"Health Checks","permalink":"/hfc-pubsub/v1/server/health-check"}},{"unversionedId":"server/health-check","id":"version-v1/server/health-check","isDocsHomePage":false,"title":"Health Checks","description":"For health checks and readiness probes you can enable the inbuilt health check http server by setting the following environemnt variables (or corresponding CLI option) :","source":"@site/versioned_docs/version-v1/server/Health Check.md","sourceDirName":"server","slug":"/server/health-check","permalink":"/hfc-pubsub/v1/server/health-check","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Health Check.md","version":"v1","sidebarPosition":4,"frontMatter":{"id":"health-check","title":"Health Checks","sidebar_position":4},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown"},"next":{"title":"CLI","permalink":"/hfc-pubsub/v1/cli"}},{"unversionedId":"server/service","id":"version-v1/server/service","isDocsHomePage":false,"title":"Subscription Service","description":"Extend and customize the behavior of the subscription server in the subscription.service file. Initialize a database connection, register subscribers, and define default subscriber options in the subscription service file.","source":"@site/versioned_docs/version-v1/server/Service.md","sourceDirName":"server","slug":"/server/service","permalink":"/hfc-pubsub/v1/server/service","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Service.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"service","title":"Subscription Service","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project"},"next":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/v1/server/custom-logger"}},{"unversionedId":"subscribing/dead-letter-policy","id":"version-v1/subscribing/dead-letter-policy","isDocsHomePage":false,"title":"Subscriptions with a Dead-letter Policy","description":"It is possible to define a dead-letter policy for a subscription. If the dead letter topic does not exist, it will be created automatically by the framework.","source":"@site/versioned_docs/version-v1/subscribing/Dead Letter Policy.md","sourceDirName":"subscribing","slug":"/subscribing/dead-letter-policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Dead Letter Policy.md","version":"v1","sidebar_label":"Dead Letter Policy","sidebarPosition":1,"frontMatter":{"id":"dead-letter-policy","title":"Subscriptions with a Dead-letter Policy","sidebar_label":"Dead Letter Policy","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions"},"next":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling"}},{"unversionedId":"subscribing/error-handling","id":"version-v1/subscribing/error-handling","isDocsHomePage":false,"title":"Internal Error Handling","description":"To handle any internal error that might occur on pubsub side, a the method handleError can be declared either in Subscriber Object or in SubscriptionService level.","source":"@site/versioned_docs/version-v1/subscribing/Internal Error Handling.md","sourceDirName":"subscribing","slug":"/subscribing/error-handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Internal Error Handling.md","version":"v1","sidebar_label":"Error Handling","sidebarPosition":2,"frontMatter":{"id":"error-handling","title":"Internal Error Handling","sidebar_label":"Error Handling","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy"},"next":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy"}},{"unversionedId":"subscribing/message-ordering","id":"version-v1/subscribing/message-ordering","isDocsHomePage":false,"title":"Subscription with Message Ordering","description":"Messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.","source":"@site/versioned_docs/version-v1/subscribing/Message Ordering.md","sourceDirName":"subscribing","slug":"/subscribing/message-ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Message Ordering.md","version":"v1","sidebar_label":"Message Ordering","sidebarPosition":3,"frontMatter":{"id":"message-ordering","title":"Subscription with Message Ordering","sidebar_label":"Message Ordering","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy"},"next":{"title":"Topics","permalink":"/hfc-pubsub/v1/publishing/topics"}},{"unversionedId":"subscribing/retry-policy","id":"version-v1/subscribing/retry-policy","isDocsHomePage":false,"title":"Subscriptions with Retry Policy","description":"It is possible to define a retry configuration for a subscription:","source":"@site/versioned_docs/version-v1/subscribing/Retry Policy.md","sourceDirName":"subscribing","slug":"/subscribing/retry-policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Retry Policy.md","version":"v1","sidebar_label":"Retry Policy","sidebarPosition":2,"frontMatter":{"id":"retry-policy","title":"Subscriptions with Retry Policy","sidebar_label":"Retry Policy","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling"},"next":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering"}},{"unversionedId":"subscribing/subscriptions","id":"version-v1/subscribing/subscriptions","isDocsHomePage":false,"title":"Subscriptions","description":"Create a Subscriber to define a message handler for messages that are published on the corresponding topic.","source":"@site/versioned_docs/version-v1/subscribing/Subscriptions.md","sourceDirName":"subscribing","slug":"/subscribing/subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Subscriptions.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"subscriptions","title":"Subscriptions","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Installation","permalink":"/hfc-pubsub/v1/getting-started/installation"},"next":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy"}}]}]}},"docusaurus-plugin-content-blog":{"default":null},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{"default":null},"docusaurus-plugin-sitemap":{"default":null},"docusaurus-theme-classic":{"default":null},"undefined":{"default":null}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[9285],{6267:e=>{e.exports=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","versionLabel":"v2","versionPath":"/hfc-pubsub/","versionEditUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs","versionEditUrlLocalized":"https://github.com/deliveryhero/hfc-pubsub/edit/main/i18n/en/docusaurus-plugin-content-docs/current","isLast":true,"routePriority":-1,"contentPath":"/home/runner/work/hfc-pubsub/hfc-pubsub/docs","contentPathLocalized":"/home/runner/work/hfc-pubsub/hfc-pubsub/i18n/en/docusaurus-plugin-content-docs/current","mainDocId":"introduction","sidebars":{"defaultSidebar":[{"type":"doc","id":"introduction"},{"type":"category","label":"Getting Started","items":[{"type":"doc","id":"getting-started/installation"}],"collapsed":false},{"type":"category","label":"Subscribing","items":[{"type":"doc","id":"subscribing/subscriptions"},{"type":"doc","id":"subscribing/dead-letter-policy","label":"Dead Letter Policy"},{"type":"doc","id":"subscribing/Messages_compression"},{"type":"doc","id":"subscribing/error-handling","label":"Error Handling"},{"type":"doc","id":"subscribing/labels","label":"Labels"},{"type":"doc","id":"subscribing/retry-policy","label":"Retry Policy"},{"type":"doc","id":"subscribing/message-ordering","label":"Message Ordering"}],"collapsed":true},{"type":"category","label":"Publishing","items":[{"type":"doc","id":"publishing/topics"},{"type":"doc","id":"publishing/retry-settings","label":"Retry Settings"},{"type":"doc","id":"publishing/attributes","label":"Attributes"},{"type":"doc","id":"publishing/publish-diff-project","label":"Different GCP project"}],"collapsed":true},{"type":"category","label":"Server","items":[{"type":"doc","id":"server/service"},{"type":"doc","id":"server/custom-logger","label":"Custom Logger"},{"type":"doc","id":"server/connect-database","label":"Connect Database"},{"type":"doc","id":"server/graceful-shutdown"},{"type":"doc","id":"server/health-check"}],"collapsed":true},{"type":"category","label":"Guides","items":[{"type":"doc","id":"guides/cli"},{"type":"doc","id":"guides/drivers"},{"type":"doc","id":"guides/migrating-to-v2"},{"type":"doc","id":"guides/testing"}],"collapsed":true},{"type":"doc","id":"options"},{"type":"category","label":"API","items":[{"type":"doc","id":"api/index","label":"Exports"},{"type":"category","label":"Classes","items":[{"type":"doc","id":"api/classes/Message","label":"Message"},{"type":"doc","id":"api/classes/PubSubService","label":"PubSubService"},{"type":"doc","id":"api/classes/SubscriptionService","label":"SubscriptionService"},{"type":"doc","id":"api/classes/Topic","label":"Topic"}],"collapsed":true},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"api/interfaces/Payload","label":"Payload"},{"type":"doc","id":"api/interfaces/SubscriberMetadata","label":"SubscriberMetadata"},{"type":"doc","id":"api/interfaces/SubscriberObject","label":"SubscriberObject"},{"type":"doc","id":"api/interfaces/SubscriberOptions","label":"SubscriberOptions"},{"type":"doc","id":"api/interfaces/TopicOptions","label":"TopicOptions"}],"collapsed":true}],"collapsed":true},{"type":"doc","id":"changelog"}]},"permalinkToSidebar":{"/hfc-pubsub/api/classes/Message":"defaultSidebar","/hfc-pubsub/api/classes/PubSubService":"defaultSidebar","/hfc-pubsub/api/classes/SubscriptionService":"defaultSidebar","/hfc-pubsub/api/classes/Topic":"defaultSidebar","/hfc-pubsub/api/":"defaultSidebar","/hfc-pubsub/api/interfaces/Payload":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberMetadata":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberObject":"defaultSidebar","/hfc-pubsub/api/interfaces/SubscriberOptions":"defaultSidebar","/hfc-pubsub/api/interfaces/TopicOptions":"defaultSidebar","/hfc-pubsub/changelog":"defaultSidebar","/hfc-pubsub/getting-started/installation":"defaultSidebar","/hfc-pubsub/guides/cli":"defaultSidebar","/hfc-pubsub/guides/drivers":"defaultSidebar","/hfc-pubsub/guides/migrating-to-v2":"defaultSidebar","/hfc-pubsub/guides/testing":"defaultSidebar","/hfc-pubsub/":"defaultSidebar","/hfc-pubsub/options":"defaultSidebar","/hfc-pubsub/publishing/attributes":"defaultSidebar","/hfc-pubsub/publishing/publish-diff-project":"defaultSidebar","/hfc-pubsub/publishing/retry-settings":"defaultSidebar","/hfc-pubsub/publishing/topics":"defaultSidebar","/hfc-pubsub/server/connect-database":"defaultSidebar","/hfc-pubsub/server/custom-logger":"defaultSidebar","/hfc-pubsub/server/graceful-shutdown":"defaultSidebar","/hfc-pubsub/server/health-check":"defaultSidebar","/hfc-pubsub/server/service":"defaultSidebar","/hfc-pubsub/subscribing/dead-letter-policy":"defaultSidebar","/hfc-pubsub/subscribing/error-handling":"defaultSidebar","/hfc-pubsub/subscribing/labels":"defaultSidebar","/hfc-pubsub/subscribing/message-ordering":"defaultSidebar","/hfc-pubsub/subscribing/Messages_compression":"defaultSidebar","/hfc-pubsub/subscribing/retry-policy":"defaultSidebar","/hfc-pubsub/subscribing/subscriptions":"defaultSidebar"},"docs":[{"unversionedId":"api/classes/Message","id":"api/classes/Message","isDocsHomePage":false,"title":"Class: Message","description":"Type parameters","source":"@site/docs/api/classes/Message.md","sourceDirName":"api/classes","slug":"/api/classes/Message","permalink":"/hfc-pubsub/api/classes/Message","editUrl":null,"version":"current","sidebar_label":"Message","sidebarPosition":0,"frontMatter":{"id":"Message","title":"Class: Message","sidebar_label":"Message","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/api/"},"next":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService"}},{"unversionedId":"api/classes/PubSubService","id":"api/classes/PubSubService","isDocsHomePage":false,"title":"Class: PubSubService","description":"Properties","source":"@site/docs/api/classes/PubSubService.md","sourceDirName":"api/classes","slug":"/api/classes/PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService","editUrl":null,"version":"current","sidebar_label":"PubSubService","sidebarPosition":0,"frontMatter":{"id":"PubSubService","title":"Class: PubSubService","sidebar_label":"PubSubService","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: Message","permalink":"/hfc-pubsub/api/classes/Message"},"next":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService"}},{"unversionedId":"api/classes/SubscriptionService","id":"api/classes/SubscriptionService","isDocsHomePage":false,"title":"Class: SubscriptionService","description":"Constructors","source":"@site/docs/api/classes/SubscriptionService.md","sourceDirName":"api/classes","slug":"/api/classes/SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService","editUrl":null,"version":"current","sidebar_label":"SubscriptionService","sidebarPosition":0,"frontMatter":{"id":"SubscriptionService","title":"Class: SubscriptionService","sidebar_label":"SubscriptionService","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/api/classes/PubSubService"},"next":{"title":"Class: Topic

","permalink":"/hfc-pubsub/api/classes/Topic"}},{"unversionedId":"api/classes/Topic","id":"api/classes/Topic","isDocsHomePage":false,"title":"Class: Topic

","description":"Type parameters","source":"@site/docs/api/classes/Topic.md","sourceDirName":"api/classes","slug":"/api/classes/Topic","permalink":"/hfc-pubsub/api/classes/Topic","editUrl":null,"version":"current","sidebar_label":"Topic","sidebarPosition":0,"frontMatter":{"id":"Topic","title":"Class: Topic

","sidebar_label":"Topic","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/api/classes/SubscriptionService"},"next":{"title":"Interface: Payload","permalink":"/hfc-pubsub/api/interfaces/Payload"}},{"unversionedId":"api/index","id":"api/index","isDocsHomePage":false,"title":"@honestfoodcompany/pubsub","description":"Classes","source":"@site/docs/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/hfc-pubsub/api/","editUrl":null,"version":"current","sidebar_label":"Exports","sidebarPosition":0.5,"frontMatter":{"id":"index","title":"@honestfoodcompany/pubsub","slug":"/api/","sidebar_label":"Exports","sidebar_position":0.5,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Other Options","permalink":"/hfc-pubsub/options"},"next":{"title":"Class: Message","permalink":"/hfc-pubsub/api/classes/Message"}},{"unversionedId":"api/interfaces/Payload","id":"api/interfaces/Payload","isDocsHomePage":false,"title":"Interface: Payload","description":"extend this interface to define your own payload","source":"@site/docs/api/interfaces/Payload.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Payload","permalink":"/hfc-pubsub/api/interfaces/Payload","editUrl":null,"version":"current","sidebar_label":"Payload","sidebarPosition":0,"frontMatter":{"id":"Payload","title":"Interface: Payload","sidebar_label":"Payload","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Class: Topic

","permalink":"/hfc-pubsub/api/classes/Topic"},"next":{"title":"Interface: SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata"}},{"unversionedId":"api/interfaces/SubscriberMetadata","id":"api/interfaces/SubscriberMetadata","isDocsHomePage":false,"title":"Interface: SubscriberMetadata","description":"Properties","source":"@site/docs/api/interfaces/SubscriberMetadata.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata","editUrl":null,"version":"current","sidebar_label":"SubscriberMetadata","sidebarPosition":0,"frontMatter":{"id":"SubscriberMetadata","title":"Interface: SubscriberMetadata","sidebar_label":"SubscriberMetadata","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: Payload","permalink":"/hfc-pubsub/api/interfaces/Payload"},"next":{"title":"Interface: SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject"}},{"unversionedId":"api/interfaces/SubscriberObject","id":"api/interfaces/SubscriberObject","isDocsHomePage":false,"title":"Interface: SubscriberObject","description":"Type parameters","source":"@site/docs/api/interfaces/SubscriberObject.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject","editUrl":null,"version":"current","sidebar_label":"SubscriberObject","sidebarPosition":0,"frontMatter":{"id":"SubscriberObject","title":"Interface: SubscriberObject","sidebar_label":"SubscriberObject","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberMetadata","permalink":"/hfc-pubsub/api/interfaces/SubscriberMetadata"},"next":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions"}},{"unversionedId":"api/interfaces/SubscriberOptions","id":"api/interfaces/SubscriberOptions","isDocsHomePage":false,"title":"Interface: SubscriberOptions","description":"Hierarchy","source":"@site/docs/api/interfaces/SubscriberOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions","editUrl":null,"version":"current","sidebar_label":"SubscriberOptions","sidebarPosition":0,"frontMatter":{"id":"SubscriberOptions","title":"Interface: SubscriberOptions","sidebar_label":"SubscriberOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberObject","permalink":"/hfc-pubsub/api/interfaces/SubscriberObject"},"next":{"title":"Interface: TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions"}},{"unversionedId":"api/interfaces/TopicOptions","id":"api/interfaces/TopicOptions","isDocsHomePage":false,"title":"Interface: TopicOptions","description":"Properties","source":"@site/docs/api/interfaces/TopicOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions","editUrl":null,"version":"current","sidebar_label":"TopicOptions","sidebarPosition":0,"frontMatter":{"id":"TopicOptions","title":"Interface: TopicOptions","sidebar_label":"TopicOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"defaultSidebar","previous":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/api/interfaces/SubscriberOptions"},"next":{"title":"Changelog","permalink":"/hfc-pubsub/changelog"}},{"unversionedId":"changelog","id":"changelog","isDocsHomePage":false,"title":"Changelog","description":"2.3.0","source":"@site/docs/changelog.md","sourceDirName":".","slug":"/changelog","permalink":"/hfc-pubsub/changelog","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/changelog.md","version":"current","frontMatter":{},"sidebar":"defaultSidebar","previous":{"title":"Interface: TopicOptions","permalink":"/hfc-pubsub/api/interfaces/TopicOptions"}},{"unversionedId":"getting-started/installation","id":"getting-started/installation","isDocsHomePage":false,"title":"Installation","description":"Requirements","source":"@site/docs/getting-started/Installation.md","sourceDirName":"getting-started","slug":"/getting-started/installation","permalink":"/hfc-pubsub/getting-started/installation","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/getting-started/Installation.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"installation","title":"Installation","slug":"/getting-started/installation","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Introduction","permalink":"/hfc-pubsub/"},"next":{"title":"Subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions"}},{"unversionedId":"guides/cli","id":"guides/cli","isDocsHomePage":false,"title":"CLI","description":"Prerequisites npm i -g npx","source":"@site/docs/guides/CLI.md","sourceDirName":"guides","slug":"/guides/cli","permalink":"/hfc-pubsub/guides/cli","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/CLI.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"cli","title":"CLI","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Health Checks","permalink":"/hfc-pubsub/server/health-check"},"next":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/guides/drivers"}},{"unversionedId":"guides/drivers","id":"guides/drivers","isDocsHomePage":false,"title":"PubSub Drivers","description":"Google PubSub Driver","source":"@site/docs/guides/Drivers.md","sourceDirName":"guides","slug":"/guides/drivers","permalink":"/hfc-pubsub/guides/drivers","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Drivers.md","version":"current","sidebarPosition":2,"frontMatter":{"id":"drivers","title":"PubSub Drivers","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"CLI","permalink":"/hfc-pubsub/guides/cli"},"next":{"title":"Migrating to v2","permalink":"/hfc-pubsub/guides/migrating-to-v2"}},{"unversionedId":"guides/migrating-to-v2","id":"guides/migrating-to-v2","isDocsHomePage":false,"title":"Migrating to v2","description":"We simplified and improved the experience of using PubSub Framework (especially for Typescript users) in v2, that meant changing the way we do a few things.","source":"@site/docs/guides/Migrating to v2.mdx","sourceDirName":"guides","slug":"/guides/migrating-to-v2","permalink":"/hfc-pubsub/guides/migrating-to-v2","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Migrating to v2.mdx","version":"current","sidebarPosition":3,"frontMatter":{"id":"migrating-to-v2","title":"Migrating to v2","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/guides/drivers"},"next":{"title":"Testing","permalink":"/hfc-pubsub/guides/testing"}},{"unversionedId":"guides/testing","id":"guides/testing","isDocsHomePage":false,"title":"Testing","description":"Unit Tests","source":"@site/docs/guides/Testing.md","sourceDirName":"guides","slug":"/guides/testing","permalink":"/hfc-pubsub/guides/testing","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/guides/Testing.md","version":"current","sidebarPosition":4,"frontMatter":{"id":"testing","title":"Testing","sidebar_position":4},"sidebar":"defaultSidebar","previous":{"title":"Migrating to v2","permalink":"/hfc-pubsub/guides/migrating-to-v2"},"next":{"title":"Other Options","permalink":"/hfc-pubsub/options"}},{"unversionedId":"introduction","id":"introduction","isDocsHomePage":false,"title":"Introduction","description":"@honestfoodcompany/pubsub","source":"@site/docs/Introduction.md","sourceDirName":".","slug":"/","permalink":"/hfc-pubsub/","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/Introduction.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"introduction","title":"Introduction","sidebar_position":0,"slug":"/"},"sidebar":"defaultSidebar","next":{"title":"Installation","permalink":"/hfc-pubsub/getting-started/installation"}},{"unversionedId":"options","id":"options","isDocsHomePage":false,"title":"Other Options","description":"","source":"@site/docs/Options.md","sourceDirName":".","slug":"/options","permalink":"/hfc-pubsub/options","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/Options.md","version":"current","sidebarPosition":6,"frontMatter":{"id":"options","title":"Other Options","sidebar_position":6},"sidebar":"defaultSidebar","previous":{"title":"Testing","permalink":"/hfc-pubsub/guides/testing"},"next":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/api/"}},{"unversionedId":"publishing/attributes","id":"publishing/attributes","isDocsHomePage":false,"title":"Publishing with Attributes","description":"See:","source":"@site/docs/publishing/Attributes.md","sourceDirName":"publishing","slug":"/publishing/attributes","permalink":"/hfc-pubsub/publishing/attributes","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Attributes.md","version":"current","sidebar_label":"Attributes","sidebarPosition":2,"frontMatter":{"id":"attributes","title":"Publishing with Attributes","sidebar_label":"Attributes","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/publishing/retry-settings"},"next":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/publishing/publish-diff-project"}},{"unversionedId":"publishing/publish-diff-project","id":"publishing/publish-diff-project","isDocsHomePage":false,"title":"Publishing on a Different GCP project","description":"`ts title=\\"/pubsub/topics/example-topic-with-custom-credentials.ts\\"","source":"@site/docs/publishing/Publish Diff Project.md","sourceDirName":"publishing","slug":"/publishing/publish-diff-project","permalink":"/hfc-pubsub/publishing/publish-diff-project","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Publish Diff Project.md","version":"current","sidebar_label":"Different GCP project","sidebarPosition":3,"frontMatter":{"id":"publish-diff-project","title":"Publishing on a Different GCP project","sidebar_label":"Different GCP project","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/publishing/attributes"},"next":{"title":"Subscription Service","permalink":"/hfc-pubsub/server/service"}},{"unversionedId":"publishing/retry-settings","id":"publishing/retry-settings","isDocsHomePage":false,"title":"Publishing a message with retry settings","description":"NOTE: This may not work right now, it is a known bug.","source":"@site/docs/publishing/Retry Settings.md","sourceDirName":"publishing","slug":"/publishing/retry-settings","permalink":"/hfc-pubsub/publishing/retry-settings","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Retry Settings.md","version":"current","sidebar_label":"Retry Settings","sidebarPosition":1,"frontMatter":{"id":"retry-settings","title":"Publishing a message with retry settings","sidebar_label":"Retry Settings","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Topics","permalink":"/hfc-pubsub/publishing/topics"},"next":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/publishing/attributes"}},{"unversionedId":"publishing/topics","id":"publishing/topics","isDocsHomePage":false,"title":"Topics","description":"Create a topic in PUBSUBROOTDIR/topics which extends Topic and a payload which extends Payload from package.","source":"@site/docs/publishing/Topics.md","sourceDirName":"publishing","slug":"/publishing/topics","permalink":"/hfc-pubsub/publishing/topics","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/publishing/Topics.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"topics","title":"Topics","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/subscribing/message-ordering"},"next":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/publishing/retry-settings"}},{"unversionedId":"server/connect-database","id":"server/connect-database","isDocsHomePage":false,"title":"Connecting to a Database","description":"It is recommended to initialize a database connection in the subscription.service file in your PUBSUBROOTDIR. Insert your database connection logic in the init method.","source":"@site/docs/server/Connect Database.md","sourceDirName":"server","slug":"/server/connect-database","permalink":"/hfc-pubsub/server/connect-database","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Connect Database.md","version":"current","sidebar_label":"Connect Database","sidebarPosition":2,"frontMatter":{"id":"connect-database","title":"Connecting to a Database","sidebar_label":"Connect Database","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/server/custom-logger"},"next":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown"}},{"unversionedId":"server/custom-logger","id":"server/custom-logger","isDocsHomePage":false,"title":"Passing a Custom Logger","description":"In the main SubscriptionService before defining subscription class you can update the logger that is being used by the package for logging. It\'s an optional definition and by default it uses console.* for logging .info, .warn and .error these 3 function keys are a must have for the logger you pass.","source":"@site/docs/server/Custom Logger.md","sourceDirName":"server","slug":"/server/custom-logger","permalink":"/hfc-pubsub/server/custom-logger","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Custom Logger.md","version":"current","sidebar_label":"Custom Logger","sidebarPosition":1,"frontMatter":{"id":"custom-logger","title":"Passing a Custom Logger","sidebar_label":"Custom Logger","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscription Service","permalink":"/hfc-pubsub/server/service"},"next":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/server/connect-database"}},{"unversionedId":"server/graceful-shutdown","id":"server/graceful-shutdown","isDocsHomePage":false,"title":"Graceful Shutdown","description":"When gracefully shutting down a process, it is a good idea to first close all open subscriptions and DB connections. For this reason we have a static closeAll method in the SubscriptionService that can close all connections before shutting down. An example using it with process signal handlers:","source":"@site/docs/server/Graceful Shutdown.md","sourceDirName":"server","slug":"/server/graceful-shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Graceful Shutdown.md","version":"current","sidebarPosition":3,"frontMatter":{"id":"graceful-shutdown","title":"Graceful Shutdown","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/server/connect-database"},"next":{"title":"Health Checks","permalink":"/hfc-pubsub/server/health-check"}},{"unversionedId":"server/health-check","id":"server/health-check","isDocsHomePage":false,"title":"Health Checks","description":"For health checks and readiness probes you can enable the inbuilt health check http server by setting the following environment variables (or corresponding CLI option) :","source":"@site/docs/server/Health Check.md","sourceDirName":"server","slug":"/server/health-check","permalink":"/hfc-pubsub/server/health-check","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Health Check.md","version":"current","sidebarPosition":4,"frontMatter":{"id":"health-check","title":"Health Checks","sidebar_position":4},"sidebar":"defaultSidebar","previous":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/server/graceful-shutdown"},"next":{"title":"CLI","permalink":"/hfc-pubsub/guides/cli"}},{"unversionedId":"server/service","id":"server/service","isDocsHomePage":false,"title":"Subscription Service","description":"Extend and customize the behavior of the subscription server in the subscription.service file. Initialize a database connection, register subscribers, and define default subscriber options in the subscription service file.","source":"@site/docs/server/Service.md","sourceDirName":"server","slug":"/server/service","permalink":"/hfc-pubsub/server/service","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/server/Service.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"service","title":"Subscription Service","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/publishing/publish-diff-project"},"next":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/server/custom-logger"}},{"unversionedId":"subscribing/dead-letter-policy","id":"subscribing/dead-letter-policy","isDocsHomePage":false,"title":"Subscriptions with a Dead-letter Policy","description":"It is possible to define a dead-letter policy for a subscription. If the dead letter topic does not exist, it will be created automatically by the framework.","source":"@site/docs/subscribing/Dead Letter Policy.md","sourceDirName":"subscribing","slug":"/subscribing/dead-letter-policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Dead Letter Policy.md","version":"current","sidebar_label":"Dead Letter Policy","sidebarPosition":1,"frontMatter":{"id":"dead-letter-policy","title":"Subscriptions with a Dead-letter Policy","sidebar_label":"Dead Letter Policy","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions"},"next":{"title":"Messages compression","permalink":"/hfc-pubsub/subscribing/Messages_compression"}},{"unversionedId":"subscribing/error-handling","id":"subscribing/error-handling","isDocsHomePage":false,"title":"Internal Error Handling","description":"To handle any internal error that might occur on pubsub side, the method handleError can be declared either in Subscriber Object or in SubscriptionService.","source":"@site/docs/subscribing/Internal Error Handling.md","sourceDirName":"subscribing","slug":"/subscribing/error-handling","permalink":"/hfc-pubsub/subscribing/error-handling","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Internal Error Handling.md","version":"current","sidebar_label":"Error Handling","sidebarPosition":2,"frontMatter":{"id":"error-handling","title":"Internal Error Handling","sidebar_label":"Error Handling","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Messages compression","permalink":"/hfc-pubsub/subscribing/Messages_compression"},"next":{"title":"Adding Labels","permalink":"/hfc-pubsub/subscribing/labels"}},{"unversionedId":"subscribing/labels","id":"subscribing/labels","isDocsHomePage":false,"title":"Adding Labels","description":"Global Labels","source":"@site/docs/subscribing/Labels.md","sourceDirName":"subscribing","slug":"/subscribing/labels","permalink":"/hfc-pubsub/subscribing/labels","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Labels.md","version":"current","sidebar_label":"Labels","sidebarPosition":2,"frontMatter":{"id":"labels","title":"Adding Labels","sidebar_label":"Labels","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/subscribing/error-handling"},"next":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/subscribing/retry-policy"}},{"unversionedId":"subscribing/message-ordering","id":"subscribing/message-ordering","isDocsHomePage":false,"title":"Subscription with Message Ordering","description":"Messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.","source":"@site/docs/subscribing/Message Ordering.md","sourceDirName":"subscribing","slug":"/subscribing/message-ordering","permalink":"/hfc-pubsub/subscribing/message-ordering","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Message Ordering.md","version":"current","sidebar_label":"Message Ordering","sidebarPosition":3,"frontMatter":{"id":"message-ordering","title":"Subscription with Message Ordering","sidebar_label":"Message Ordering","sidebar_position":3},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/subscribing/retry-policy"},"next":{"title":"Topics","permalink":"/hfc-pubsub/publishing/topics"}},{"unversionedId":"subscribing/Messages_compression","id":"subscribing/Messages_compression","isDocsHomePage":false,"title":"Messages compression","description":"Framework supports gzip compression/decompression for messages.","source":"@site/docs/subscribing/Messages Compression.md","sourceDirName":"subscribing","slug":"/subscribing/Messages_compression","permalink":"/hfc-pubsub/subscribing/Messages_compression","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Messages Compression.md","version":"current","sidebarPosition":1,"frontMatter":{"id":"Messages_compression","title":"Messages compression","sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy"},"next":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/subscribing/error-handling"}},{"unversionedId":"subscribing/retry-policy","id":"subscribing/retry-policy","isDocsHomePage":false,"title":"Subscriptions with Retry Policy","description":"It is possible to define a retry configuration for a subscription:","source":"@site/docs/subscribing/Retry Policy.md","sourceDirName":"subscribing","slug":"/subscribing/retry-policy","permalink":"/hfc-pubsub/subscribing/retry-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Retry Policy.md","version":"current","sidebar_label":"Retry Policy","sidebarPosition":2,"frontMatter":{"id":"retry-policy","title":"Subscriptions with Retry Policy","sidebar_label":"Retry Policy","sidebar_position":2},"sidebar":"defaultSidebar","previous":{"title":"Adding Labels","permalink":"/hfc-pubsub/subscribing/labels"},"next":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/subscribing/message-ordering"}},{"unversionedId":"subscribing/subscriptions","id":"subscribing/subscriptions","isDocsHomePage":false,"title":"Subscriptions","description":"Create a Subscriber to define a message handler for messages that are published on the corresponding topic.","source":"@site/docs/subscribing/Subscriptions.md","sourceDirName":"subscribing","slug":"/subscribing/subscriptions","permalink":"/hfc-pubsub/subscribing/subscriptions","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/subscribing/Subscriptions.md","version":"current","sidebarPosition":0,"frontMatter":{"id":"subscriptions","title":"Subscriptions","sidebar_position":0},"sidebar":"defaultSidebar","previous":{"title":"Installation","permalink":"/hfc-pubsub/getting-started/installation"},"next":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/subscribing/dead-letter-policy"}}]},{"versionName":"v1","versionLabel":"v1","versionPath":"/hfc-pubsub/v1","versionEditUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1","versionEditUrlLocalized":"https://github.com/deliveryhero/hfc-pubsub/edit/main/i18n/en/docusaurus-plugin-content-docs/version-v1","isLast":false,"sidebarFilePath":"/home/runner/work/hfc-pubsub/hfc-pubsub/versioned_sidebars/version-v1-sidebars.json","contentPath":"/home/runner/work/hfc-pubsub/hfc-pubsub/versioned_docs/version-v1","contentPathLocalized":"/home/runner/work/hfc-pubsub/hfc-pubsub/i18n/en/docusaurus-plugin-content-docs/version-v1","mainDocId":"introduction","sidebars":{"version-v1/defaultSidebar":[{"type":"doc","id":"version-v1/introduction"},{"type":"category","label":"Getting Started","items":[{"type":"doc","id":"version-v1/getting-started/installation"}],"collapsed":false},{"type":"category","label":"Subscribing","items":[{"type":"doc","id":"version-v1/subscribing/subscriptions"},{"type":"doc","id":"version-v1/subscribing/dead-letter-policy","label":"Dead Letter Policy"},{"type":"doc","id":"version-v1/subscribing/error-handling","label":"Error Handling"},{"type":"doc","id":"version-v1/subscribing/retry-policy","label":"Retry Policy"},{"type":"doc","id":"version-v1/subscribing/message-ordering","label":"Message Ordering"}],"collapsed":true},{"type":"category","label":"Publishing","items":[{"type":"doc","id":"version-v1/publishing/topics"},{"type":"doc","id":"version-v1/publishing/retry-settings","label":"Retry Settings"},{"type":"doc","id":"version-v1/publishing/attributes","label":"Attributes"},{"type":"doc","id":"version-v1/publishing/publish-diff-project","label":"Different GCP project"}],"collapsed":true},{"type":"category","label":"Server","items":[{"type":"doc","id":"version-v1/server/service"},{"type":"doc","id":"version-v1/server/custom-logger","label":"Custom Logger"},{"type":"doc","id":"version-v1/server/connect-database","label":"Connect Database"},{"type":"doc","id":"version-v1/server/graceful-shutdown"},{"type":"doc","id":"version-v1/server/health-check"}],"collapsed":true},{"type":"doc","id":"version-v1/cli"},{"type":"doc","id":"version-v1/drivers"},{"type":"doc","id":"version-v1/options"},{"type":"category","label":"Guides","items":[{"type":"doc","id":"version-v1/guides/testing"}],"collapsed":true},{"type":"category","label":"API","items":[{"type":"doc","id":"version-v1/api/index","label":"Exports"},{"type":"category","label":"Namespaces","items":[{"type":"doc","id":"version-v1/api/namespaces/Interfaces","label":"Interfaces"}],"collapsed":true},{"type":"category","label":"Classes","items":[{"type":"doc","id":"version-v1/api/classes/Message","label":"Message"},{"type":"doc","id":"version-v1/api/classes/PubSubService","label":"PubSubService"},{"type":"doc","id":"version-v1/api/classes/Subscriber","label":"Subscriber"},{"type":"doc","id":"version-v1/api/classes/SubscriptionService","label":"SubscriptionService"},{"type":"doc","id":"version-v1/api/classes/Topic","label":"Topic"}],"collapsed":true},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"version-v1/api/interfaces/Payload","label":"Payload"},{"type":"doc","id":"version-v1/api/interfaces/SubscriberOptions","label":"SubscriberOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.BackoffSettings","label":"BackoffSettings"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.GooglePubSubProject","label":"GooglePubSubProject"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.PublishOptions","label":"PublishOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.RetryConfig","label":"RetryConfig"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.TopicPublishOptions","label":"TopicPublishOptions"},{"type":"doc","id":"version-v1/api/interfaces/Interfaces.pubSubClient","label":"pubSubClient"}],"collapsed":true}],"collapsed":true}]},"permalinkToSidebar":{"/hfc-pubsub/v1/api/classes/Message":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/PubSubService":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/Subscriber":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/SubscriptionService":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/classes/Topic":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/Payload":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/interfaces/SubscriberOptions":"version-v1/defaultSidebar","/hfc-pubsub/v1/api/namespaces/Interfaces":"version-v1/defaultSidebar","/hfc-pubsub/v1/cli":"version-v1/defaultSidebar","/hfc-pubsub/v1/drivers":"version-v1/defaultSidebar","/hfc-pubsub/v1/getting-started/installation":"version-v1/defaultSidebar","/hfc-pubsub/v1/guides/testing":"version-v1/defaultSidebar","/hfc-pubsub/v1/":"version-v1/defaultSidebar","/hfc-pubsub/v1/options":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/attributes":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/publish-diff-project":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/retry-settings":"version-v1/defaultSidebar","/hfc-pubsub/v1/publishing/topics":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/connect-database":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/custom-logger":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/graceful-shutdown":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/health-check":"version-v1/defaultSidebar","/hfc-pubsub/v1/server/service":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/dead-letter-policy":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/error-handling":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/message-ordering":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/retry-policy":"version-v1/defaultSidebar","/hfc-pubsub/v1/subscribing/subscriptions":"version-v1/defaultSidebar"},"docs":[{"unversionedId":"api/classes/Message","id":"version-v1/api/classes/Message","isDocsHomePage":false,"title":"Class: Message","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/Message.md","sourceDirName":"api/classes","slug":"/api/classes/Message","permalink":"/hfc-pubsub/v1/api/classes/Message","editUrl":null,"version":"v1","sidebar_label":"Message","sidebarPosition":0,"frontMatter":{"id":"Message","title":"Class: Message","sidebar_label":"Message","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Namespace: Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces"},"next":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService"}},{"unversionedId":"api/classes/PubSubService","id":"version-v1/api/classes/PubSubService","isDocsHomePage":false,"title":"Class: PubSubService","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/PubSubService.md","sourceDirName":"api/classes","slug":"/api/classes/PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService","editUrl":null,"version":"v1","sidebar_label":"PubSubService","sidebarPosition":0,"frontMatter":{"id":"PubSubService","title":"Class: PubSubService","sidebar_label":"PubSubService","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Message","permalink":"/hfc-pubsub/v1/api/classes/Message"},"next":{"title":"Class: Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber"}},{"unversionedId":"api/classes/Subscriber","id":"version-v1/api/classes/Subscriber","isDocsHomePage":false,"title":"Class: Subscriber","description":"deprecated","source":"@site/versioned_docs/version-v1/api/classes/Subscriber.md","sourceDirName":"api/classes","slug":"/api/classes/Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber","editUrl":null,"version":"v1","sidebar_label":"Subscriber","sidebarPosition":0,"frontMatter":{"id":"Subscriber","title":"Class: Subscriber","sidebar_label":"Subscriber","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: PubSubService","permalink":"/hfc-pubsub/v1/api/classes/PubSubService"},"next":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService"}},{"unversionedId":"api/classes/SubscriptionService","id":"version-v1/api/classes/SubscriptionService","isDocsHomePage":false,"title":"Class: SubscriptionService","description":"Constructors","source":"@site/versioned_docs/version-v1/api/classes/SubscriptionService.md","sourceDirName":"api/classes","slug":"/api/classes/SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService","editUrl":null,"version":"v1","sidebar_label":"SubscriptionService","sidebarPosition":0,"frontMatter":{"id":"SubscriptionService","title":"Class: SubscriptionService","sidebar_label":"SubscriptionService","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Subscriber","permalink":"/hfc-pubsub/v1/api/classes/Subscriber"},"next":{"title":"Class: Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic"}},{"unversionedId":"api/classes/Topic","id":"version-v1/api/classes/Topic","isDocsHomePage":false,"title":"Class: Topic","description":"Implements","source":"@site/versioned_docs/version-v1/api/classes/Topic.md","sourceDirName":"api/classes","slug":"/api/classes/Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic","editUrl":null,"version":"v1","sidebar_label":"Topic","sidebarPosition":0,"frontMatter":{"id":"Topic","title":"Class: Topic","sidebar_label":"Topic","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: SubscriptionService","permalink":"/hfc-pubsub/v1/api/classes/SubscriptionService"},"next":{"title":"Interface: Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload"}},{"unversionedId":"api/index","id":"version-v1/api/index","isDocsHomePage":false,"title":"@honestfoodcompany/pubsub","description":"Namespaces","source":"@site/versioned_docs/version-v1/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/hfc-pubsub/v1/api/","editUrl":null,"version":"v1","sidebar_label":"Exports","sidebarPosition":0.5,"frontMatter":{"id":"index","title":"@honestfoodcompany/pubsub","slug":"/api/","sidebar_label":"Exports","sidebar_position":0.5,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Testing","permalink":"/hfc-pubsub/v1/guides/testing"},"next":{"title":"Namespace: Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces"}},{"unversionedId":"api/interfaces/Interfaces.BackoffSettings","id":"version-v1/api/interfaces/Interfaces.BackoffSettings","isDocsHomePage":false,"title":"Interface: BackoffSettings","description":"Interfaces.BackoffSettings","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.BackoffSettings.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings","editUrl":null,"version":"v1","sidebar_label":"BackoffSettings","frontMatter":{"id":"Interfaces.BackoffSettings","title":"Interface: BackoffSettings","sidebar_label":"BackoffSettings","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions"},"next":{"title":"Interface: GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject"}},{"unversionedId":"api/interfaces/Interfaces.GooglePubSubProject","id":"version-v1/api/interfaces/Interfaces.GooglePubSubProject","isDocsHomePage":false,"title":"Interface: GooglePubSubProject","description":"Interfaces.GooglePubSubProject","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.GooglePubSubProject.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject","editUrl":null,"version":"v1","sidebar_label":"GooglePubSubProject","frontMatter":{"id":"Interfaces.GooglePubSubProject","title":"Interface: GooglePubSubProject","sidebar_label":"GooglePubSubProject","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings"},"next":{"title":"Interface: PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.PublishOptions","id":"version-v1/api/interfaces/Interfaces.PublishOptions","isDocsHomePage":false,"title":"Interface: PublishOptions","description":"Interfaces.PublishOptions","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.PublishOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions","editUrl":null,"version":"v1","sidebar_label":"PublishOptions","frontMatter":{"id":"Interfaces.PublishOptions","title":"Interface: PublishOptions","sidebar_label":"PublishOptions","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: GooglePubSubProject","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject"},"next":{"title":"Interface: RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig"}},{"unversionedId":"api/interfaces/Interfaces.pubSubClient","id":"version-v1/api/interfaces/Interfaces.pubSubClient","isDocsHomePage":false,"title":"Interface: pubSubClient","description":"Interfaces.pubSubClient","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.pubSubClient.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.pubSubClient","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient","editUrl":null,"version":"v1","sidebar_label":"pubSubClient","frontMatter":{"id":"Interfaces.pubSubClient","title":"Interface: pubSubClient","sidebar_label":"pubSubClient","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.RetryConfig","id":"version-v1/api/interfaces/Interfaces.RetryConfig","isDocsHomePage":false,"title":"Interface: RetryConfig","description":"Interfaces.RetryConfig","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.RetryConfig.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig","editUrl":null,"version":"v1","sidebar_label":"RetryConfig","frontMatter":{"id":"Interfaces.RetryConfig","title":"Interface: RetryConfig","sidebar_label":"RetryConfig","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: PublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions"},"next":{"title":"Interface: TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions"}},{"unversionedId":"api/interfaces/Interfaces.TopicPublishOptions","id":"version-v1/api/interfaces/Interfaces.TopicPublishOptions","isDocsHomePage":false,"title":"Interface: TopicPublishOptions","description":"Interfaces.TopicPublishOptions","source":"@site/versioned_docs/version-v1/api/interfaces/Interfaces.TopicPublishOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Interfaces.TopicPublishOptions","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions","editUrl":null,"version":"v1","sidebar_label":"TopicPublishOptions","frontMatter":{"id":"Interfaces.TopicPublishOptions","title":"Interface: TopicPublishOptions","sidebar_label":"TopicPublishOptions","custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: RetryConfig","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig"},"next":{"title":"Interface: pubSubClient","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient"}},{"unversionedId":"api/interfaces/Payload","id":"version-v1/api/interfaces/Payload","isDocsHomePage":false,"title":"Interface: Payload","description":"extend this interface to define your own payload","source":"@site/versioned_docs/version-v1/api/interfaces/Payload.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload","editUrl":null,"version":"v1","sidebar_label":"Payload","sidebarPosition":0,"frontMatter":{"id":"Payload","title":"Interface: Payload","sidebar_label":"Payload","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Class: Topic","permalink":"/hfc-pubsub/v1/api/classes/Topic"},"next":{"title":"Interface: SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions"}},{"unversionedId":"api/interfaces/SubscriberOptions","id":"version-v1/api/interfaces/SubscriberOptions","isDocsHomePage":false,"title":"Interface: SubscriberOptions","description":"Hierarchy","source":"@site/versioned_docs/version-v1/api/interfaces/SubscriberOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/SubscriberOptions","permalink":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions","editUrl":null,"version":"v1","sidebar_label":"SubscriberOptions","sidebarPosition":0,"frontMatter":{"id":"SubscriberOptions","title":"Interface: SubscriberOptions","sidebar_label":"SubscriberOptions","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Interface: Payload","permalink":"/hfc-pubsub/v1/api/interfaces/Payload"},"next":{"title":"Interface: BackoffSettings","permalink":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings"}},{"unversionedId":"api/namespaces/Interfaces","id":"version-v1/api/namespaces/Interfaces","isDocsHomePage":false,"title":"Namespace: Interfaces","description":"Interfaces","source":"@site/versioned_docs/version-v1/api/namespaces/Interfaces.md","sourceDirName":"api/namespaces","slug":"/api/namespaces/Interfaces","permalink":"/hfc-pubsub/v1/api/namespaces/Interfaces","editUrl":null,"version":"v1","sidebar_label":"Interfaces","sidebarPosition":0,"frontMatter":{"id":"Interfaces","title":"Namespace: Interfaces","sidebar_label":"Interfaces","sidebar_position":0,"custom_edit_url":null},"sidebar":"version-v1/defaultSidebar","previous":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/v1/api/"},"next":{"title":"Class: Message","permalink":"/hfc-pubsub/v1/api/classes/Message"}},{"unversionedId":"cli","id":"version-v1/cli","isDocsHomePage":false,"title":"CLI","description":"Prerequisites npm i -g npx","source":"@site/versioned_docs/version-v1/CLI.md","sourceDirName":".","slug":"/cli","permalink":"/hfc-pubsub/v1/cli","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/CLI.md","version":"v1","sidebarPosition":5,"frontMatter":{"id":"cli","title":"CLI","sidebar_position":5},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Health Checks","permalink":"/hfc-pubsub/v1/server/health-check"},"next":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/v1/drivers"}},{"unversionedId":"drivers","id":"version-v1/drivers","isDocsHomePage":false,"title":"PubSub Drivers","description":"Google PubSub Driver","source":"@site/versioned_docs/version-v1/Drivers.md","sourceDirName":".","slug":"/drivers","permalink":"/hfc-pubsub/v1/drivers","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Drivers.md","version":"v1","sidebarPosition":5,"frontMatter":{"id":"drivers","title":"PubSub Drivers","sidebar_position":5},"sidebar":"version-v1/defaultSidebar","previous":{"title":"CLI","permalink":"/hfc-pubsub/v1/cli"},"next":{"title":"Other Options","permalink":"/hfc-pubsub/v1/options"}},{"unversionedId":"getting-started/installation","id":"version-v1/getting-started/installation","isDocsHomePage":false,"title":"Installation","description":"Requirements","source":"@site/versioned_docs/version-v1/getting-started/Installation.md","sourceDirName":"getting-started","slug":"/getting-started/installation","permalink":"/hfc-pubsub/v1/getting-started/installation","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/getting-started/Installation.md","version":"v1","sidebarPosition":1,"frontMatter":{"id":"installation","title":"Installation","slug":"/getting-started/installation","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Introduction","permalink":"/hfc-pubsub/v1/"},"next":{"title":"Subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions"}},{"unversionedId":"guides/testing","id":"version-v1/guides/testing","isDocsHomePage":false,"title":"Testing","description":"Unit Tests","source":"@site/versioned_docs/version-v1/guides/Testing.md","sourceDirName":"guides","slug":"/guides/testing","permalink":"/hfc-pubsub/v1/guides/testing","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/guides/Testing.md","version":"v1","sidebarPosition":2,"frontMatter":{"id":"testing","title":"Testing","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Other Options","permalink":"/hfc-pubsub/v1/options"},"next":{"title":"@honestfoodcompany/pubsub","permalink":"/hfc-pubsub/v1/api/"}},{"unversionedId":"introduction","id":"version-v1/introduction","isDocsHomePage":false,"title":"Introduction","description":"@honestfoodcompany/pubsub","source":"@site/versioned_docs/version-v1/Introduction.md","sourceDirName":".","slug":"/","permalink":"/hfc-pubsub/v1/","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Introduction.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"introduction","title":"Introduction","sidebar_position":0,"slug":"/"},"sidebar":"version-v1/defaultSidebar","next":{"title":"Installation","permalink":"/hfc-pubsub/v1/getting-started/installation"}},{"unversionedId":"options","id":"version-v1/options","isDocsHomePage":false,"title":"Other Options","description":"Enabling gRPC C++ bindings","source":"@site/versioned_docs/version-v1/Options.md","sourceDirName":".","slug":"/options","permalink":"/hfc-pubsub/v1/options","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/Options.md","version":"v1","sidebarPosition":6,"frontMatter":{"id":"options","title":"Other Options","sidebar_position":6},"sidebar":"version-v1/defaultSidebar","previous":{"title":"PubSub Drivers","permalink":"/hfc-pubsub/v1/drivers"},"next":{"title":"Testing","permalink":"/hfc-pubsub/v1/guides/testing"}},{"unversionedId":"publishing/attributes","id":"version-v1/publishing/attributes","isDocsHomePage":false,"title":"Publishing with Attributes","description":"See:","source":"@site/versioned_docs/version-v1/publishing/Attributes.md","sourceDirName":"publishing","slug":"/publishing/attributes","permalink":"/hfc-pubsub/v1/publishing/attributes","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Attributes.md","version":"v1","sidebar_label":"Attributes","sidebarPosition":2,"frontMatter":{"id":"attributes","title":"Publishing with Attributes","sidebar_label":"Attributes","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings"},"next":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project"}},{"unversionedId":"publishing/publish-diff-project","id":"version-v1/publishing/publish-diff-project","isDocsHomePage":false,"title":"Publishing on a Different GCP project","description":"`ts title=\\"/pubsub/topics/example-topic-with-customCredentials.ts\\"","source":"@site/versioned_docs/version-v1/publishing/Publish Diff Project.md","sourceDirName":"publishing","slug":"/publishing/publish-diff-project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Publish Diff Project.md","version":"v1","sidebar_label":"Different GCP project","sidebarPosition":3,"frontMatter":{"id":"publish-diff-project","title":"Publishing on a Different GCP project","sidebar_label":"Different GCP project","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/v1/publishing/attributes"},"next":{"title":"Subscription Service","permalink":"/hfc-pubsub/v1/server/service"}},{"unversionedId":"publishing/retry-settings","id":"version-v1/publishing/retry-settings","isDocsHomePage":false,"title":"Publishing a message with retry settings","description":"NOTE: This may not work right now, it is a known bug.","source":"@site/versioned_docs/version-v1/publishing/Retry Settings.md","sourceDirName":"publishing","slug":"/publishing/retry-settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Retry Settings.md","version":"v1","sidebar_label":"Retry Settings","sidebarPosition":1,"frontMatter":{"id":"retry-settings","title":"Publishing a message with retry settings","sidebar_label":"Retry Settings","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Topics","permalink":"/hfc-pubsub/v1/publishing/topics"},"next":{"title":"Publishing with Attributes","permalink":"/hfc-pubsub/v1/publishing/attributes"}},{"unversionedId":"publishing/topics","id":"version-v1/publishing/topics","isDocsHomePage":false,"title":"Topics","description":"Create a topic in PUBSUBROOTDIR/topics which extends Topic and a payload which extends Payload from package.","source":"@site/versioned_docs/version-v1/publishing/Topics.md","sourceDirName":"publishing","slug":"/publishing/topics","permalink":"/hfc-pubsub/v1/publishing/topics","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/publishing/Topics.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"topics","title":"Topics","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering"},"next":{"title":"Publishing a message with retry settings","permalink":"/hfc-pubsub/v1/publishing/retry-settings"}},{"unversionedId":"server/connect-database","id":"version-v1/server/connect-database","isDocsHomePage":false,"title":"Connecting to a Database","description":"It is recommended to initialize a database connection in the subscription.service file in your PUBSUBROOTDIR. Insert your database connection logic in the init method.","source":"@site/versioned_docs/version-v1/server/Connect Database.md","sourceDirName":"server","slug":"/server/connect-database","permalink":"/hfc-pubsub/v1/server/connect-database","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Connect Database.md","version":"v1","sidebar_label":"Connect Database","sidebarPosition":2,"frontMatter":{"id":"connect-database","title":"Connecting to a Database","sidebar_label":"Connect Database","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/v1/server/custom-logger"},"next":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown"}},{"unversionedId":"server/custom-logger","id":"version-v1/server/custom-logger","isDocsHomePage":false,"title":"Passing a Custom Logger","description":"In the main SubscriptionService before defining subscription class you can update the logger that is being used by the package for logging. It\'s an optional definition and by default it uses console.* for logging .info, .warn and .error these 3 function keys are a must have for the logger you pass.","source":"@site/versioned_docs/version-v1/server/Custom Logger.md","sourceDirName":"server","slug":"/server/custom-logger","permalink":"/hfc-pubsub/v1/server/custom-logger","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Custom Logger.md","version":"v1","sidebar_label":"Custom Logger","sidebarPosition":1,"frontMatter":{"id":"custom-logger","title":"Passing a Custom Logger","sidebar_label":"Custom Logger","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscription Service","permalink":"/hfc-pubsub/v1/server/service"},"next":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/v1/server/connect-database"}},{"unversionedId":"server/graceful-shutdown","id":"version-v1/server/graceful-shutdown","isDocsHomePage":false,"title":"Graceful Shutdown","description":"When gracefully shutting down a process, it is a good idea to first close all open subscriptions and DB connections. For this reason we have a static closeAll method in the SubscriptionService that can close all connections before shutting down. An example using it with process signal handlers:","source":"@site/versioned_docs/version-v1/server/Graceful Shutdown.md","sourceDirName":"server","slug":"/server/graceful-shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Graceful Shutdown.md","version":"v1","sidebarPosition":3,"frontMatter":{"id":"graceful-shutdown","title":"Graceful Shutdown","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Connecting to a Database","permalink":"/hfc-pubsub/v1/server/connect-database"},"next":{"title":"Health Checks","permalink":"/hfc-pubsub/v1/server/health-check"}},{"unversionedId":"server/health-check","id":"version-v1/server/health-check","isDocsHomePage":false,"title":"Health Checks","description":"For health checks and readiness probes you can enable the inbuilt health check http server by setting the following environemnt variables (or corresponding CLI option) :","source":"@site/versioned_docs/version-v1/server/Health Check.md","sourceDirName":"server","slug":"/server/health-check","permalink":"/hfc-pubsub/v1/server/health-check","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Health Check.md","version":"v1","sidebarPosition":4,"frontMatter":{"id":"health-check","title":"Health Checks","sidebar_position":4},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Graceful Shutdown","permalink":"/hfc-pubsub/v1/server/graceful-shutdown"},"next":{"title":"CLI","permalink":"/hfc-pubsub/v1/cli"}},{"unversionedId":"server/service","id":"version-v1/server/service","isDocsHomePage":false,"title":"Subscription Service","description":"Extend and customize the behavior of the subscription server in the subscription.service file. Initialize a database connection, register subscribers, and define default subscriber options in the subscription service file.","source":"@site/versioned_docs/version-v1/server/Service.md","sourceDirName":"server","slug":"/server/service","permalink":"/hfc-pubsub/v1/server/service","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/server/Service.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"service","title":"Subscription Service","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Publishing on a Different GCP project","permalink":"/hfc-pubsub/v1/publishing/publish-diff-project"},"next":{"title":"Passing a Custom Logger","permalink":"/hfc-pubsub/v1/server/custom-logger"}},{"unversionedId":"subscribing/dead-letter-policy","id":"version-v1/subscribing/dead-letter-policy","isDocsHomePage":false,"title":"Subscriptions with a Dead-letter Policy","description":"It is possible to define a dead-letter policy for a subscription. If the dead letter topic does not exist, it will be created automatically by the framework.","source":"@site/versioned_docs/version-v1/subscribing/Dead Letter Policy.md","sourceDirName":"subscribing","slug":"/subscribing/dead-letter-policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Dead Letter Policy.md","version":"v1","sidebar_label":"Dead Letter Policy","sidebarPosition":1,"frontMatter":{"id":"dead-letter-policy","title":"Subscriptions with a Dead-letter Policy","sidebar_label":"Dead Letter Policy","sidebar_position":1},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions"},"next":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling"}},{"unversionedId":"subscribing/error-handling","id":"version-v1/subscribing/error-handling","isDocsHomePage":false,"title":"Internal Error Handling","description":"To handle any internal error that might occur on pubsub side, a the method handleError can be declared either in Subscriber Object or in SubscriptionService level.","source":"@site/versioned_docs/version-v1/subscribing/Internal Error Handling.md","sourceDirName":"subscribing","slug":"/subscribing/error-handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Internal Error Handling.md","version":"v1","sidebar_label":"Error Handling","sidebarPosition":2,"frontMatter":{"id":"error-handling","title":"Internal Error Handling","sidebar_label":"Error Handling","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy"},"next":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy"}},{"unversionedId":"subscribing/message-ordering","id":"version-v1/subscribing/message-ordering","isDocsHomePage":false,"title":"Subscription with Message Ordering","description":"Messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.","source":"@site/versioned_docs/version-v1/subscribing/Message Ordering.md","sourceDirName":"subscribing","slug":"/subscribing/message-ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Message Ordering.md","version":"v1","sidebar_label":"Message Ordering","sidebarPosition":3,"frontMatter":{"id":"message-ordering","title":"Subscription with Message Ordering","sidebar_label":"Message Ordering","sidebar_position":3},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Subscriptions with Retry Policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy"},"next":{"title":"Topics","permalink":"/hfc-pubsub/v1/publishing/topics"}},{"unversionedId":"subscribing/retry-policy","id":"version-v1/subscribing/retry-policy","isDocsHomePage":false,"title":"Subscriptions with Retry Policy","description":"It is possible to define a retry configuration for a subscription:","source":"@site/versioned_docs/version-v1/subscribing/Retry Policy.md","sourceDirName":"subscribing","slug":"/subscribing/retry-policy","permalink":"/hfc-pubsub/v1/subscribing/retry-policy","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Retry Policy.md","version":"v1","sidebar_label":"Retry Policy","sidebarPosition":2,"frontMatter":{"id":"retry-policy","title":"Subscriptions with Retry Policy","sidebar_label":"Retry Policy","sidebar_position":2},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Internal Error Handling","permalink":"/hfc-pubsub/v1/subscribing/error-handling"},"next":{"title":"Subscription with Message Ordering","permalink":"/hfc-pubsub/v1/subscribing/message-ordering"}},{"unversionedId":"subscribing/subscriptions","id":"version-v1/subscribing/subscriptions","isDocsHomePage":false,"title":"Subscriptions","description":"Create a Subscriber to define a message handler for messages that are published on the corresponding topic.","source":"@site/versioned_docs/version-v1/subscribing/Subscriptions.md","sourceDirName":"subscribing","slug":"/subscribing/subscriptions","permalink":"/hfc-pubsub/v1/subscribing/subscriptions","editUrl":"https://github.com/deliveryhero/hfc-pubsub/edit/main/versioned_docs/version-v1/subscribing/Subscriptions.md","version":"v1","sidebarPosition":0,"frontMatter":{"id":"subscriptions","title":"Subscriptions","sidebar_position":0},"sidebar":"version-v1/defaultSidebar","previous":{"title":"Installation","permalink":"/hfc-pubsub/v1/getting-started/installation"},"next":{"title":"Subscriptions with a Dead-letter Policy","permalink":"/hfc-pubsub/v1/subscribing/dead-letter-policy"}}]}]}},"docusaurus-plugin-content-blog":{"default":null},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{"default":null},"docusaurus-plugin-sitemap":{"default":null},"docusaurus-theme-classic":{"default":null},"undefined":{"default":null}}')}}]); \ No newline at end of file diff --git a/assets/js/24bb654f.62c4ba33.js b/assets/js/24bb654f.62c4ba33.js new file mode 100644 index 00000000..373cbbce --- /dev/null +++ b/assets/js/24bb654f.62c4ba33.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[7367],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>b});var i=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,i)}return r}function a(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=i.createContext({}),l=function(e){var t=i.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=l(e.components);return i.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),b=n,k=d["".concat(p,".").concat(b)]||d[b]||u[b]||s;return r?i.createElement(k,a(a({ref:t},c),{},{components:r})):i.createElement(k,a({ref:t},c))}));function b(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,a=new Array(s);a[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:n,a[1]=o;for(var l=2;l{r.r(t),r.d(t,{default:()=>u,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var i=r(7462),n=r(3366),s=(r(7294),r(3905)),a=["components"],o={id:"SubscriptionService",title:"Class: SubscriptionService",sidebar_label:"SubscriptionService",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/SubscriptionService",id:"api/classes/SubscriptionService",isDocsHomePage:!1,title:"Class: SubscriptionService",description:"Constructors",source:"@site/docs/api/classes/SubscriptionService.md",sourceDirName:"api/classes",slug:"/api/classes/SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService",editUrl:null,version:"current",sidebar_label:"SubscriptionService",sidebarPosition:0,frontMatter:{id:"SubscriptionService",title:"Class: SubscriptionService",sidebar_label:"SubscriptionService",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService"},next:{title:"Class: Topic

",permalink:"/hfc-pubsub/api/classes/Topic"}},l=[{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"defaultSubscriberOptions",id:"defaultsubscriberoptions",children:[]},{value:"subscribers",id:"subscribers",children:[]}]},{value:"Methods",id:"methods",children:[{value:"closeAll",id:"closeall",children:[]},{value:"getSubscribers",id:"getsubscribers",children:[]},{value:"handleError",id:"handleerror",children:[]},{value:"init",id:"init",children:[]},{value:"loadSubscriptionService",id:"loadsubscriptionservice",children:[]}]}],c={toc:l};function u(e){var t=e.components,r=(0,n.Z)(e,a);return(0,s.kt)("wrapper",(0,i.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h2",{id:"constructors"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new SubscriptionService"),"()"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L23"},"src/service/subscription.ts:23")),(0,s.kt)("h2",{id:"properties"},"Properties"),(0,s.kt)("h3",{id:"defaultsubscriberoptions"},"defaultSubscriberOptions"),(0,s.kt)("p",null,"\u25aa ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"defaultSubscriberOptions"),": ",(0,s.kt)("a",{parentName:"p",href:"../interfaces/SubscriberOptions"},(0,s.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,s.kt)("p",null,"All subscriptions will inherit from this default options object"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L21"},"src/service/subscription.ts:21")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"subscribers"},"subscribers"),(0,s.kt)("p",null,"\u25aa ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"subscribers"),": ",(0,s.kt)("a",{parentName:"p",href:"../interfaces/SubscriberObject"},(0,s.kt)("inlineCode",{parentName:"a"},"SubscriberObject")),"<",(0,s.kt)("inlineCode",{parentName:"p"},"any"),">","[] = ",(0,s.kt)("inlineCode",{parentName:"p"},"[]")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L14"},"src/service/subscription.ts:14")),(0,s.kt)("h2",{id:"methods"},"Methods"),(0,s.kt)("h3",{id:"closeall"},"closeAll"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"closeAll"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("p",null,"Call this function from a process exit handler to close all current subscriptions"),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L64"},"src/service/subscription.ts:64")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"getsubscribers"},"getSubscribers"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"getSubscribers"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L68"},"src/service/subscription.ts:68")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"handleerror"},"handleError"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"handleError"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("p",null,"If passed, it would serve as the default error handler for all subscriptions.\nApplications should override this with custom error handling: log error, cleanup resources and exit the process.\nDefault logs the error and ",(0,s.kt)("strong",{parentName:"p"},"rethrows")),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"err")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"Error"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"metadata")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"../interfaces/SubscriberMetadata"},(0,s.kt)("inlineCode",{parentName:"a"},"SubscriberMetadata")))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L51"},"src/service/subscription.ts:51")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"init"},"init"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"init"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("p",null,"Can be used to initialize process level globals (like DB Connections).\nDefault is a no-op"),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L42"},"src/service/subscription.ts:42")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"loadsubscriptionservice"},"loadSubscriptionService"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,s.kt)("strong",{parentName:"p"},"loadSubscriptionService"),"(): typeof ",(0,s.kt)("a",{parentName:"p",href:"SubscriptionService"},(0,s.kt)("inlineCode",{parentName:"a"},"SubscriptionService"))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,"typeof ",(0,s.kt)("a",{parentName:"p",href:"SubscriptionService"},(0,s.kt)("inlineCode",{parentName:"a"},"SubscriptionService"))),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/subscription.ts#L112"},"src/service/subscription.ts:112")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/24bb654f.e76d3000.js b/assets/js/24bb654f.e76d3000.js deleted file mode 100644 index afa6211e..00000000 --- a/assets/js/24bb654f.e76d3000.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[7367],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>b});var i=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,i)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=i.createContext({}),l=function(e){var t=i.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=l(e.components);return i.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var r=e.components,n=e.mdxType,a=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),b=n,k=d["".concat(p,".").concat(b)]||d[b]||u[b]||a;return r?i.createElement(k,s(s({ref:t},c),{},{components:r})):i.createElement(k,s({ref:t},c))}));function b(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var a=r.length,s=new Array(a);s[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:n,s[1]=o;for(var l=2;l{r.r(t),r.d(t,{default:()=>u,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var i=r(7462),n=r(3366),a=(r(7294),r(3905)),s=["components"],o={id:"SubscriptionService",title:"Class: SubscriptionService",sidebar_label:"SubscriptionService",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/SubscriptionService",id:"api/classes/SubscriptionService",isDocsHomePage:!1,title:"Class: SubscriptionService",description:"Constructors",source:"@site/docs/api/classes/SubscriptionService.md",sourceDirName:"api/classes",slug:"/api/classes/SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService",editUrl:null,version:"current",sidebar_label:"SubscriptionService",sidebarPosition:0,frontMatter:{id:"SubscriptionService",title:"Class: SubscriptionService",sidebar_label:"SubscriptionService",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService"},next:{title:"Class: Topic

",permalink:"/hfc-pubsub/api/classes/Topic"}},l=[{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"defaultSubscriberOptions",id:"defaultsubscriberoptions",children:[]},{value:"subscribers",id:"subscribers",children:[]}]},{value:"Methods",id:"methods",children:[{value:"closeAll",id:"closeall",children:[]},{value:"getSubscribers",id:"getsubscribers",children:[]},{value:"handleError",id:"handleerror",children:[]},{value:"init",id:"init",children:[]},{value:"loadSubscriptionService",id:"loadsubscriptionservice",children:[]}]}],c={toc:l};function u(e){var t=e.components,r=(0,n.Z)(e,s);return(0,a.kt)("wrapper",(0,i.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new SubscriptionService"),"()"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L23"},"src/service/subscription.ts:23")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"defaultsubscriberoptions"},"defaultSubscriberOptions"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"defaultSubscriberOptions"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/SubscriberOptions"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,a.kt)("p",null,"All subscriptions will inherit from this default options object"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L21"},"src/service/subscription.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscribers"},"subscribers"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"subscribers"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/SubscriberObject"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberObject")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"any"),">","[] = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L14"},"src/service/subscription.ts:14")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"closeall"},"closeAll"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"closeAll"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Call this function from a process exit handler to close all current subscriptions"),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L64"},"src/service/subscription.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getsubscribers"},"getSubscribers"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"getSubscribers"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L68"},"src/service/subscription.ts:68")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"handleerror"},"handleError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"handleError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"If passed, it would serve as the default error handler for all subscriptions.\nApplications should override this with custom error handling: log error, cleanup resources and exit the process.\nDefault logs the error and ",(0,a.kt)("strong",{parentName:"p"},"rethrows")),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"metadata")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/SubscriberMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberMetadata")))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L51"},"src/service/subscription.ts:51")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"init"},"init"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"init"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Can be used to initialize process level globals (like DB Connections).\nDefault is a no-op"),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L42"},"src/service/subscription.ts:42")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"loadsubscriptionservice"},"loadSubscriptionService"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"loadSubscriptionService"),"(): typeof ",(0,a.kt)("a",{parentName:"p",href:"SubscriptionService"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriptionService"))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,"typeof ",(0,a.kt)("a",{parentName:"p",href:"SubscriptionService"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriptionService"))),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/subscription.ts#L112"},"src/service/subscription.ts:112")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.39808287.js b/assets/js/5e8c322a.78ddeec3.js similarity index 77% rename from assets/js/5e8c322a.39808287.js rename to assets/js/5e8c322a.78ddeec3.js index e00415ce..d7cc6f91 100644 --- a/assets/js/5e8c322a.39808287.js +++ b/assets/js/5e8c322a.78ddeec3.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[7597],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),o=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},u=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),d=o(r),m=n,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return r?a.createElement(f,l(l({ref:t},u),{},{components:r})):a.createElement(f,l({ref:t},u))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:n,l[1]=p;for(var o=2;o{r.r(t),r.d(t,{default:()=>c,frontMatter:()=>p,metadata:()=>s,toc:()=>o});var a=r(7462),n=r(3366),i=(r(7294),r(3905)),l=["components"],p={id:"index",title:"@honestfoodcompany/pubsub",slug:"/api/",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},s={unversionedId:"api/index",id:"api/index",isDocsHomePage:!1,title:"@honestfoodcompany/pubsub",description:"Classes",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/hfc-pubsub/api/",editUrl:null,version:"current",sidebar_label:"Exports",sidebarPosition:.5,frontMatter:{id:"index",title:"@honestfoodcompany/pubsub",slug:"/api/",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Other Options",permalink:"/hfc-pubsub/options"},next:{title:"Class: Message",permalink:"/hfc-pubsub/api/classes/Message"}},o=[{value:"Classes",id:"classes",children:[]},{value:"Interfaces",id:"interfaces",children:[]},{value:"Functions",id:"functions",children:[{value:"isGzipCompressed",id:"isgzipcompressed",children:[]},{value:"setLogger",id:"setlogger",children:[]}]}],u={toc:o};function c(e){var t=e.components,r=(0,n.Z)(e,l);return(0,i.kt)("wrapper",(0,a.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Message"},"Message")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/PubSubService"},"PubSubService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/SubscriptionService"},"SubscriptionService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Topic"},"Topic"))),(0,i.kt)("h2",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/Payload"},"Payload")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberMetadata"},"SubscriberMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberObject"},"SubscriberObject")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberOptions"},"SubscriberOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/TopicOptions"},"TopicOptions"))),(0,i.kt)("h2",{id:"functions"},"Functions"),(0,i.kt)("h3",{id:"isgzipcompressed"},"isGzipCompressed"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"isGzipCompressed"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"buf"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"gzip files contain a 10-byte header, containing a:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"magic number (1f 8b)"),(0,i.kt)("li",{parentName:"ul"},"the compression method (08 for DEFLATE)"),(0,i.kt)("li",{parentName:"ul"},"1-byte of header flags, a 4-byte timestamp, compression flags and the operating system ID.")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"see"))," ",(0,i.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/Gzip#File_format"},"https://en.wikipedia.org/wiki/Gzip#File_format")),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"buf")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Buffer"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/gzip.ts#L9"},"src/message/gzip.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setlogger"},"setLogger"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"setLogger"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"logger"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"logger")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"LoggerOptions"))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/logger.ts#L48"},"src/service/logger.ts:48")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[7597],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),o=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},u=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),d=o(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return r?n.createElement(f,l(l({ref:t},u),{},{components:r})):n.createElement(f,l({ref:t},u))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{r.r(t),r.d(t,{default:()=>c,frontMatter:()=>p,metadata:()=>s,toc:()=>o});var n=r(7462),a=r(3366),i=(r(7294),r(3905)),l=["components"],p={id:"index",title:"@honestfoodcompany/pubsub",slug:"/api/",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},s={unversionedId:"api/index",id:"api/index",isDocsHomePage:!1,title:"@honestfoodcompany/pubsub",description:"Classes",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/hfc-pubsub/api/",editUrl:null,version:"current",sidebar_label:"Exports",sidebarPosition:.5,frontMatter:{id:"index",title:"@honestfoodcompany/pubsub",slug:"/api/",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Other Options",permalink:"/hfc-pubsub/options"},next:{title:"Class: Message",permalink:"/hfc-pubsub/api/classes/Message"}},o=[{value:"Classes",id:"classes",children:[]},{value:"Interfaces",id:"interfaces",children:[]},{value:"Functions",id:"functions",children:[{value:"isGzipCompressed",id:"isgzipcompressed",children:[]},{value:"setLogger",id:"setlogger",children:[]}]}],u={toc:o};function c(e){var t=e.components,r=(0,a.Z)(e,l);return(0,i.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Message"},"Message")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/PubSubService"},"PubSubService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/SubscriptionService"},"SubscriptionService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Topic"},"Topic"))),(0,i.kt)("h2",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/Payload"},"Payload")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberMetadata"},"SubscriberMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberObject"},"SubscriberObject")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SubscriberOptions"},"SubscriberOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/TopicOptions"},"TopicOptions"))),(0,i.kt)("h2",{id:"functions"},"Functions"),(0,i.kt)("h3",{id:"isgzipcompressed"},"isGzipCompressed"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"isGzipCompressed"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"buf"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"gzip files contain a 10-byte header, containing a:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"magic number (1f 8b)"),(0,i.kt)("li",{parentName:"ul"},"the compression method (08 for DEFLATE)"),(0,i.kt)("li",{parentName:"ul"},"1-byte of header flags, a 4-byte timestamp, compression flags and the operating system ID.")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"see"))," ",(0,i.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/Gzip#File_format"},"https://en.wikipedia.org/wiki/Gzip#File_format")),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"buf")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Buffer"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/gzip.ts#L9"},"src/message/gzip.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setlogger"},"setLogger"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"setLogger"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"logger"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"logger")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"LoggerOptions"))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/logger.ts#L48"},"src/service/logger.ts:48")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5f9e1e26.39d5b5a3.js b/assets/js/5f9e1e26.c258bbb4.js similarity index 88% rename from assets/js/5f9e1e26.39d5b5a3.js rename to assets/js/5f9e1e26.c258bbb4.js index 782fb774..28ac6727 100644 --- a/assets/js/5f9e1e26.39d5b5a3.js +++ b/assets/js/5f9e1e26.c258bbb4.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[1535],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>c});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),u=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=u(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},b=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),b=u(n),c=i,k=b["".concat(p,".").concat(c)]||b[c]||d[c]||a;return n?r.createElement(k,l(l({ref:t},o),{},{components:n})):r.createElement(k,l({ref:t},o))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=b;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var u=2;u{n.r(t),n.d(t,{default:()=>d,frontMatter:()=>s,metadata:()=>p,toc:()=>u});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),l=["components"],s={id:"PubSubService",title:"Class: PubSubService",sidebar_label:"PubSubService",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/PubSubService",id:"api/classes/PubSubService",isDocsHomePage:!1,title:"Class: PubSubService",description:"Properties",source:"@site/docs/api/classes/PubSubService.md",sourceDirName:"api/classes",slug:"/api/classes/PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService",editUrl:null,version:"current",sidebar_label:"PubSubService",sidebarPosition:0,frontMatter:{id:"PubSubService",title:"Class: PubSubService",sidebar_label:"PubSubService",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: Message",permalink:"/hfc-pubsub/api/classes/Message"},next:{title:"Class: SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService"}},u=[{value:"Properties",id:"properties",children:[{value:"client",id:"client",children:[]},{value:"driver",id:"driver",children:[]},{value:"instance",id:"instance",children:[]}]},{value:"Methods",id:"methods",children:[{value:"closeAll",id:"closeall",children:[]},{value:"getAllSubscriptions",id:"getallsubscriptions",children:[]},{value:"getSubscribers",id:"getsubscribers",children:[]},{value:"initClient",id:"initclient",children:[]},{value:"publish",id:"publish",children:[]},{value:"startSubscriptions",id:"startsubscriptions",children:[]},{value:"subscribe",id:"subscribe",children:[]},{value:"getInstance",id:"getinstance",children:[]},{value:"isHealthy",id:"ishealthy",children:[]}]}],o={toc:u};function d(e){var t=e.components,n=(0,i.Z)(e,l);return(0,a.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"client"},"client"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"client"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"PubSubClientV2")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L13"},"src/service/pubsub.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"driver"},"driver"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"driver"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"synchronous"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"google"')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L15"},"src/service/pubsub.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"instance"},"instance"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"instance"),": ",(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L14"},"src/service/pubsub.ts:14")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"closeall"},"closeAll"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"closeAll"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L123"},"src/service/pubsub.ts:123")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getallsubscriptions"},"getAllSubscriptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getAllSubscriptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"AllSubscriptions"),"[]",">"),(0,a.kt)("p",null,"Retrieves a list of subscribers"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"AllSubscriptions"),"[]",">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L213"},"src/service/pubsub.ts:213")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getsubscribers"},"getSubscribers"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getSubscribers"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L119"},"src/service/pubsub.ts:119")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"initclient"},"initClient"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"initClient"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L84"},"src/service/pubsub.ts:84")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"publish"},"publish"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"publish"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,a.kt)("inlineCode",{parentName:"p"},"topic"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Publishes new orders to PubSub."),(0,a.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("inlineCode",{parentName:"td"},"TopicProperties"))))),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"topic")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"options?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PublishOptions"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L102"},"src/service/pubsub.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startsubscriptions"},"startSubscriptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"startSubscriptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L144"},"src/service/pubsub.ts:144")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscribe"},"subscribe"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"subscribe"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"subscription"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Subscribes to any given topic"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"subscription")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"SubscriberTuple"))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L206"},"src/service/pubsub.ts:206")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getinstance"},"getInstance"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"getInstance"),"(): ",(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L92"},"src/service/pubsub.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishealthy"},"isHealthy"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"isHealthy"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/service/pubsub.ts#L48"},"src/service/pubsub.ts:48")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[1535],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>b});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),u=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=u(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),d=u(n),b=i,k=d["".concat(p,".").concat(b)]||d[b]||c[b]||a;return n?r.createElement(k,l(l({ref:t},o),{},{components:n})):r.createElement(k,l({ref:t},o))}));function b(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var u=2;u{n.r(t),n.d(t,{default:()=>c,frontMatter:()=>s,metadata:()=>p,toc:()=>u});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),l=["components"],s={id:"PubSubService",title:"Class: PubSubService",sidebar_label:"PubSubService",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/PubSubService",id:"api/classes/PubSubService",isDocsHomePage:!1,title:"Class: PubSubService",description:"Properties",source:"@site/docs/api/classes/PubSubService.md",sourceDirName:"api/classes",slug:"/api/classes/PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService",editUrl:null,version:"current",sidebar_label:"PubSubService",sidebarPosition:0,frontMatter:{id:"PubSubService",title:"Class: PubSubService",sidebar_label:"PubSubService",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: Message",permalink:"/hfc-pubsub/api/classes/Message"},next:{title:"Class: SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService"}},u=[{value:"Properties",id:"properties",children:[{value:"client",id:"client",children:[]},{value:"driver",id:"driver",children:[]},{value:"instance",id:"instance",children:[]}]},{value:"Methods",id:"methods",children:[{value:"closeAll",id:"closeall",children:[]},{value:"getAllSubscriptions",id:"getallsubscriptions",children:[]},{value:"getSubscribers",id:"getsubscribers",children:[]},{value:"initClient",id:"initclient",children:[]},{value:"publish",id:"publish",children:[]},{value:"startSubscriptions",id:"startsubscriptions",children:[]},{value:"subscribe",id:"subscribe",children:[]},{value:"getInstance",id:"getinstance",children:[]},{value:"isHealthy",id:"ishealthy",children:[]}]}],o={toc:u};function c(e){var t=e.components,n=(0,i.Z)(e,l);return(0,a.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"client"},"client"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"client"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"PubSubClientV2")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L13"},"src/service/pubsub.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"driver"},"driver"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"driver"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"synchronous"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"google"')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L15"},"src/service/pubsub.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"instance"},"instance"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"instance"),": ",(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L14"},"src/service/pubsub.ts:14")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"closeall"},"closeAll"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"closeAll"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L123"},"src/service/pubsub.ts:123")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getallsubscriptions"},"getAllSubscriptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getAllSubscriptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"AllSubscriptions"),"[]",">"),(0,a.kt)("p",null,"Retrieves a list of subscribers"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"AllSubscriptions"),"[]",">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L213"},"src/service/pubsub.ts:213")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getsubscribers"},"getSubscribers"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getSubscribers"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Subscribers")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L119"},"src/service/pubsub.ts:119")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"initclient"},"initClient"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"initClient"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L84"},"src/service/pubsub.ts:84")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"publish"},"publish"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"publish"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,a.kt)("inlineCode",{parentName:"p"},"topic"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Publishes new orders to PubSub."),(0,a.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("inlineCode",{parentName:"td"},"TopicProperties"))))),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"topic")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"options?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PublishOptions"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L102"},"src/service/pubsub.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startsubscriptions"},"startSubscriptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"startSubscriptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L144"},"src/service/pubsub.ts:144")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscribe"},"subscribe"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"subscribe"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"subscription"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Subscribes to any given topic"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"subscription")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"SubscriberTuple"))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L206"},"src/service/pubsub.ts:206")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getinstance"},"getInstance"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"getInstance"),"(): ",(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PubSubService"},(0,a.kt)("inlineCode",{parentName:"a"},"PubSubService"))),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L92"},"src/service/pubsub.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishealthy"},"isHealthy"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"isHealthy"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/service/pubsub.ts#L48"},"src/service/pubsub.ts:48")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6401c6ac.bf35ce5c.js b/assets/js/6401c6ac.5f9a14b5.js similarity index 96% rename from assets/js/6401c6ac.bf35ce5c.js rename to assets/js/6401c6ac.5f9a14b5.js index 651ac3f6..073ad61d 100644 --- a/assets/js/6401c6ac.bf35ce5c.js +++ b/assets/js/6401c6ac.5f9a14b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[1581],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),d=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),m=d(a),k=r,u=m["".concat(o,".").concat(k)]||m[k]||c[k]||i;return a?n.createElement(u,p(p({ref:t},s),{},{components:a})):n.createElement(u,p({ref:t},s))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=a(3366),i=(a(7294),a(3905)),p=["components"],l={id:"Topic",title:"Class: Topic

",sidebar_label:"Topic",sidebar_position:0,custom_edit_url:null},o={unversionedId:"api/classes/Topic",id:"api/classes/Topic",isDocsHomePage:!1,title:"Class: Topic

",description:"Type parameters",source:"@site/docs/api/classes/Topic.md",sourceDirName:"api/classes",slug:"/api/classes/Topic",permalink:"/hfc-pubsub/api/classes/Topic",editUrl:null,version:"current",sidebar_label:"Topic",sidebarPosition:0,frontMatter:{id:"Topic",title:"Class: Topic

",sidebar_label:"Topic",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService"},next:{title:"Interface: Payload",permalink:"/hfc-pubsub/api/interfaces/Payload"}},d=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"options",id:"options",children:[]},{value:"project",id:"project",children:[]},{value:"topicName",id:"topicname",children:[]}]},{value:"Methods",id:"methods",children:[{value:"publish",id:"publish",children:[]},{value:"validateMessage",id:"validatemessage",children:[]},{value:"validateTopic",id:"validatetopic",children:[]}]}],s={toc:d};function c(e){var t=e.components,a=(0,r.Z)(e,p);return(0,i.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"P")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")))))),(0,i.kt)("h2",{id:"constructors"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new Topic"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"P"),">","()"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"P")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")))))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L76"},"src/topic/index.ts:76")),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"options"},"options"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"options"),": ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/TopicOptions"},(0,i.kt)("inlineCode",{parentName:"a"},"TopicOptions"))," = ",(0,i.kt)("inlineCode",{parentName:"p"},"defaultOptions")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L73"},"src/topic/index.ts:73")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"project"},"project"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"project"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"GooglePubSubProject")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L68"},"src/topic/index.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"topicname"},"topicName"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"topicName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L67"},"src/topic/index.ts:67")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"publish"},"publish"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"publish"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadInput"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TopicPublishOptions"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L127"},"src/topic/index.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"validatemessage"},"validateMessage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"validateMessage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This is run before publishing any messages, it is a no-op by default.\nCan overwrite to perform checks against payload before publishing"),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadInput"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Message to be published")))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L99"},"src/topic/index.ts:99")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"validatetopic"},"validateTopic"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"validateTopic"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This is run once when Topic is init to verify topic name"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"name")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"topicName")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/topic/index.ts#L88"},"src/topic/index.ts:88")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[1581],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),d=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),m=d(a),k=r,u=m["".concat(o,".").concat(k)]||m[k]||c[k]||i;return a?n.createElement(u,p(p({ref:t},s),{},{components:a})):n.createElement(u,p({ref:t},s))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=a(3366),i=(a(7294),a(3905)),p=["components"],l={id:"Topic",title:"Class: Topic

",sidebar_label:"Topic",sidebar_position:0,custom_edit_url:null},o={unversionedId:"api/classes/Topic",id:"api/classes/Topic",isDocsHomePage:!1,title:"Class: Topic

",description:"Type parameters",source:"@site/docs/api/classes/Topic.md",sourceDirName:"api/classes",slug:"/api/classes/Topic",permalink:"/hfc-pubsub/api/classes/Topic",editUrl:null,version:"current",sidebar_label:"Topic",sidebarPosition:0,frontMatter:{id:"Topic",title:"Class: Topic

",sidebar_label:"Topic",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Class: SubscriptionService",permalink:"/hfc-pubsub/api/classes/SubscriptionService"},next:{title:"Interface: Payload",permalink:"/hfc-pubsub/api/interfaces/Payload"}},d=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"options",id:"options",children:[]},{value:"project",id:"project",children:[]},{value:"topicName",id:"topicname",children:[]}]},{value:"Methods",id:"methods",children:[{value:"publish",id:"publish",children:[]},{value:"validateMessage",id:"validatemessage",children:[]},{value:"validateTopic",id:"validatetopic",children:[]}]}],s={toc:d};function c(e){var t=e.components,a=(0,r.Z)(e,p);return(0,i.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"P")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")))))),(0,i.kt)("h2",{id:"constructors"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new Topic"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"P"),">","()"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"P")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),(0,i.kt)("a",{parentName:"td",href:"../interfaces/Payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")))))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L76"},"src/topic/index.ts:76")),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"options"},"options"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"options"),": ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/TopicOptions"},(0,i.kt)("inlineCode",{parentName:"a"},"TopicOptions"))," = ",(0,i.kt)("inlineCode",{parentName:"p"},"defaultOptions")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L73"},"src/topic/index.ts:73")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"project"},"project"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"project"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"GooglePubSubProject")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L68"},"src/topic/index.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"topicname"},"topicName"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"topicName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L67"},"src/topic/index.ts:67")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"publish"},"publish"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"publish"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadInput"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TopicPublishOptions"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L127"},"src/topic/index.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"validatemessage"},"validateMessage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"validateMessage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This is run before publishing any messages, it is a no-op by default.\nCan overwrite to perform checks against payload before publishing"),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadInput"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Message to be published")))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L99"},"src/topic/index.ts:99")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"validatetopic"},"validateTopic"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"validateTopic"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This is run once when Topic is init to verify topic name"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"name")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"topicName")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/topic/index.ts#L88"},"src/topic/index.ts:88")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9beb87c2.2570cf3d.js b/assets/js/9beb87c2.2570cf3d.js deleted file mode 100644 index f40d0558..00000000 --- a/assets/js/9beb87c2.2570cf3d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[80],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>m});var r=a(7294);function h(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function n(e){for(var t=1;t=0||(h[a]=e[a]);return h}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(h[a]=e[a])}return h}var l=r.createContext({}),o=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):n(n({},t),e)),a},s=function(e){var t=o(e.components);return r.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,h=e.mdxType,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=o(a),m=h,d=u["".concat(l,".").concat(m)]||u[m]||c[m]||i;return a?r.createElement(d,n(n({ref:t},s),{},{components:a})):r.createElement(d,n({ref:t},s))}));function m(e,t){var a=arguments,h=t&&t.mdxType;if("string"==typeof e||h){var i=a.length,n=new Array(i);n[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:h,n[1]=p;for(var o=2;o{a.r(t),a.d(t,{default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var r=a(7462),h=a(3366),i=(a(7294),a(3905)),n=["components"],p={},l={unversionedId:"changelog",id:"changelog",isDocsHomePage:!1,title:"Changelog",description:"2.2.2",source:"@site/docs/changelog.md",sourceDirName:".",slug:"/changelog",permalink:"/hfc-pubsub/changelog",editUrl:"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/changelog.md",version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Interface: TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions"}},o=[{value:"2.2.2",id:"222",children:[{value:"Patch Changes",id:"patch-changes",children:[]}]},{value:"2.2.1",id:"221",children:[{value:"Patch Changes",id:"patch-changes-1",children:[]}]},{value:"2.2.0",id:"220",children:[{value:"Minor Changes",id:"minor-changes",children:[]},{value:"Patch Changes",id:"patch-changes-2",children:[]}]},{value:"2.1.2",id:"212",children:[{value:"Patch Changes",id:"patch-changes-3",children:[]}]},{value:"2.1.1",id:"211",children:[{value:"Patch Changes",id:"patch-changes-4",children:[]}]},{value:"2.1.0",id:"210",children:[{value:"Minor Changes",id:"minor-changes-1",children:[]}]},{value:"2.0.1",id:"201",children:[{value:"Patch Changes",id:"patch-changes-5",children:[]}]},{value:"2.0.0",id:"200",children:[{value:"\u26a0\ufe0f Major Changes \u26a0\ufe0f",id:"\ufe0f-major-changes-\ufe0f",children:[]},{value:"Minor Changes",id:"minor-changes-2",children:[]},{value:"Patch Changes",id:"patch-changes-6",children:[]}]},{value:"1.11.0",id:"1110",children:[{value:"Minor Changes",id:"minor-changes-3",children:[]},{value:"Patch Changes",id:"patch-changes-7",children:[]}]},{value:"1.10.4",id:"1104",children:[{value:"Patch Changes",id:"patch-changes-8",children:[]}]},{value:"1.10.3",id:"1103",children:[{value:"Patch Changes",id:"patch-changes-9",children:[]}]},{value:"1.10.2",id:"1102",children:[{value:"Patch Changes",id:"patch-changes-10",children:[]}]},{value:"1.10.1",id:"1101",children:[{value:"Patch Changes",id:"patch-changes-11",children:[]}]},{value:"1.10.0",id:"1100",children:[{value:"Minor Changes",id:"minor-changes-4",children:[]},{value:"Patch Changes",id:"patch-changes-12",children:[]}]},{value:"1.9.0",id:"190",children:[{value:"Minor Changes",id:"minor-changes-5",children:[]}]},{value:"1.8.1",id:"181",children:[{value:"Patch Changes",id:"patch-changes-13",children:[]}]},{value:"1.8.0",id:"180",children:[{value:"Minor Changes",id:"minor-changes-6",children:[]},{value:"Patch Changes",id:"patch-changes-14",children:[]}]},{value:"1.7.12",id:"1712",children:[{value:"Patch Changes",id:"patch-changes-15",children:[]}]}],s={toc:o};function c(e){var t=e.components,a=(0,h.Z)(e,n);return(0,i.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"222"},"2.2.2"),(0,i.kt)("h3",{id:"patch-changes"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Fix exit on success (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/116"},"#116")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"221"},"2.2.1"),(0,i.kt)("h3",{id:"patch-changes-1"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-92"},"PUB-92")," - Improve error handling and add custom fail function (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/113"},"#113")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Update lock file (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/114"},"#114")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"220"},"2.2.0"),(0,i.kt)("h3",{id:"minor-changes"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-90"},"PUB-90")," - Add support for gzip compression/decompression (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/107"},"#107")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rndD"},"@rndD"),")")),(0,i.kt)("h3",{id:"patch-changes-2"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-85"},"PUB-85")," - Load subscriptions in parallel (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/105"},"#105")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rndD"},"@rndD"),")")),(0,i.kt)("h2",{id:"212"},"2.1.2"),(0,i.kt)("h3",{id:"patch-changes-3"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-88"},"PUB-88")," - Pin dependencies to specific versions (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/92"},"#92")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"211"},"2.1.1"),(0,i.kt)("h3",{id:"patch-changes-4"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Prefer GOOGLE_CLOUD_LABELS over PUBSUB_LABELS env var (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/90"},"#90")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"210"},"2.1.0"),(0,i.kt)("h3",{id:"minor-changes-1"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-84"},"PUB-84")," - Add support for labels to subscirptions (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/88"},"#88")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"201"},"2.0.1"),(0,i.kt)("h3",{id:"patch-changes-5"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-72"},"PUB-72")," - Divide subscriptions among multiple clients (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/86"},"#86")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"200"},"2.0.0"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://deliveryhero.github.io/hfc-pubsub/guides/migrating-to-v2"},"Migration Guide")),(0,i.kt)("h3",{id:"\ufe0f-major-changes-\ufe0f"},"\u26a0\ufe0f Major Changes \u26a0\ufe0f"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-68"},"PUB-68")," - Set min supported node version as 12.22 (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/72"},"#72")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-52"},"PUB-52")," - Remove ",(0,i.kt)("inlineCode",{parentName:"p"},"grpc")," (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/57"},"#57")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-48"},"PUB-48")," - Topic class now uses static properties and generics (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/81"},"#81")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-77"},"PUB-77")," - Misc Changes (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/84"},"#84")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"),(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Change project-id env var to ",(0,i.kt)("inlineCode",{parentName:"li"},"GOOGLE_CLOUD_PROJECT")),(0,i.kt)("li",{parentName:"ul"},"Removed export of private methods"),(0,i.kt)("li",{parentName:"ul"},"Refactor internals"),(0,i.kt)("li",{parentName:"ul"},"Change ",(0,i.kt)("inlineCode",{parentName:"li"},"ackDeadlineSeconds")," to ",(0,i.kt)("inlineCode",{parentName:"li"},"ackDeadline")),(0,i.kt)("li",{parentName:"ul"},"Add ",(0,i.kt)("inlineCode",{parentName:"li"},"metadata")," to default error handler"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-65"},"PUB-65")," - Remove deprecated code (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/66"},"#66")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h3",{id:"minor-changes-2"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-73"},"PUB-73")," - Add/improve helpers and TS usage(",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/79"},"#79")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Allows to make ",(0,i.kt)("inlineCode",{parentName:"li"},"_timestamp")," optional"),(0,i.kt)("li",{parentName:"ol"},"Removes double validation of topic names."),(0,i.kt)("li",{parentName:"ol"},"Use ",(0,i.kt)("inlineCode",{parentName:"li"},"publishJSON")," instead of buffering the payload."),(0,i.kt)("li",{parentName:"ol"},"Adds ",(0,i.kt)("inlineCode",{parentName:"li"},".toJSON")," method to get parsed message/"),(0,i.kt)("li",{parentName:"ol"},"Remove getters (like getProjects, getName, getClient) and just use ",(0,i.kt)("inlineCode",{parentName:"li"},"this.projects"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"this.name"),", etc directly."))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-69"},"PUB-69")," - Changed init position for ",(0,i.kt)("inlineCode",{parentName:"p"},"SubscriptionService.instance")," (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/77"},"#77")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"))),(0,i.kt)("h3",{id:"patch-changes-6"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-75"},"PUB-75")," - Using yarn instead of npm (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/83"},"#83")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-69"},"PUB-69")," - Throws error in case no subs found or wrong ",(0,i.kt)("inlineCode",{parentName:"p"},"PUBSUB_ROOT_DIR")," env defined (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/76"},"#76")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"))),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Full Changelog: ",(0,i.kt)("a",{parentName:"strong",href:"https://github.com/deliveryhero/hfc-pubsub/compare/v1.11.0...v2.0.0"},"v1.11.0...v2.0.0"))),(0,i.kt)("h2",{id:"1110"},"1.11.0"),(0,i.kt)("h3",{id:"minor-changes-3"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Adds optional health check server to tell if all subs are open or not (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/73"},"#73")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-71"},"PUB-71")," - Add Subscription level handleError method (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/75"},"#75")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ketan-saxena"},"@ketan-saxena"),")"))),(0,i.kt)("h3",{id:"patch-changes-7"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-64"},"PUB-64")," - Update dependencies (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/78"},"#78")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"1104"},"1.10.4"),(0,i.kt)("h3",{id:"patch-changes-8"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-60"},"PUB-60")," - Deprecate v1,v2 style Subscriber classes (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/64"},"#64")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-66"},"PUB-66")," - Fix close method creating new subscription instance rather than closing existing one (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/63"},"#63")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1103"},"1.10.3"),(0,i.kt)("h3",{id:"patch-changes-9"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-52"},"PUB-52")," - Deprecate native grpc usage (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/58"},"#58")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Allows setting up env variables through CLI args (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/61"},"#61")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-50"},"PUB-50")," - Update documentation (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/60"},"#60")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1102"},"1.10.2"),(0,i.kt)("h3",{id:"patch-changes-10"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Update google-cloud/pubsub package version (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/55"},"#55")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ketan-saxena"},"@ketan-saxena"),")")),(0,i.kt)("h2",{id:"1101"},"1.10.1"),(0,i.kt)("h3",{id:"patch-changes-11"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Undoes logger changes for list cli (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/48"},"#48")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Upgrade dependencies (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/51"},"#51")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1100"},"1.10.0"),(0,i.kt)("h3",{id:"minor-changes-4"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-44"},"PUB-44")," - Added option to add custom logger (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/45"},"#45")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("h3",{id:"patch-changes-12"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-44"},"PUB-44")," - Add changesets to manage versioning (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/44"},"#44")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"190"},"1.9.0"),(0,i.kt)("h3",{id:"minor-changes-5"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-47"},"PUB-47")," - Optimized DLQ configuration making PROJECT_NUMBER optional for assigning Publisher, Subscriber roles and allowing default subscription creation as a part of DLQ configuration (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/43"},"#43")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("h2",{id:"181"},"1.8.1"),(0,i.kt)("h3",{id:"patch-changes-13"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-46"},"PUB-46")," - Allow multiple entry points without checking for folder (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/42"},"#42")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"180"},"1.8.0"),(0,i.kt)("h3",{id:"minor-changes-6"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-42"},"PUB-42")," - Add attributes option to publish command in Topic (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/41"},"#41")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h3",{id:"patch-changes-14"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-34"},"PUB-34")," - Update subscriber metadata for existing subscriptions (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/32"},"#32")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-43"},"PUB-43")," - Attach subscriber metadata to error object in case unable to start subscription (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/39"},"#39")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1712"},"1.7.12"),(0,i.kt)("h3",{id:"patch-changes-15"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Fix build due to invalid import paths (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/38"},"#38")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-31"},"PUB-31")," - Add close method for graceful shutdowns (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/20"},"#20")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9beb87c2.fc40b1f0.js b/assets/js/9beb87c2.fc40b1f0.js new file mode 100644 index 00000000..df3a489d --- /dev/null +++ b/assets/js/9beb87c2.fc40b1f0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[80],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>m});var r=a(7294);function h(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function n(e){for(var t=1;t=0||(h[a]=e[a]);return h}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(h[a]=e[a])}return h}var l=r.createContext({}),o=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):n(n({},t),e)),a},s=function(e){var t=o(e.components);return r.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,h=e.mdxType,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=o(a),m=h,d=u["".concat(l,".").concat(m)]||u[m]||c[m]||i;return a?r.createElement(d,n(n({ref:t},s),{},{components:a})):r.createElement(d,n({ref:t},s))}));function m(e,t){var a=arguments,h=t&&t.mdxType;if("string"==typeof e||h){var i=a.length,n=new Array(i);n[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:h,n[1]=p;for(var o=2;o{a.r(t),a.d(t,{default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var r=a(7462),h=a(3366),i=(a(7294),a(3905)),n=["components"],p={},l={unversionedId:"changelog",id:"changelog",isDocsHomePage:!1,title:"Changelog",description:"2.3.0",source:"@site/docs/changelog.md",sourceDirName:".",slug:"/changelog",permalink:"/hfc-pubsub/changelog",editUrl:"https://github.com/deliveryhero/hfc-pubsub/edit/main/docs/changelog.md",version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Interface: TopicOptions",permalink:"/hfc-pubsub/api/interfaces/TopicOptions"}},o=[{value:"2.3.0",id:"230",children:[{value:"Minor Changes",id:"minor-changes",children:[]},{value:"Patch Changes",id:"patch-changes",children:[]}]},{value:"2.2.2",id:"222",children:[{value:"Patch Changes",id:"patch-changes-1",children:[]}]},{value:"2.2.1",id:"221",children:[{value:"Patch Changes",id:"patch-changes-2",children:[]}]},{value:"2.2.0",id:"220",children:[{value:"Minor Changes",id:"minor-changes-1",children:[]},{value:"Patch Changes",id:"patch-changes-3",children:[]}]},{value:"2.1.2",id:"212",children:[{value:"Patch Changes",id:"patch-changes-4",children:[]}]},{value:"2.1.1",id:"211",children:[{value:"Patch Changes",id:"patch-changes-5",children:[]}]},{value:"2.1.0",id:"210",children:[{value:"Minor Changes",id:"minor-changes-2",children:[]}]},{value:"2.0.1",id:"201",children:[{value:"Patch Changes",id:"patch-changes-6",children:[]}]},{value:"2.0.0",id:"200",children:[{value:"\u26a0\ufe0f Major Changes \u26a0\ufe0f",id:"\ufe0f-major-changes-\ufe0f",children:[]},{value:"Minor Changes",id:"minor-changes-3",children:[]},{value:"Patch Changes",id:"patch-changes-7",children:[]}]},{value:"1.11.0",id:"1110",children:[{value:"Minor Changes",id:"minor-changes-4",children:[]},{value:"Patch Changes",id:"patch-changes-8",children:[]}]},{value:"1.10.4",id:"1104",children:[{value:"Patch Changes",id:"patch-changes-9",children:[]}]},{value:"1.10.3",id:"1103",children:[{value:"Patch Changes",id:"patch-changes-10",children:[]}]},{value:"1.10.2",id:"1102",children:[{value:"Patch Changes",id:"patch-changes-11",children:[]}]},{value:"1.10.1",id:"1101",children:[{value:"Patch Changes",id:"patch-changes-12",children:[]}]},{value:"1.10.0",id:"1100",children:[{value:"Minor Changes",id:"minor-changes-5",children:[]},{value:"Patch Changes",id:"patch-changes-13",children:[]}]},{value:"1.9.0",id:"190",children:[{value:"Minor Changes",id:"minor-changes-6",children:[]}]},{value:"1.8.1",id:"181",children:[{value:"Patch Changes",id:"patch-changes-14",children:[]}]},{value:"1.8.0",id:"180",children:[{value:"Minor Changes",id:"minor-changes-7",children:[]},{value:"Patch Changes",id:"patch-changes-15",children:[]}]},{value:"1.7.12",id:"1712",children:[{value:"Patch Changes",id:"patch-changes-16",children:[]}]}],s={toc:o};function c(e){var t=e.components,a=(0,h.Z)(e,n);return(0,i.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"230"},"2.3.0"),(0,i.kt)("h3",{id:"minor-changes"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-93"},"PUB-93")," - Set labels for subscriptions, dlq on update too and support for labels to topics (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/130"},"#130")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h3",{id:"patch-changes"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Fix topic options default retry config not being applied if custom options provided (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/130"},"#130")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-87"},"PUB-87")," - Update logging to be more structured (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/130"},"#130")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"222"},"2.2.2"),(0,i.kt)("h3",{id:"patch-changes-1"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Fix exit on success (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/116"},"#116")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"221"},"2.2.1"),(0,i.kt)("h3",{id:"patch-changes-2"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-92"},"PUB-92")," - Improve error handling and add custom fail function (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/113"},"#113")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Update lock file (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/114"},"#114")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"220"},"2.2.0"),(0,i.kt)("h3",{id:"minor-changes-1"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-90"},"PUB-90")," - Add support for gzip compression/decompression (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/107"},"#107")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rndD"},"@rndD"),")")),(0,i.kt)("h3",{id:"patch-changes-3"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-85"},"PUB-85")," - Load subscriptions in parallel (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/105"},"#105")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rndD"},"@rndD"),")")),(0,i.kt)("h2",{id:"212"},"2.1.2"),(0,i.kt)("h3",{id:"patch-changes-4"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-88"},"PUB-88")," - Pin dependencies to specific versions (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/92"},"#92")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"211"},"2.1.1"),(0,i.kt)("h3",{id:"patch-changes-5"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Prefer GOOGLE_CLOUD_LABELS over PUBSUB_LABELS env var (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/90"},"#90")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"210"},"2.1.0"),(0,i.kt)("h3",{id:"minor-changes-2"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-84"},"PUB-84")," - Add support for labels to subscirptions (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/88"},"#88")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"201"},"2.0.1"),(0,i.kt)("h3",{id:"patch-changes-6"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-72"},"PUB-72")," - Divide subscriptions among multiple clients (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/86"},"#86")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"200"},"2.0.0"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://deliveryhero.github.io/hfc-pubsub/guides/migrating-to-v2"},"Migration Guide")),(0,i.kt)("h3",{id:"\ufe0f-major-changes-\ufe0f"},"\u26a0\ufe0f Major Changes \u26a0\ufe0f"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-68"},"PUB-68")," - Set min supported node version as 12.22 (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/72"},"#72")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-52"},"PUB-52")," - Remove ",(0,i.kt)("inlineCode",{parentName:"p"},"grpc")," (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/57"},"#57")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-48"},"PUB-48")," - Topic class now uses static properties and generics (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/81"},"#81")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-77"},"PUB-77")," - Misc Changes (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/84"},"#84")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"),(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Change project-id env var to ",(0,i.kt)("inlineCode",{parentName:"li"},"GOOGLE_CLOUD_PROJECT")),(0,i.kt)("li",{parentName:"ul"},"Removed export of private methods"),(0,i.kt)("li",{parentName:"ul"},"Refactor internals"),(0,i.kt)("li",{parentName:"ul"},"Change ",(0,i.kt)("inlineCode",{parentName:"li"},"ackDeadlineSeconds")," to ",(0,i.kt)("inlineCode",{parentName:"li"},"ackDeadline")),(0,i.kt)("li",{parentName:"ul"},"Add ",(0,i.kt)("inlineCode",{parentName:"li"},"metadata")," to default error handler"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-65"},"PUB-65")," - Remove deprecated code (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/66"},"#66")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h3",{id:"minor-changes-3"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-73"},"PUB-73")," - Add/improve helpers and TS usage(",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/79"},"#79")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Allows to make ",(0,i.kt)("inlineCode",{parentName:"li"},"_timestamp")," optional"),(0,i.kt)("li",{parentName:"ol"},"Removes double validation of topic names."),(0,i.kt)("li",{parentName:"ol"},"Use ",(0,i.kt)("inlineCode",{parentName:"li"},"publishJSON")," instead of buffering the payload."),(0,i.kt)("li",{parentName:"ol"},"Adds ",(0,i.kt)("inlineCode",{parentName:"li"},".toJSON")," method to get parsed message/"),(0,i.kt)("li",{parentName:"ol"},"Remove getters (like getProjects, getName, getClient) and just use ",(0,i.kt)("inlineCode",{parentName:"li"},"this.projects"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"this.name"),", etc directly."))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-69"},"PUB-69")," - Changed init position for ",(0,i.kt)("inlineCode",{parentName:"p"},"SubscriptionService.instance")," (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/77"},"#77")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"))),(0,i.kt)("h3",{id:"patch-changes-7"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-75"},"PUB-75")," - Using yarn instead of npm (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/83"},"#83")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-69"},"PUB-69")," - Throws error in case no subs found or wrong ",(0,i.kt)("inlineCode",{parentName:"p"},"PUBSUB_ROOT_DIR")," env defined (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/76"},"#76")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")"))),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Full Changelog: ",(0,i.kt)("a",{parentName:"strong",href:"https://github.com/deliveryhero/hfc-pubsub/compare/v1.11.0...v2.0.0"},"v1.11.0...v2.0.0"))),(0,i.kt)("h2",{id:"1110"},"1.11.0"),(0,i.kt)("h3",{id:"minor-changes-4"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Adds optional health check server to tell if all subs are open or not (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/73"},"#73")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-71"},"PUB-71")," - Add Subscription level handleError method (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/75"},"#75")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ketan-saxena"},"@ketan-saxena"),")"))),(0,i.kt)("h3",{id:"patch-changes-8"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-64"},"PUB-64")," - Update dependencies (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/78"},"#78")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"1104"},"1.10.4"),(0,i.kt)("h3",{id:"patch-changes-9"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-60"},"PUB-60")," - Deprecate v1,v2 style Subscriber classes (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/64"},"#64")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-66"},"PUB-66")," - Fix close method creating new subscription instance rather than closing existing one (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/63"},"#63")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1103"},"1.10.3"),(0,i.kt)("h3",{id:"patch-changes-10"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-52"},"PUB-52")," - Deprecate native grpc usage (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/58"},"#58")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Allows setting up env variables through CLI args (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/61"},"#61")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-50"},"PUB-50")," - Update documentation (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/60"},"#60")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1102"},"1.10.2"),(0,i.kt)("h3",{id:"patch-changes-11"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Update google-cloud/pubsub package version (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/55"},"#55")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ketan-saxena"},"@ketan-saxena"),")")),(0,i.kt)("h2",{id:"1101"},"1.10.1"),(0,i.kt)("h3",{id:"patch-changes-12"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Undoes logger changes for list cli (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/48"},"#48")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Upgrade dependencies (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/51"},"#51")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1100"},"1.10.0"),(0,i.kt)("h3",{id:"minor-changes-5"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-44"},"PUB-44")," - Added option to add custom logger (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/45"},"#45")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("h3",{id:"patch-changes-13"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-44"},"PUB-44")," - Add changesets to manage versioning (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/44"},"#44")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"190"},"1.9.0"),(0,i.kt)("h3",{id:"minor-changes-6"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-47"},"PUB-47")," - Optimized DLQ configuration making PROJECT_NUMBER optional for assigning Publisher, Subscriber roles and allowing default subscription creation as a part of DLQ configuration (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/43"},"#43")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("h2",{id:"181"},"1.8.1"),(0,i.kt)("h3",{id:"patch-changes-14"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-46"},"PUB-46")," - Allow multiple entry points without checking for folder (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/42"},"#42")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h2",{id:"180"},"1.8.0"),(0,i.kt)("h3",{id:"minor-changes-7"},"Minor Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://jira.deliveryhero.com/browse/PUB-42"},"PUB-42")," - Add attributes option to publish command in Topic (",(0,i.kt)("a",{parentName:"li",href:"https://github.com/deliveryhero/hfc-pubsub/pull/41"},"#41")," by ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("h3",{id:"patch-changes-15"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-34"},"PUB-34")," - Update subscriber metadata for existing subscriptions (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/32"},"#32")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ishan123456789"},"@ishan123456789"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-43"},"PUB-43")," - Attach subscriber metadata to error object in case unable to start subscription (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/39"},"#39")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))),(0,i.kt)("h2",{id:"1712"},"1.7.12"),(0,i.kt)("h3",{id:"patch-changes-16"},"Patch Changes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Fix build due to invalid import paths (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/38"},"#38")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"https://jira.deliveryhero.com/browse/PUB-31"},"PUB-31")," - Add close method for graceful shutdowns (",(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/pull/20"},"#20")," by ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rohit-gohri"},"@rohit-gohri"),")"))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a8bbf00a.330c4b11.js b/assets/js/a8bbf00a.6967af67.js similarity index 94% rename from assets/js/a8bbf00a.330c4b11.js rename to assets/js/a8bbf00a.6967af67.js index e090d2b9..ccfd1277 100644 --- a/assets/js/a8bbf00a.330c4b11.js +++ b/assets/js/a8bbf00a.6967af67.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[8116],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),k=d(a),u=r,c=k["".concat(p,".").concat(u)]||k[u]||m[u]||i;return a?n.createElement(c,l(l({ref:t},o),{},{components:a})):n.createElement(c,l({ref:t},o))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var d=2;d{a.r(t),a.d(t,{default:()=>m,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var n=a(7462),r=a(3366),i=(a(7294),a(3905)),l=["components"],s={id:"Message",title:"Class: Message",sidebar_label:"Message",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/Message",id:"api/classes/Message",isDocsHomePage:!1,title:"Class: Message",description:"Type parameters",source:"@site/docs/api/classes/Message.md",sourceDirName:"api/classes",slug:"/api/classes/Message",permalink:"/hfc-pubsub/api/classes/Message",editUrl:null,version:"current",sidebar_label:"Message",sidebarPosition:0,frontMatter:{id:"Message",title:"Class: Message",sidebar_label:"Message",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"@honestfoodcompany/pubsub",permalink:"/hfc-pubsub/api/"},next:{title:"Class: PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService"}},d=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"data",id:"data",children:[]},{value:"gCloudMessage",id:"gcloudmessage",children:[]}]},{value:"Methods",id:"methods",children:[{value:"ack",id:"ack",children:[]},{value:"decompress",id:"decompress",children:[]},{value:"modAck",id:"modack",children:[]},{value:"nack",id:"nack",children:[]},{value:"toJSON",id:"tojson",children:[]},{value:"from",id:"from",children:[]},{value:"fromGCloud",id:"fromgcloud",children:[]}]}],o={toc:d};function m(e){var t=e.components,a=(0,r.Z)(e,l);return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h2",{id:"constructors"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new Message"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","()"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"data"},"data"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L6"},"src/message/index.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"gcloudmessage"},"gCloudMessage"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"gCloudMessage"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Message")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L7"},"src/message/index.ts:7")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"ack"},"ack"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"ack"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L39"},"src/message/index.ts:39")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"decompress"},"decompress"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"decompress"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L57"},"src/message/index.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modack"},"modAck"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"modAck"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"deadline"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"deadline")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L45"},"src/message/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nack"},"nack"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"nack"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L51"},"src/message/index.ts:51")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tojson"},"toJSON"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toJSON"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L31"},"src/message/index.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"from"},"from"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"from"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">"),(0,i.kt)("p",null,"Builds a new message object in the synchronous driver.\nUsed by the eventBus."),(0,i.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"M"))))),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"M")),(0,i.kt)("td",{parentName:"tr",align:"left"},"any message that can be buffered")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L14"},"src/message/index.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fromgcloud"},"fromGCloud"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"fromGCloud"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Builds a message for Google Cloud Driver"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Message")),(0,i.kt)("td",{parentName:"tr",align:"left"},"A valid Google Cloud message")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/message/index.ts#L24"},"src/message/index.ts:24")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[8116],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),k=d(a),u=r,c=k["".concat(p,".").concat(u)]||k[u]||m[u]||i;return a?n.createElement(c,l(l({ref:t},o),{},{components:a})):n.createElement(c,l({ref:t},o))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var d=2;d{a.r(t),a.d(t,{default:()=>m,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var n=a(7462),r=a(3366),i=(a(7294),a(3905)),l=["components"],s={id:"Message",title:"Class: Message",sidebar_label:"Message",sidebar_position:0,custom_edit_url:null},p={unversionedId:"api/classes/Message",id:"api/classes/Message",isDocsHomePage:!1,title:"Class: Message",description:"Type parameters",source:"@site/docs/api/classes/Message.md",sourceDirName:"api/classes",slug:"/api/classes/Message",permalink:"/hfc-pubsub/api/classes/Message",editUrl:null,version:"current",sidebar_label:"Message",sidebarPosition:0,frontMatter:{id:"Message",title:"Class: Message",sidebar_label:"Message",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"@honestfoodcompany/pubsub",permalink:"/hfc-pubsub/api/"},next:{title:"Class: PubSubService",permalink:"/hfc-pubsub/api/classes/PubSubService"}},d=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Constructors",id:"constructors",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties",children:[{value:"data",id:"data",children:[]},{value:"gCloudMessage",id:"gcloudmessage",children:[]}]},{value:"Methods",id:"methods",children:[{value:"ack",id:"ack",children:[]},{value:"decompress",id:"decompress",children:[]},{value:"modAck",id:"modack",children:[]},{value:"nack",id:"nack",children:[]},{value:"toJSON",id:"tojson",children:[]},{value:"from",id:"from",children:[]},{value:"fromGCloud",id:"fromgcloud",children:[]}]}],o={toc:d};function m(e){var t=e.components,a=(0,r.Z)(e,l);return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h2",{id:"constructors"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new Message"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","()"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"data"},"data"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L6"},"src/message/index.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"gcloudmessage"},"gCloudMessage"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"gCloudMessage"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Message")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L7"},"src/message/index.ts:7")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"ack"},"ack"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"ack"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L39"},"src/message/index.ts:39")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"decompress"},"decompress"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"decompress"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Buffer")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L57"},"src/message/index.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modack"},"modAck"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"modAck"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"deadline"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"deadline")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L45"},"src/message/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nack"},"nack"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"nack"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L51"},"src/message/index.ts:51")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tojson"},"toJSON"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toJSON"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L31"},"src/message/index.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"from"},"from"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"from"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">"),(0,i.kt)("p",null,"Builds a new message object in the synchronous driver.\nUsed by the eventBus."),(0,i.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"M"))))),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"M")),(0,i.kt)("td",{parentName:"tr",align:"left"},"any message that can be buffered")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"M"),">"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L14"},"src/message/index.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fromgcloud"},"fromGCloud"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("strong",{parentName:"p"},"fromGCloud"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Builds a message for Google Cloud Driver"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Message")),(0,i.kt)("td",{parentName:"tr",align:"left"},"A valid Google Cloud message")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/message/index.ts#L24"},"src/message/index.ts:24")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bf56a78d.04f6a55e.js b/assets/js/bf56a78d.04f6a55e.js deleted file mode 100644 index 5df8a4bb..00000000 --- a/assets/js/bf56a78d.04f6a55e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[295],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),o=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=o(r),u=a,m=c["".concat(l,".").concat(u)]||c[u]||b[u]||i;return r?n.createElement(m,s(s({ref:t},d),{},{components:r})):n.createElement(m,s({ref:t},d))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=c;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:a,s[1]=p;for(var o=2;o{r.r(t),r.d(t,{default:()=>b,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var n=r(7462),a=r(3366),i=(r(7294),r(3905)),s=["components"],p={id:"SubscriberObject",title:"Interface: SubscriberObject",sidebar_label:"SubscriberObject",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/SubscriberObject",id:"api/interfaces/SubscriberObject",isDocsHomePage:!1,title:"Interface: SubscriberObject",description:"Type parameters",source:"@site/docs/api/interfaces/SubscriberObject.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject",editUrl:null,version:"current",sidebar_label:"SubscriberObject",sidebarPosition:0,frontMatter:{id:"SubscriberObject",title:"Interface: SubscriberObject",sidebar_label:"SubscriberObject",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata"},next:{title:"Interface: SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions"}},o=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Properties",id:"properties",children:[{value:"description",id:"description",children:[]},{value:"options",id:"options",children:[]},{value:"subscriptionName",id:"subscriptionname",children:[]},{value:"topicName",id:"topicname",children:[]}]},{value:"Methods",id:"methods",children:[{value:"handleError",id:"handleerror",children:[]},{value:"handleMessage",id:"handlemessage",children:[]},{value:"init",id:"init",children:[]}]}],d={toc:o};function b(e){var t=e.components,r=(0,a.Z)(e,s);return(0,i.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("a",{parentName:"p",href:"SubscriberMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"SubscriberMetadata")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"options"'),">")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"MessageHandler"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"FlexibleObject")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SubscriberObject"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"Omit.description"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L113"},"src/subscriber/subscriberV2.ts:113")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"options"},"options"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"options"),": ",(0,i.kt)("a",{parentName:"p",href:"SubscriberOptions"},(0,i.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L142"},"src/subscriber/subscriberV2.ts:142")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"subscriptionname"},"subscriptionName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"subscriptionName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"Omit.subscriptionName"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L111"},"src/subscriber/subscriberV2.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"topicname"},"topicName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"topicName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"Omit.topicName"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L110"},"src/subscriber/subscriberV2.ts:110")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"handleerror"},"handleError"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"handleError"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"If passed, it would serve as the error handler method for internal google pubsub errors"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"error")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"MessageHandler.handleError"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L130"},"src/subscriber/subscriberV2.ts:130")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"handlemessage"},"handleMessage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"handleMessage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"will run every time a message is received"),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../classes/Message"},(0,i.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"MessageHandler.handleMessage"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L120"},"src/subscriber/subscriberV2.ts:120")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"init"},"init"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"init"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"will run before the message handler is attached to the subscription"),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"MessageHandler.init"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L125"},"src/subscriber/subscriberV2.ts:125")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bf56a78d.d028db7d.js b/assets/js/bf56a78d.d028db7d.js new file mode 100644 index 00000000..f81e5090 --- /dev/null +++ b/assets/js/bf56a78d.d028db7d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[295],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=n.createContext({}),o=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},b=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),b=o(r),u=i,m=b["".concat(l,".").concat(u)]||b[u]||c[u]||a;return r?n.createElement(m,s(s({ref:t},d),{},{components:r})):n.createElement(m,s({ref:t},d))}));function u(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=r.length,s=new Array(a);s[0]=b;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:i,s[1]=p;for(var o=2;o{r.r(t),r.d(t,{default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var n=r(7462),i=r(3366),a=(r(7294),r(3905)),s=["components"],p={id:"SubscriberObject",title:"Interface: SubscriberObject",sidebar_label:"SubscriberObject",sidebar_position:0,custom_edit_url:null},l={unversionedId:"api/interfaces/SubscriberObject",id:"api/interfaces/SubscriberObject",isDocsHomePage:!1,title:"Interface: SubscriberObject",description:"Type parameters",source:"@site/docs/api/interfaces/SubscriberObject.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject",editUrl:null,version:"current",sidebar_label:"SubscriberObject",sidebarPosition:0,frontMatter:{id:"SubscriberObject",title:"Interface: SubscriberObject",sidebar_label:"SubscriberObject",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata"},next:{title:"Interface: SubscriberOptions",permalink:"/hfc-pubsub/api/interfaces/SubscriberOptions"}},o=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Properties",id:"properties",children:[{value:"description",id:"description",children:[]},{value:"options",id:"options",children:[]},{value:"subscriptionName",id:"subscriptionname",children:[]},{value:"topicName",id:"topicname",children:[]}]},{value:"Methods",id:"methods",children:[{value:"handleError",id:"handleerror",children:[]},{value:"handleMessage",id:"handlemessage",children:[]},{value:"init",id:"init",children:[]}]}],d={toc:o};function c(e){var t=e.components,r=(0,i.Z)(e,s);return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,a.kt)("a",{parentName:"p",href:"SubscriberMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberMetadata")),", ",(0,a.kt)("inlineCode",{parentName:"p"},'"options"'),">")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"MessageHandler"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"T"),">")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"FlexibleObject")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SubscriberObject"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Omit.description"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L113"},"src/subscriber/subscriberV2.ts:113")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("a",{parentName:"p",href:"SubscriberOptions"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L142"},"src/subscriber/subscriberV2.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscriptionname"},"subscriptionName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"subscriptionName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Omit.subscriptionName"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L111"},"src/subscriber/subscriberV2.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"topicname"},"topicName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"topicName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Omit.topicName"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L110"},"src/subscriber/subscriberV2.ts:110")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"handleerror"},"handleError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"handleError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"If passed, it would serve as the error handler method for internal google pubsub errors"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"MessageHandler.handleError"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L130"},"src/subscriber/subscriberV2.ts:130")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"handlemessage"},"handleMessage"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"handleMessage"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"will run every time a message is received"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../classes/Message"},(0,a.kt)("inlineCode",{parentName:"a"},"Message")),"<",(0,a.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"MessageHandler.handleMessage"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L120"},"src/subscriber/subscriberV2.ts:120")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"init"},"init"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"init"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"will run before the message handler is attached to the subscription"),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"MessageHandler.init"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L125"},"src/subscriber/subscriberV2.ts:125")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f0debbde.5593c65f.js b/assets/js/f0debbde.27c2f0a0.js similarity index 95% rename from assets/js/f0debbde.5593c65f.js rename to assets/js/f0debbde.27c2f0a0.js index 711ae259..cafde85a 100644 --- a/assets/js/f0debbde.5593c65f.js +++ b/assets/js/f0debbde.27c2f0a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[6047],{3905:(e,r,t)=>{t.d(r,{Zo:()=>b,kt:()=>d});var n=t(7294);function i(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function s(e){for(var r=1;r=0||(i[t]=e[t]);return i}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=n.createContext({}),p=function(e){var r=n.useContext(o),t=r;return e&&(t="function"==typeof e?e(r):s(s({},r),e)),t},b=function(e){var r=p(e.components);return n.createElement(o.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},l=n.forwardRef((function(e,r){var t=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),l=p(t),d=i,f=l["".concat(o,".").concat(d)]||l[d]||u[d]||a;return t?n.createElement(f,s(s({ref:r},b),{},{components:t})):n.createElement(f,s({ref:r},b))}));function d(e,r){var t=arguments,i=r&&r.mdxType;if("string"==typeof e||i){var a=t.length,s=new Array(a);s[0]=l;var c={};for(var o in r)hasOwnProperty.call(r,o)&&(c[o]=r[o]);c.originalType=e,c.mdxType="string"==typeof e?e:i,s[1]=c;for(var p=2;p{t.r(r),t.d(r,{default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var n=t(7462),i=t(3366),a=(t(7294),t(3905)),s=["components"],c={id:"SubscriberMetadata",title:"Interface: SubscriberMetadata",sidebar_label:"SubscriberMetadata",sidebar_position:0,custom_edit_url:null},o={unversionedId:"api/interfaces/SubscriberMetadata",id:"api/interfaces/SubscriberMetadata",isDocsHomePage:!1,title:"Interface: SubscriberMetadata",description:"Properties",source:"@site/docs/api/interfaces/SubscriberMetadata.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata",editUrl:null,version:"current",sidebar_label:"SubscriberMetadata",sidebarPosition:0,frontMatter:{id:"SubscriberMetadata",title:"Interface: SubscriberMetadata",sidebar_label:"SubscriberMetadata",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: Payload",permalink:"/hfc-pubsub/api/interfaces/Payload"},next:{title:"Interface: SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject"}},p=[{value:"Properties",id:"properties",children:[{value:"description",id:"description",children:[]},{value:"options",id:"options",children:[]},{value:"subscriptionName",id:"subscriptionname",children:[]},{value:"topicName",id:"topicname",children:[]}]}],b={toc:p};function u(e){var r=e.components,t=(0,i.Z)(e,s);return(0,a.kt)("wrapper",(0,n.Z)({},b,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L113"},"src/subscriber/subscriberV2.ts:113")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("a",{parentName:"p",href:"SubscriberOptions"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L112"},"src/subscriber/subscriberV2.ts:112")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscriptionname"},"subscriptionName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"subscriptionName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L111"},"src/subscriber/subscriberV2.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"topicname"},"topicName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"topicName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/aa6ea15/src/subscriber/subscriberV2.ts#L110"},"src/subscriber/subscriberV2.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[6047],{3905:(e,r,t)=>{t.d(r,{Zo:()=>b,kt:()=>d});var n=t(7294);function i(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function s(e){for(var r=1;r=0||(i[t]=e[t]);return i}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=n.createContext({}),p=function(e){var r=n.useContext(o),t=r;return e&&(t="function"==typeof e?e(r):s(s({},r),e)),t},b=function(e){var r=p(e.components);return n.createElement(o.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},l=n.forwardRef((function(e,r){var t=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),l=p(t),d=i,f=l["".concat(o,".").concat(d)]||l[d]||u[d]||a;return t?n.createElement(f,s(s({ref:r},b),{},{components:t})):n.createElement(f,s({ref:r},b))}));function d(e,r){var t=arguments,i=r&&r.mdxType;if("string"==typeof e||i){var a=t.length,s=new Array(a);s[0]=l;var c={};for(var o in r)hasOwnProperty.call(r,o)&&(c[o]=r[o]);c.originalType=e,c.mdxType="string"==typeof e?e:i,s[1]=c;for(var p=2;p{t.r(r),t.d(r,{default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var n=t(7462),i=t(3366),a=(t(7294),t(3905)),s=["components"],c={id:"SubscriberMetadata",title:"Interface: SubscriberMetadata",sidebar_label:"SubscriberMetadata",sidebar_position:0,custom_edit_url:null},o={unversionedId:"api/interfaces/SubscriberMetadata",id:"api/interfaces/SubscriberMetadata",isDocsHomePage:!1,title:"Interface: SubscriberMetadata",description:"Properties",source:"@site/docs/api/interfaces/SubscriberMetadata.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SubscriberMetadata",permalink:"/hfc-pubsub/api/interfaces/SubscriberMetadata",editUrl:null,version:"current",sidebar_label:"SubscriberMetadata",sidebarPosition:0,frontMatter:{id:"SubscriberMetadata",title:"Interface: SubscriberMetadata",sidebar_label:"SubscriberMetadata",sidebar_position:0,custom_edit_url:null},sidebar:"defaultSidebar",previous:{title:"Interface: Payload",permalink:"/hfc-pubsub/api/interfaces/Payload"},next:{title:"Interface: SubscriberObject",permalink:"/hfc-pubsub/api/interfaces/SubscriberObject"}},p=[{value:"Properties",id:"properties",children:[{value:"description",id:"description",children:[]},{value:"options",id:"options",children:[]},{value:"subscriptionName",id:"subscriptionname",children:[]},{value:"topicName",id:"topicname",children:[]}]}],b={toc:p};function u(e){var r=e.components,t=(0,i.Z)(e,s);return(0,a.kt)("wrapper",(0,n.Z)({},b,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L113"},"src/subscriber/subscriberV2.ts:113")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("a",{parentName:"p",href:"SubscriberOptions"},(0,a.kt)("inlineCode",{parentName:"a"},"SubscriberOptions"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L112"},"src/subscriber/subscriberV2.ts:112")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"subscriptionname"},"subscriptionName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"subscriptionName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L111"},"src/subscriber/subscriberV2.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"topicname"},"topicName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"topicName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/deliveryhero/hfc-pubsub/blob/5acfee6/src/subscriber/subscriberV2.ts#L110"},"src/subscriber/subscriberV2.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/main.ce3a225b.js b/assets/js/main.588d23b9.js similarity index 99% rename from assets/js/main.ce3a225b.js rename to assets/js/main.588d23b9.js index ca3cbb59..bdc92db4 100644 --- a/assets/js/main.ce3a225b.js +++ b/assets/js/main.588d23b9.js @@ -1,2 +1,2 @@ -/*! For license information please see main.ce3a225b.js.LICENSE.txt */ -(self.webpackChunk_honestfoodcompany_pubsub=self.webpackChunk_honestfoodcompany_pubsub||[]).push([[179],{9782:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r={title:"Pub/Sub Node.js Framework",tagline:"NodeJS Framework to add pubsub topics/subscriptions to your service",customFields:{meta:{description:"NodeJS Framework to add pubsub topics/subscriptions to your service"}},url:"https://deliveryhero.github.io",baseUrl:"/hfc-pubsub/",favicon:"img/favicon.png",presets:[["@docusaurus/preset-classic",{debug:!0,customCss:["/home/runner/work/hfc-pubsub/hfc-pubsub/docs/custom.css"],docs:{routeBasePath:"/",editUrl:"https://github.com/deliveryhero/hfc-pubsub/edit/main/",lastVersion:"current",versions:{current:{label:"v2"}}}}]],plugins:[["docusaurus-plugin-typedoc",{entryPoints:["./src/index.ts"],tsconfig:"./tsconfig.build.json"}]],themeConfig:{navbar:{title:"Pub/Sub Node.js Framework",items:[{label:"Docs",position:"left",to:"/"},{label:"API",to:"/api",position:"left"},{type:"docsVersionDropdown",position:"right",dropdownItemsBefore:[],dropdownItemsAfter:[]}],hideOnScroll:!1},footer:{logo:{alt:"HFC Logo",src:"img/hfc.png"},style:"dark",links:[{title:"Links",items:[{label:"NPM",href:"https://www.npmjs.com/package/@honestfoodcompany/pubsub/"},{label:"Github",href:"https://github.com/deliveryhero/hfc-pubsub"}]},{title:"About",items:[{label:"Honest Food Company",href:"https://www.honestfoodcompany.de/"},{label:"Delivery Hero",href:"https://www.deliveryhero.com/"}]}],copyright:'Copyright \xa9 2024 Delivery Hero HF Kitchens GmbH. Built with Docusaurus.'},colorMode:{defaultMode:"light",disableSwitch:!1,respectPrefersColorScheme:!1,switchConfig:{darkIcon:"\ud83c\udf1c",darkIconStyle:{},lightIcon:"\ud83c\udf1e",lightIconStyle:{}}},docs:{versionPersistence:"localStorage"},metadatas:[],prism:{additionalLanguages:[]},hideableSidebar:!1},baseUrlIssueBanner:!0,i18n:{defaultLocale:"en",locales:["en"],localeConfigs:{}},onBrokenLinks:"throw",onBrokenMarkdownLinks:"warn",onDuplicateRoutes:"warn",themes:[],titleDelimiter:"|",noIndex:!1}},9302:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r={"01704409":[function(){return n.e(6758).then(n.bind(n,1250))},"@site/versioned_docs/version-v1/api/classes/Topic.md",1250],"0907d9f1":[function(){return n.e(5389).then(n.bind(n,1773))},"@site/docs/publishing/Topics.md",1773],"0a17dca6":[function(){return n.e(2013).then(n.bind(n,3937))},"@site/docs/subscribing/Retry Policy.md",3937],"0a95e4bf":[function(){return n.e(1851).then(n.bind(n,9804))},"@site/versioned_docs/version-v1/api/classes/Subscriber.md",9804],"0dbda059":[function(){return n.e(6671).then(n.bind(n,3195))},"@site/docs/subscribing/Message Ordering.md",3195],"13caf63c":[function(){return n.e(835).then(n.bind(n,8582))},"@site/docs/api/interfaces/SubscriberOptions.md",8582],"14f4bfe4":[function(){return n.e(7265).then(n.bind(n,7979))},"@site/versioned_docs/version-v1/publishing/Retry Settings.md",7979],"157e1c0d":[function(){return n.e(139).then(n.bind(n,7588))},"@site/docs/api/interfaces/TopicOptions.md",7588],"15ffd0c8":[function(){return n.e(7104).then(n.bind(n,1449))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.BackoffSettings.md",1449],17896441:[function(){return Promise.all([n.e(532),n.e(5486),n.e(7918)]).then(n.bind(n,3852))},"@theme/DocItem",3852],"19371ada":[function(){return n.e(9114).then(n.bind(n,8262))},"@site/versioned_docs/version-v1/publishing/Publish Diff Project.md",8262],"1be78505":[function(){return Promise.all([n.e(532),n.e(5486),n.e(4608),n.e(9514)]).then(n.bind(n,6484))},"@theme/DocPage",6484],"1c01e663":[function(){return n.e(3680).then(n.bind(n,9098))},"@site/docs/api/interfaces/Payload.md",9098],"1ce1b65b":[function(){return n.e(4917).then(n.bind(n,5884))},"@site/docs/server/Custom Logger.md",5884],"23abe487":[function(){return Promise.all([n.e(532),n.e(9512),n.e(9627)]).then(n.bind(n,1718))},"@theme/DebugConfig",1718],"246f2c6f":[function(){return n.e(9285).then(n.t.bind(n,6267,19))},"~debug/default/docusaurus-debug-all-content-673.json",6267],"24bb654f":[function(){return n.e(7367).then(n.bind(n,4033))},"@site/docs/api/classes/SubscriptionService.md",4033],"269f7e80":[function(){return n.e(8714).then(n.bind(n,292))},"@site/versioned_docs/version-v1/server/Custom Logger.md",292],"30a3e7fd":[function(){return n.e(8390).then(n.bind(n,5254))},"@site/docs/publishing/Retry Settings.md",5254],"411fc1af":[function(){return n.e(8702).then(n.bind(n,5730))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.GooglePubSubProject.md",5730],"427b0a4e":[function(){return n.e(644).then(n.bind(n,9790))},"@site/docs/guides/Drivers.md",9790],"42c0a21a":[function(){return n.e(7197).then(n.bind(n,9292))},"@site/versioned_docs/version-v1/server/Connect Database.md",9292],"42e86e7d":[function(){return n.e(6194).then(n.bind(n,6732))},"@site/versioned_docs/version-v1/subscribing/Dead Letter Policy.md",6732],"431c6c56":[function(){return n.e(2915).then(n.bind(n,3801))},"@site/docs/subscribing/Internal Error Handling.md",3801],43331796:[function(){return n.e(4487).then(n.bind(n,6804))},"@site/versioned_docs/version-v1/Drivers.md",6804],"4ac416b0":[function(){return n.e(9833).then(n.bind(n,5184))},"@site/versioned_docs/version-v1/guides/Testing.md",5184],"5e8c322a":[function(){return n.e(7597).then(n.bind(n,3372))},"@site/docs/api/index.md",3372],"5f9e1e26":[function(){return n.e(1535).then(n.bind(n,8382))},"@site/docs/api/classes/PubSubService.md",8382],"635b1727":[function(){return n.e(7941).then(n.bind(n,3002))},"@site/versioned_docs/version-v1/server/Health Check.md",3002],"63864b9f":[function(){return n.e(588).then(n.bind(n,5209))},"@site/versioned_docs/version-v1/api/interfaces/SubscriberOptions.md",5209],"6401c6ac":[function(){return n.e(1581).then(n.bind(n,6586))},"@site/docs/api/classes/Topic.md",6586],"6794d4cd":[function(){return Promise.all([n.e(532),n.e(3102)]).then(n.bind(n,9710))},"@theme/DebugRegistry",9710],"689279c8":[function(){return n.e(3210).then(n.bind(n,6837))},"@site/docs/publishing/Attributes.md",6837],"68e633d4":[function(){return Promise.all([n.e(532),n.e(1843)]).then(n.bind(n,9765))},"@theme/DebugSiteMetadata",9765],"6abb989d":[function(){return n.e(9692).then(n.bind(n,9489))},"@site/docs/subscribing/Dead Letter Policy.md",9489],"6c0d0759":[function(){return n.e(759).then(n.bind(n,5066))},"@site/versioned_docs/version-v1/api/namespaces/Interfaces.md",5066],"71b2aef0":[function(){return n.e(6705).then(n.bind(n,9304))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.pubSubClient.md",9304],"744d0d66":[function(){return n.e(7086).then(n.bind(n,6818))},"@site/versioned_docs/version-v1/api/index.md",6818],"77234ab5":[function(){return n.e(9279).then(n.bind(n,5902))},"@site/docs/Options.md",5902],"7733b8cd":[function(){return n.e(8218).then(n.bind(n,3500))},"@site/versioned_docs/version-v1/api/classes/Message.md",3500],"79a01b9e":[function(){return n.e(9555).then(n.bind(n,2601))},"@site/versioned_docs/version-v1/server/Graceful Shutdown.md",2601],"7c2352f0":[function(){return n.e(5141).then(n.bind(n,2393))},"@site/versioned_docs/version-v1/subscribing/Message Ordering.md",2393],"7dbc7f38":[function(){return n.e(2327).then(n.bind(n,7544))},"@site/docs/subscribing/Messages Compression.md",7544],"87282cad":[function(){return n.e(9716).then(n.bind(n,2537))},"@site/docs/subscribing/Labels.md",2537],"919ef898":[function(){return n.e(4513).then(n.bind(n,5386))},"@site/versioned_docs/version-v1/CLI.md",5386],"92d188cf":[function(){return n.e(9919).then(n.bind(n,3939))},"@site/versioned_docs/version-v1/api/classes/SubscriptionService.md",3939],"935f2afb":[function(){return n.e(53).then(n.t.bind(n,1109,19))},"~docs/default/version-current-metadata-prop-751.json",1109],"946bd85a":[function(){return Promise.all([n.e(532),n.e(9512),n.e(616)]).then(n.bind(n,5376))},"@theme/DebugRoutes",5376],"94c1d431":[function(){return n.e(5880).then(n.bind(n,7571))},"@site/docs/publishing/Publish Diff Project.md",7571],"9893b3a0":[function(){return n.e(8520).then(n.bind(n,2884))},"@site/versioned_docs/version-v1/subscribing/Subscriptions.md",2884],"9beb87c2":[function(){return n.e(80).then(n.bind(n,7156))},"@site/docs/changelog.md",7156],a346ea81:[function(){return n.e(6144).then(n.bind(n,6792))},"@site/versioned_docs/version-v1/publishing/Attributes.md",6792],a8bbf00a:[function(){return n.e(8116).then(n.bind(n,9280))},"@site/docs/api/classes/Message.md",9280],a8f641c7:[function(){return n.e(9200).then(n.bind(n,747))},"@site/versioned_docs/version-v1/subscribing/Retry Policy.md",747],afbd15c8:[function(){return Promise.all([n.e(532),n.e(9445)]).then(n.bind(n,9019))},"@site/docs/guides/Migrating to v2.mdx",9019],ba8b3534:[function(){return Promise.all([n.e(532),n.e(9512),n.e(2983)]).then(n.bind(n,4709))},"@theme/DebugContent",4709],bbe72d6c:[function(){return n.e(7063).then(n.bind(n,7194))},"@site/docs/guides/CLI.md",7194],bf56a78d:[function(){return n.e(295).then(n.bind(n,3478))},"@site/docs/api/interfaces/SubscriberObject.md",3478],c10834c1:[function(){return n.e(5641).then(n.bind(n,2155))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.PublishOptions.md",2155],c40b1558:[function(){return n.e(3585).then(n.bind(n,2303))},"@site/versioned_docs/version-v1/api/interfaces/Payload.md",2303],c5321162:[function(){return n.e(695).then(n.bind(n,2888))},"@site/versioned_docs/version-v1/Options.md",2888],ca6a4924:[function(){return n.e(6873).then(n.bind(n,9159))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.RetryConfig.md",9159],ccccc4e2:[function(){return n.e(958).then(n.bind(n,4130))},"@site/versioned_docs/version-v1/api/classes/PubSubService.md",4130],cd8efe67:[function(){return n.e(250).then(n.bind(n,3398))},"@site/versioned_docs/version-v1/getting-started/Installation.md",3398],cde85646:[function(){return n.e(3527).then(n.bind(n,4980))},"@site/docs/server/Health Check.md",4980],ce7ebe9d:[function(){return n.e(132).then(n.bind(n,3124))},"@site/versioned_docs/version-v1/subscribing/Internal Error Handling.md",3124],da0304cc:[function(){return n.e(7396).then(n.bind(n,5652))},"@site/versioned_docs/version-v1/Introduction.md",5652],da3d64a8:[function(){return n.e(9049).then(n.bind(n,224))},"@site/docs/server/Graceful Shutdown.md",224],dc8c2cdd:[function(){return n.e(2674).then(n.bind(n,1791))},"@site/versioned_docs/version-v1/publishing/Topics.md",1791],deb0c6b2:[function(){return n.e(6121).then(n.bind(n,8028))},"@site/versioned_docs/version-v1/server/Service.md",8028],e0a19902:[function(){return n.e(394).then(n.bind(n,938))},"@site/docs/Introduction.md",938],e0b73bec:[function(){return n.e(1615).then(n.t.bind(n,319,19))},"~docs/default/version-v-1-metadata-prop-085.json",319],e2111aeb:[function(){return n.e(9812).then(n.bind(n,2407))},"@site/docs/server/Connect Database.md",2407],e269132a:[function(){return n.e(6337).then(n.bind(n,5885))},"@site/docs/subscribing/Subscriptions.md",5885],e38d0253:[function(){return n.e(5814).then(n.bind(n,1731))},"@site/docs/getting-started/Installation.md",1731],eb18d9cc:[function(){return n.e(3642).then(n.bind(n,754))},"@site/docs/server/Service.md",754],ede3a018:[function(){return Promise.all([n.e(532),n.e(9512),n.e(5127)]).then(n.bind(n,9205))},"@theme/DebugGlobalData",9205],f0debbde:[function(){return n.e(6047).then(n.bind(n,9227))},"@site/docs/api/interfaces/SubscriberMetadata.md",9227],fc4bded5:[function(){return n.e(2342).then(n.bind(n,7201))},"@site/docs/guides/Testing.md",7201],fcb40a64:[function(){return n.e(2053).then(n.bind(n,966))},"@site/versioned_docs/version-v1/api/interfaces/Interfaces.TopicPublishOptions.md",966]}},1858:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7294),a=n(2203),i=n.n(a);const o=function(e){var t=e.error,n=e.retry,a=e.pastDelay;return t?r.createElement("div",{style:{align:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,t.message),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null};var l=n(6887),s=n(9302),u=n(9670);const c=function(e,t){if("*"===e)return i()({loading:o,loader:function(){return Promise.all([n.e(532),n.e(5486),n.e(4608)]).then(n.bind(n,4608))}});var a=l[e+"-"+t],c=[],d=[],p={},f=(0,u.Z)(a);return Object.keys(f).forEach((function(e){var t=s.Z[f[e]];t&&(p[e]=t[0],c.push(t[1]),d.push(t[2]))})),i().Map({loading:o,loader:p,modules:c,webpack:function(){return d},render:function(e,t){var n=JSON.parse(JSON.stringify(a));Object.keys(e).forEach((function(t){for(var r=n,a=t.split("."),i=0;i{"use strict";var r=n(7294),a=n(3935),i=n(3727),o=n(1858),l=n(412),s=n(9782);const u=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/hfc-pubsub/","versions":[{"name":"current","label":"v2","isLast":true,"path":"/hfc-pubsub/","mainDocId":"introduction","docs":[{"id":"api/classes/Message","path":"/hfc-pubsub/api/classes/Message","sidebar":"defaultSidebar"},{"id":"api/classes/PubSubService","path":"/hfc-pubsub/api/classes/PubSubService","sidebar":"defaultSidebar"},{"id":"api/classes/SubscriptionService","path":"/hfc-pubsub/api/classes/SubscriptionService","sidebar":"defaultSidebar"},{"id":"api/classes/Topic","path":"/hfc-pubsub/api/classes/Topic","sidebar":"defaultSidebar"},{"id":"api/index","path":"/hfc-pubsub/api/","sidebar":"defaultSidebar"},{"id":"api/interfaces/Payload","path":"/hfc-pubsub/api/interfaces/Payload","sidebar":"defaultSidebar"},{"id":"api/interfaces/SubscriberMetadata","path":"/hfc-pubsub/api/interfaces/SubscriberMetadata","sidebar":"defaultSidebar"},{"id":"api/interfaces/SubscriberObject","path":"/hfc-pubsub/api/interfaces/SubscriberObject","sidebar":"defaultSidebar"},{"id":"api/interfaces/SubscriberOptions","path":"/hfc-pubsub/api/interfaces/SubscriberOptions","sidebar":"defaultSidebar"},{"id":"api/interfaces/TopicOptions","path":"/hfc-pubsub/api/interfaces/TopicOptions","sidebar":"defaultSidebar"},{"id":"changelog","path":"/hfc-pubsub/changelog","sidebar":"defaultSidebar"},{"id":"getting-started/installation","path":"/hfc-pubsub/getting-started/installation","sidebar":"defaultSidebar"},{"id":"guides/cli","path":"/hfc-pubsub/guides/cli","sidebar":"defaultSidebar"},{"id":"guides/drivers","path":"/hfc-pubsub/guides/drivers","sidebar":"defaultSidebar"},{"id":"guides/migrating-to-v2","path":"/hfc-pubsub/guides/migrating-to-v2","sidebar":"defaultSidebar"},{"id":"guides/testing","path":"/hfc-pubsub/guides/testing","sidebar":"defaultSidebar"},{"id":"introduction","path":"/hfc-pubsub/","sidebar":"defaultSidebar"},{"id":"options","path":"/hfc-pubsub/options","sidebar":"defaultSidebar"},{"id":"publishing/attributes","path":"/hfc-pubsub/publishing/attributes","sidebar":"defaultSidebar"},{"id":"publishing/publish-diff-project","path":"/hfc-pubsub/publishing/publish-diff-project","sidebar":"defaultSidebar"},{"id":"publishing/retry-settings","path":"/hfc-pubsub/publishing/retry-settings","sidebar":"defaultSidebar"},{"id":"publishing/topics","path":"/hfc-pubsub/publishing/topics","sidebar":"defaultSidebar"},{"id":"server/connect-database","path":"/hfc-pubsub/server/connect-database","sidebar":"defaultSidebar"},{"id":"server/custom-logger","path":"/hfc-pubsub/server/custom-logger","sidebar":"defaultSidebar"},{"id":"server/graceful-shutdown","path":"/hfc-pubsub/server/graceful-shutdown","sidebar":"defaultSidebar"},{"id":"server/health-check","path":"/hfc-pubsub/server/health-check","sidebar":"defaultSidebar"},{"id":"server/service","path":"/hfc-pubsub/server/service","sidebar":"defaultSidebar"},{"id":"subscribing/dead-letter-policy","path":"/hfc-pubsub/subscribing/dead-letter-policy","sidebar":"defaultSidebar"},{"id":"subscribing/error-handling","path":"/hfc-pubsub/subscribing/error-handling","sidebar":"defaultSidebar"},{"id":"subscribing/labels","path":"/hfc-pubsub/subscribing/labels","sidebar":"defaultSidebar"},{"id":"subscribing/message-ordering","path":"/hfc-pubsub/subscribing/message-ordering","sidebar":"defaultSidebar"},{"id":"subscribing/Messages_compression","path":"/hfc-pubsub/subscribing/Messages_compression","sidebar":"defaultSidebar"},{"id":"subscribing/retry-policy","path":"/hfc-pubsub/subscribing/retry-policy","sidebar":"defaultSidebar"},{"id":"subscribing/subscriptions","path":"/hfc-pubsub/subscribing/subscriptions","sidebar":"defaultSidebar"}]},{"name":"v1","label":"v1","isLast":false,"path":"/hfc-pubsub/v1","mainDocId":"introduction","docs":[{"id":"api/classes/Message","path":"/hfc-pubsub/v1/api/classes/Message","sidebar":"version-v1/defaultSidebar"},{"id":"api/classes/PubSubService","path":"/hfc-pubsub/v1/api/classes/PubSubService","sidebar":"version-v1/defaultSidebar"},{"id":"api/classes/Subscriber","path":"/hfc-pubsub/v1/api/classes/Subscriber","sidebar":"version-v1/defaultSidebar"},{"id":"api/classes/SubscriptionService","path":"/hfc-pubsub/v1/api/classes/SubscriptionService","sidebar":"version-v1/defaultSidebar"},{"id":"api/classes/Topic","path":"/hfc-pubsub/v1/api/classes/Topic","sidebar":"version-v1/defaultSidebar"},{"id":"api/index","path":"/hfc-pubsub/v1/api/","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.BackoffSettings","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.BackoffSettings","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.GooglePubSubProject","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.GooglePubSubProject","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.PublishOptions","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.PublishOptions","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.pubSubClient","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.pubSubClient","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.RetryConfig","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.RetryConfig","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Interfaces.TopicPublishOptions","path":"/hfc-pubsub/v1/api/interfaces/Interfaces.TopicPublishOptions","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/Payload","path":"/hfc-pubsub/v1/api/interfaces/Payload","sidebar":"version-v1/defaultSidebar"},{"id":"api/interfaces/SubscriberOptions","path":"/hfc-pubsub/v1/api/interfaces/SubscriberOptions","sidebar":"version-v1/defaultSidebar"},{"id":"api/namespaces/Interfaces","path":"/hfc-pubsub/v1/api/namespaces/Interfaces","sidebar":"version-v1/defaultSidebar"},{"id":"cli","path":"/hfc-pubsub/v1/cli","sidebar":"version-v1/defaultSidebar"},{"id":"drivers","path":"/hfc-pubsub/v1/drivers","sidebar":"version-v1/defaultSidebar"},{"id":"getting-started/installation","path":"/hfc-pubsub/v1/getting-started/installation","sidebar":"version-v1/defaultSidebar"},{"id":"guides/testing","path":"/hfc-pubsub/v1/guides/testing","sidebar":"version-v1/defaultSidebar"},{"id":"introduction","path":"/hfc-pubsub/v1/","sidebar":"version-v1/defaultSidebar"},{"id":"options","path":"/hfc-pubsub/v1/options","sidebar":"version-v1/defaultSidebar"},{"id":"publishing/attributes","path":"/hfc-pubsub/v1/publishing/attributes","sidebar":"version-v1/defaultSidebar"},{"id":"publishing/publish-diff-project","path":"/hfc-pubsub/v1/publishing/publish-diff-project","sidebar":"version-v1/defaultSidebar"},{"id":"publishing/retry-settings","path":"/hfc-pubsub/v1/publishing/retry-settings","sidebar":"version-v1/defaultSidebar"},{"id":"publishing/topics","path":"/hfc-pubsub/v1/publishing/topics","sidebar":"version-v1/defaultSidebar"},{"id":"server/connect-database","path":"/hfc-pubsub/v1/server/connect-database","sidebar":"version-v1/defaultSidebar"},{"id":"server/custom-logger","path":"/hfc-pubsub/v1/server/custom-logger","sidebar":"version-v1/defaultSidebar"},{"id":"server/graceful-shutdown","path":"/hfc-pubsub/v1/server/graceful-shutdown","sidebar":"version-v1/defaultSidebar"},{"id":"server/health-check","path":"/hfc-pubsub/v1/server/health-check","sidebar":"version-v1/defaultSidebar"},{"id":"server/service","path":"/hfc-pubsub/v1/server/service","sidebar":"version-v1/defaultSidebar"},{"id":"subscribing/dead-letter-policy","path":"/hfc-pubsub/v1/subscribing/dead-letter-policy","sidebar":"version-v1/defaultSidebar"},{"id":"subscribing/error-handling","path":"/hfc-pubsub/v1/subscribing/error-handling","sidebar":"version-v1/defaultSidebar"},{"id":"subscribing/message-ordering","path":"/hfc-pubsub/v1/subscribing/message-ordering","sidebar":"version-v1/defaultSidebar"},{"id":"subscribing/retry-policy","path":"/hfc-pubsub/v1/subscribing/retry-policy","sidebar":"version-v1/defaultSidebar"},{"id":"subscribing/subscriptions","path":"/hfc-pubsub/v1/subscribing/subscriptions","sidebar":"version-v1/defaultSidebar"}]}]}}}'),c=JSON.parse('{"defaultLocale":"en","locales":["en"],"currentLocale":"en","localeConfigs":{"en":{"label":"en","direction":"ltr"}}}');var d=n(7529);const p=JSON.parse('{"docusaurusVersion":"2.0.0-beta.ff31de0ff","siteVersion":"2.2.2","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.0.0-beta.ff31de0ff"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"2.0.0-beta.ff31de0ff"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.0.0-beta.ff31de0ff"},"docusaurus-plugin-debug":{"type":"package","name":"@docusaurus/plugin-debug","version":"2.0.0-beta.ff31de0ff"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.0.0-beta.ff31de0ff"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.0.0-beta.ff31de0ff"},"undefined":{"type":"package","name":"docusaurus-plugin-typedoc","version":"0.16.3"}}}');var f=n(6291),h=n(4748),b=n(1721),m=n(5977),g=n(4865),v=n.n(g);const y=[n(7771),n(7771),n(7771),n(2497),n(5345)];function w(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = '+e+" "+("/"===e?" (default value)":"")+'

\n

We suggest trying baseUrl =

\n\n'}(e)).replace(/{"use strict";n.d(t,{Z:()=>a});var r=!("undefined"==typeof window||!window.document||!window.document.createElement);const a={canUseDOM:r,canUseEventListeners:r&&!(!window.addEventListener&&!window.attachEvent),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&!!window.screen}},9105:(e,t,n)=>{"use strict";n.d(t,{Z:()=>me});var r,a,i,o,l=n(7294),s=n(5697),u=n.n(s),c=n(3524),d=n.n(c),p=n(9590),f=n.n(p),h=n(7418),b=n.n(h),m="bodyAttributes",g="htmlAttributes",v="titleAttributes",y={BASE:"base",BODY:"body",HEAD:"head",HTML:"html",LINK:"link",META:"meta",NOSCRIPT:"noscript",SCRIPT:"script",STYLE:"style",TITLE:"title"},w=(Object.keys(y).map((function(e){return y[e]})),"charset"),k="cssText",S="href",E="http-equiv",x="innerHTML",T="itemprop",C="name",_="property",O="rel",P="src",A="target",R={accesskey:"accessKey",charset:"charSet",class:"className",contenteditable:"contentEditable",contextmenu:"contextMenu","http-equiv":"httpEquiv",itemprop:"itemProp",tabindex:"tabIndex"},L="defaultTitle",I="defer",N="encodeSpecialCharacters",D="onChangeClientState",M="titleTemplate",F=Object.keys(R).reduce((function(e,t){return e[R[t]]=t,e}),{}),j=[y.NOSCRIPT,y.SCRIPT,y.STYLE],B="data-react-helmet",z="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},U=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},G=function(){function e(e,t){for(var n=0;n=0||Object.prototype.hasOwnProperty.call(e,r)&&(n[r]=e[r]);return n},H=function(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t},V=function(e){var t=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];return!1===t?String(e):String(e).replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")},W=function(e){var t=X(e,y.TITLE),n=X(e,M);if(n&&t)return n.replace(/%s/g,(function(){return Array.isArray(t)?t.join(""):t}));var r=X(e,L);return t||r||void 0},Z=function(e){return X(e,D)||function(){}},Y=function(e,t){return t.filter((function(t){return void 0!==t[e]})).map((function(t){return t[e]})).reduce((function(e,t){return $({},e,t)}),{})},K=function(e,t){return t.filter((function(e){return void 0!==e[y.BASE]})).map((function(e){return e[y.BASE]})).reverse().reduce((function(t,n){if(!t.length)for(var r=Object.keys(n),a=0;a=0;n--){var r=e[n];if(r.hasOwnProperty(t))return r[t]}return null},J=(r=Date.now(),function(e){var t=Date.now();t-r>16?(r=t,e(t)):setTimeout((function(){J(e)}),0)}),ee=function(e){return clearTimeout(e)},te="undefined"!=typeof window?window.requestAnimationFrame&&window.requestAnimationFrame.bind(window)||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||J:n.g.requestAnimationFrame||J,ne="undefined"!=typeof window?window.cancelAnimationFrame||window.webkitCancelAnimationFrame||window.mozCancelAnimationFrame||ee:n.g.cancelAnimationFrame||ee,re=function(e){return console&&"function"==typeof console.warn&&console.warn(e)},ae=null,ie=function(e,t){var n=e.baseTag,r=e.bodyAttributes,a=e.htmlAttributes,i=e.linkTags,o=e.metaTags,l=e.noscriptTags,s=e.onChangeClientState,u=e.scriptTags,c=e.styleTags,d=e.title,p=e.titleAttributes;se(y.BODY,r),se(y.HTML,a),le(d,p);var f={baseTag:ue(y.BASE,n),linkTags:ue(y.LINK,i),metaTags:ue(y.META,o),noscriptTags:ue(y.NOSCRIPT,l),scriptTags:ue(y.SCRIPT,u),styleTags:ue(y.STYLE,c)},h={},b={};Object.keys(f).forEach((function(e){var t=f[e],n=t.newTags,r=t.oldTags;n.length&&(h[e]=n),r.length&&(b[e]=f[e].oldTags)})),t&&t(),s(e,h,b)},oe=function(e){return Array.isArray(e)?e.join(""):e},le=function(e,t){void 0!==e&&document.title!==e&&(document.title=oe(e)),se(y.TITLE,t)},se=function(e,t){var n=document.getElementsByTagName(e)[0];if(n){for(var r=n.getAttribute(B),a=r?r.split(","):[],i=[].concat(a),o=Object.keys(t),l=0;l=0;d--)n.removeAttribute(i[d]);a.length===i.length?n.removeAttribute(B):n.getAttribute(B)!==o.join(",")&&n.setAttribute(B,o.join(","))}},ue=function(e,t){var n=document.head||document.querySelector(y.HEAD),r=n.querySelectorAll(e+"["+"data-react-helmet]"),a=Array.prototype.slice.call(r),i=[],o=void 0;return t&&t.length&&t.forEach((function(t){var n=document.createElement(e);for(var r in t)if(t.hasOwnProperty(r))if(r===x)n.innerHTML=t.innerHTML;else if(r===k)n.styleSheet?n.styleSheet.cssText=t.cssText:n.appendChild(document.createTextNode(t.cssText));else{var l=void 0===t[r]?"":t[r];n.setAttribute(r,l)}n.setAttribute(B,"true"),a.some((function(e,t){return o=t,n.isEqualNode(e)}))?a.splice(o,1):i.push(n)})),a.forEach((function(e){return e.parentNode.removeChild(e)})),i.forEach((function(e){return n.appendChild(e)})),{oldTags:a,newTags:i}},ce=function(e){return Object.keys(e).reduce((function(t,n){var r=void 0!==e[n]?n+'="'+e[n]+'"':""+n;return t?t+" "+r:r}),"")},de=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return Object.keys(e).reduce((function(t,n){return t[R[n]||n]=e[n],t}),t)},pe=function(e,t,n){switch(e){case y.TITLE:return{toComponent:function(){return e=t.title,n=t.titleAttributes,(r={key:e})[B]=!0,a=de(n,r),[l.createElement(y.TITLE,a,e)];var e,n,r,a},toString:function(){return function(e,t,n,r){var a=ce(n),i=oe(t);return a?"<"+e+' data-react-helmet="true" '+a+">"+V(i,r)+"":"<"+e+' data-react-helmet="true">'+V(i,r)+""}(e,t.title,t.titleAttributes,n)}};case m:case g:return{toComponent:function(){return de(t)},toString:function(){return ce(t)}};default:return{toComponent:function(){return function(e,t){return t.map((function(t,n){var r,a=((r={key:n})[B]=!0,r);return Object.keys(t).forEach((function(e){var n=R[e]||e;if(n===x||n===k){var r=t.innerHTML||t.cssText;a.dangerouslySetInnerHTML={__html:r}}else a[n]=t[e]})),l.createElement(e,a)}))}(e,t)},toString:function(){return function(e,t,n){return t.reduce((function(t,r){var a=Object.keys(r).filter((function(e){return!(e===x||e===k)})).reduce((function(e,t){var a=void 0===r[t]?t:t+'="'+V(r[t],n)+'"';return e?e+" "+a:a}),""),i=r.innerHTML||r.cssText||"",o=-1===j.indexOf(e);return t+"<"+e+' data-react-helmet="true" '+a+(o?"/>":">"+i+"")}),"")}(e,t,n)}}}},fe=function(e){var t=e.baseTag,n=e.bodyAttributes,r=e.encode,a=e.htmlAttributes,i=e.linkTags,o=e.metaTags,l=e.noscriptTags,s=e.scriptTags,u=e.styleTags,c=e.title,d=void 0===c?"":c,p=e.titleAttributes;return{base:pe(y.BASE,t,r),bodyAttributes:pe(m,n,r),htmlAttributes:pe(g,a,r),link:pe(y.LINK,i,r),meta:pe(y.META,o,r),noscript:pe(y.NOSCRIPT,l,r),script:pe(y.SCRIPT,s,r),style:pe(y.STYLE,u,r),title:pe(y.TITLE,{title:d,titleAttributes:p},r)}},he=d()((function(e){return{baseTag:K([S,A],e),bodyAttributes:Y(m,e),defer:X(e,I),encode:X(e,N),htmlAttributes:Y(g,e),linkTags:Q(y.LINK,[O,S],e),metaTags:Q(y.META,[C,w,E,_,T],e),noscriptTags:Q(y.NOSCRIPT,[x],e),onChangeClientState:Z(e),scriptTags:Q(y.SCRIPT,[P,x],e),styleTags:Q(y.STYLE,[k],e),title:W(e),titleAttributes:Y(v,e)}}),(function(e){ae&&ne(ae),e.defer?ae=te((function(){ie(e,(function(){ae=null}))})):(ie(e),ae=null)}),fe)((function(){return null})),be=(a=he,o=i=function(e){function t(){return U(this,t),H(this,e.apply(this,arguments))}return function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}(t,e),t.prototype.shouldComponentUpdate=function(e){return!f()(this.props,e)},t.prototype.mapNestedChildrenToProps=function(e,t){if(!t)return null;switch(e.type){case y.SCRIPT:case y.NOSCRIPT:return{innerHTML:t};case y.STYLE:return{cssText:t}}throw new Error("<"+e.type+" /> elements are self-closing and can not contain children. Refer to our API for more information.")},t.prototype.flattenArrayTypeChildren=function(e){var t,n=e.child,r=e.arrayTypeChildren,a=e.newChildProps,i=e.nestedChildren;return $({},r,((t={})[n.type]=[].concat(r[n.type]||[],[$({},a,this.mapNestedChildrenToProps(n,i))]),t))},t.prototype.mapObjectTypeChildren=function(e){var t,n,r=e.child,a=e.newProps,i=e.newChildProps,o=e.nestedChildren;switch(r.type){case y.TITLE:return $({},a,((t={})[r.type]=o,t.titleAttributes=$({},i),t));case y.BODY:return $({},a,{bodyAttributes:$({},i)});case y.HTML:return $({},a,{htmlAttributes:$({},i)})}return $({},a,((n={})[r.type]=$({},i),n))},t.prototype.mapArrayTypeChildrenToProps=function(e,t){var n=$({},t);return Object.keys(e).forEach((function(t){var r;n=$({},n,((r={})[t]=e[t],r))})),n},t.prototype.warnOnInvalidChildren=function(e,t){return!0},t.prototype.mapChildrenToProps=function(e,t){var n=this,r={};return l.Children.forEach(e,(function(e){if(e&&e.props){var a=e.props,i=a.children,o=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return Object.keys(e).reduce((function(t,n){return t[F[n]||n]=e[n],t}),t)}(q(a,["children"]));switch(n.warnOnInvalidChildren(e,i),e.type){case y.LINK:case y.META:case y.NOSCRIPT:case y.SCRIPT:case y.STYLE:r=n.flattenArrayTypeChildren({child:e,arrayTypeChildren:r,newChildProps:o,nestedChildren:i});break;default:t=n.mapObjectTypeChildren({child:e,newProps:t,newChildProps:o,nestedChildren:i})}}})),t=this.mapArrayTypeChildrenToProps(r,t)},t.prototype.render=function(){var e=this.props,t=e.children,n=q(e,["children"]),r=$({},n);return t&&(r=this.mapChildrenToProps(t,r)),l.createElement(a,r)},G(t,null,[{key:"canUseDOM",set:function(e){a.canUseDOM=e}}]),t}(l.Component),i.propTypes={base:u().object,bodyAttributes:u().object,children:u().oneOfType([u().arrayOf(u().node),u().node]),defaultTitle:u().string,defer:u().bool,encodeSpecialCharacters:u().bool,htmlAttributes:u().object,link:u().arrayOf(u().object),meta:u().arrayOf(u().object),noscript:u().arrayOf(u().object),onChangeClientState:u().func,script:u().arrayOf(u().object),style:u().arrayOf(u().object),title:u().string,titleAttributes:u().object,titleTemplate:u().string},i.defaultProps={defer:!0,encodeSpecialCharacters:!0},i.peek=a.peek,i.rewind=function(){var e=a.rewind();return e||(e=fe({baseTag:[],bodyAttributes:{},encodeSpecialCharacters:!0,htmlAttributes:{},linkTags:[],metaTags:[],noscriptTags:[],scriptTags:[],styleTags:[],title:"",titleAttributes:{}})),e},o);be.renderStatic=be.rewind;const me=function(e){return l.createElement(be,Object.assign({},e))}},4748:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=n(7294).createContext(null)},6291:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=n(8790).H},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var r=n(7294),a=n(4748);const i=function(){var e=(0,r.useContext)(a.Z);if(null===e)throw new Error("Docusaurus context not provided");return e}},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=function(e){var t={};return function e(n,r){Object.keys(n).forEach((function(a){var i=n[a],o=r?r+"."+a:a;"object"===typeof i&&!!i&&Object.keys(i).length?e(i,o):t[o]=i}))}(e),t}},2203:(e,t,n)=>{"use strict";function r(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function a(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(){return o=Object.assign||function(e){for(var t=1;t{"use strict";n.r(t);var r=n(7410),a=n(412),i=n(9782);(function(e){if(a.Z.canUseDOM){var t=i.Z.themeConfig.prism,r=(t=void 0===t?{}:t).additionalLanguages,o=void 0===r?[]:r;window.Prism=e,o.forEach((function(e){n(6726)("./prism-"+e)})),delete window.Prism}})(r.Z)},71:(e,t,n)=>{"use strict";n.d(t,{lX:()=>E,q_:()=>P,ob:()=>b,PP:()=>R,Ep:()=>h,Hp:()=>m});var r=n(7462);function a(e){return"/"===e.charAt(0)}function i(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=o[p];"."===f?i(o,p):".."===f?(i(o,p),d++):d&&(i(o,p),d--)}if(!u)for(;d--;d)o.unshift("..");!u||""===o[0]||o[0]&&a(o[0])||o.unshift("");var h=o.join("/");return n&&"/"!==h.substr(-1)&&(h+="/"),h};function l(e){return e.valueOf?e.valueOf():Object.prototype.valueOf.call(e)}const s=function e(t,n){if(t===n)return!0;if(null==t||null==n)return!1;if(Array.isArray(t))return Array.isArray(n)&&t.length===n.length&&t.every((function(t,r){return e(t,n[r])}));if("object"==typeof t||"object"==typeof n){var r=l(t),a=l(n);return r!==t||a!==n?e(r,a):Object.keys(Object.assign({},t,n)).every((function(r){return e(t[r],n[r])}))}return!1};var u=n(2177);function c(e){return"/"===e.charAt(0)?e:"/"+e}function d(e){return"/"===e.charAt(0)?e.substr(1):e}function p(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function f(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function h(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function b(e,t,n,a){var i;"string"==typeof e?(i=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var i=t.indexOf("?");return-1!==i&&(n=t.substr(i),t=t.substr(0,i)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),i.state=t):(void 0===(i=(0,r.Z)({},e)).pathname&&(i.pathname=""),i.search?"?"!==i.search.charAt(0)&&(i.search="?"+i.search):i.search="",i.hash?"#"!==i.hash.charAt(0)&&(i.hash="#"+i.hash):i.hash="",void 0!==t&&void 0===i.state&&(i.state=t));try{i.pathname=decodeURI(i.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+i.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(i.key=n),a?i.pathname?"/"!==i.pathname.charAt(0)&&(i.pathname=o(i.pathname,a.pathname)):i.pathname=a.pathname:i.pathname||(i.pathname="/"),i}function m(e,t){return e.pathname===t.pathname&&e.search===t.search&&e.hash===t.hash&&e.key===t.key&&s(e.state,t.state)}function g(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var i="function"==typeof e?e(t,n):e;"string"==typeof i?"function"==typeof r?r(i,a):a(!0):a(!1!==i)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=b(e,t,p(),w.location);c.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},i={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},o={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?o:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=o;var u=Object.defineProperty,c=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,h=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(h){var a=f(n);a&&a!==h&&e(t,a,r)}var o=c(n);d&&(o=o.concat(d(n)));for(var l=s(t),b=s(n),m=0;m{"use strict";n.r(t)},7771:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function i(e){return 100*(-1+e)}function o(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+i(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+i(e)+"%,0)"}:{"margin-left":i(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var i=n.render(!t),u=i.querySelector(r.barSelector),c=r.speed,d=r.easing;return i.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,o(e,c,d)),1===e?(s(i,{transition:"none",opacity:1}),i.offsetWidth,setTimeout((function(){s(i,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,o=t.querySelector(r.barSelector),l=e?"-100":i(n.status||0),u=document.querySelector(r.parent);return s(o,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,i=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+i)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function i(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&i(e,n,r);else i(e,a[1],a[2])}}();function u(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=p(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},7418:e=>{"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;function a(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(a){return!1}}()?Object.assign:function(e,i){for(var o,l,s=a(e),u=1;u{"use strict";n.d(t,{Z:()=>l});var r,a,i,o=(r=0,a={util:{encode:function(e){return e instanceof i?new i(e.type,a.util.encode(e.content),e.alias):"Array"===a.util.type(e)?e.map(a.util.encode):e.replace(/&/g,"&").replace(/e.length)return;if(!(k instanceof s)){if(b&&y!=t.length-1){if(p.lastIndex=w,!(_=p.exec(e)))break;for(var S=_.index+(h?_[1].length:0),E=_.index+_[0].length,x=y,T=w,C=t.length;x=(T+=t[x].length)&&(++y,w=T);if(t[y]instanceof s)continue;O=x-y,k=e.slice(w,T),_.index-=w}else{p.lastIndex=0;var _=p.exec(k),O=1}if(_){h&&(m=_[1]?_[1].length:0),E=(S=_.index+m)+(_=_[0].slice(m)).length;var P=k.slice(0,S),A=k.slice(E),R=[y,O];P&&(++y,w+=P.length,R.push(P));var L=new s(u,f?a.tokenize(_,f):_,g,_,b);if(R.push(L),A&&R.push(A),Array.prototype.splice.apply(t,R),1!=O&&a.matchGrammar(e,t,n,y,w,!0,u),o)break}else if(o)break}}}}},hooks:{add:function(){},run:function(e,t){}},tokenize:function(e,t,n){var r=[e],i=t.rest;if(i){for(var o in i)t[o]=i[o];delete t.rest}return a.matchGrammar(e,r,t,0,0,!1),r}},(i=a.Token=function(e,t,n,r,a){this.type=e,this.content=t,this.alias=n,this.length=0|(r||"").length,this.greedy=!!a}).stringify=function(e,t,n){if("string"==typeof e)return e;if("Array"===a.util.type(e))return e.map((function(n){return i.stringify(n,t,e)})).join("");var r={type:e.type,content:i.stringify(e.content,t,n),tag:"span",classes:["token",e.type],attributes:{},language:t,parent:n};if(e.alias){var o="Array"===a.util.type(e.alias)?e.alias:[e.alias];Array.prototype.push.apply(r.classes,o)}var l=Object.keys(r.attributes).map((function(e){return e+'="'+(r.attributes[e]||"").replace(/"/g,""")+'"'})).join(" ");return"<"+r.tag+' class="'+r.classes.join(" ")+'"'+(l?" "+l:"")+">"+r.content+""},a);o.languages.markup={comment://,prolog:/<\?[\s\S]+?\?>/,doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/,name:/[^\s<>'"]+/}},cdata://i,tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},o.languages.markup.tag.inside["attr-value"].inside.entity=o.languages.markup.entity,o.languages.markup.doctype.inside["internal-subset"].inside=o.languages.markup,o.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(o.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:o.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:o.languages[t]};var a={};a[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},o.languages.insertBefore("markup","cdata",a)}}),o.languages.html=o.languages.markup,o.languages.mathml=o.languages.markup,o.languages.svg=o.languages.markup,o.languages.xml=o.languages.extend("markup",{}),o.languages.ssml=o.languages.xml,o.languages.atom=o.languages.xml,o.languages.rss=o.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--?|-=|\+\+?|\+=|!=?|~|\*\*?|\*=|\/=?|%=?|<<=?|>>=?|<=?|>=?|==?|&&?|&=|\^=?|\|\|?|\|=|\?|:/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|x[0-9a-fA-F]{1,2}|u[0-9a-fA-F]{4}|U[0-9a-fA-F]{8})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)\w+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b\w+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+?)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)(["'])(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|(?!\2)[^\\`$])*\2/,lookbehind:!0,greedy:!0,inside:r}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|aptitude|apt-cache|apt-get|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:if|then|else|elif|fi|for|while|in|case|esac|function|select|do|done|until)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|break|cd|continue|eval|exec|exit|export|getopts|hash|pwd|readonly|return|shift|test|times|trap|umask|unset|alias|bind|builtin|caller|command|declare|echo|enable|help|let|local|logout|mapfile|printf|read|readarray|source|type|typeset|ulimit|unalias|set|shopt)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:true|false)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|==?|!=?|=~|<<[<-]?|[&\d]?>>|\d?[<>]&?|&[>&]?|\|[&|]?|<=?|>=?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],i=r.variable[1].inside,o=0;o]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},o.languages.c=o.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:__attribute__|_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|asm|typeof|inline|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|union|unsigned|void|volatile|while)\b/,function:/[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),o.languages.insertBefore("c","string",{macro:{pattern:/(^\s*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},o.languages.c.string],comment:o.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:o.languages.c}}},constant:/\b(?:__FILE__|__LINE__|__DATE__|__TIME__|__TIMESTAMP__|__func__|EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|stdin|stdout|stderr)\b/}),delete o.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char8_t|char16_t|char32_t|class|compl|concept|const|consteval|constexpr|constinit|const_cast|continue|co_await|co_return|co_yield|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|float|for|friend|goto|if|inline|int|int8_t|int16_t|int32_t|int64_t|uint8_t|uint16_t|uint32_t|uint64_t|long|mutable|namespace|new|noexcept|nullptr|operator|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/;e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:true|false)\b/}),e.languages.insertBefore("cpp","string",{"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","operator",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(o),function(e){var t=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:RegExp("[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),string:{pattern:t,greedy:!0},property:/(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,important:/!important\b/i,function:/[-a-z0-9]+(?=\()/i,punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),e.languages.insertBefore("inside","attr-value",{"style-attr":{pattern:/(^|["'\s])style\s*=\s*(?:"[^"]*"|'[^']*')/i,lookbehind:!0,inside:{"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{style:{pattern:/(["'])[\s\S]+(?=["']$)/,lookbehind:!0,alias:"language-css",inside:e.languages.css},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},"attr-name":/^style/i}}},n.tag))}(o),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+\b)/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#(?:[\da-f]{1,2}){3,4}\b/i,alias:"color"},color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:rgb|hsl)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:rgb|hsl)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(o),o.languages.javascript=o.languages.extend("clike",{"class-name":[o.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:prototype|constructor))/,lookbehind:!0}],keyword:[{pattern:/((?:^|})\s*)(?:catch|finally)\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|for|from|function|(?:get|set)(?=\s*[\[$\w\xA0-\uFFFF])|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:/\b(?:(?:0[xX](?:[\dA-Fa-f](?:_[\dA-Fa-f])?)+|0[bB](?:[01](?:_[01])?)+|0[oO](?:[0-7](?:_[0-7])?)+)n?|(?:\d(?:_\d)?)+n|NaN|Infinity)\b|(?:\b(?:\d(?:_\d)?)+\.?(?:\d(?:_\d)?)*|\B\.(?:\d(?:_\d)?)+)(?:[Ee][+-]?(?:\d(?:_\d)?)+)?/,operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),o.languages.javascript["class-name"][0].pattern=/(\b(?:class|interface|extends|implements|instanceof|new)\s+)[\w.\\]+/,o.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*]|\\.|[^/\\\[\r\n])+\/[gimyus]{0,6}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:o.languages.regex},"regex-flags":/[a-z]+$/,"regex-delimiter":/^\/|\/$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:o.languages.javascript},{pattern:/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,inside:o.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:o.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:o.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),o.languages.insertBefore("javascript","string",{"template-string":{pattern:/`(?:\\[\s\S]|\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}|(?!\${)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\${|}$/,alias:"punctuation"},rest:o.languages.javascript}},string:/[\s\S]+/}}}),o.languages.markup&&o.languages.markup.tag.addInlined("script","javascript"),o.languages.js=o.languages.javascript,function(e){var t=e.util.clone(e.languages.javascript);e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=/<\/?(?:[\w.:-]+(?:\s+(?:[\w.:$-]+(?:=(?:"(?:\\[^]|[^\\"])*"|'(?:\\[^]|[^\\'])*'|[^\s{'">=]+|\{(?:\{(?:\{[^{}]*\}|[^{}])*\}|[^{}])+\}))?|\{\s*\.{3}\s*[a-z_$][\w$]*(?:\.[a-z_$][\w$]*)*\s*\}))*\s*\/?)?>/i,e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/i,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[^]|[^\\"])*"|'(?:\\[^]|[^\\'])*'|[^\s'">]+)/i,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.insertBefore("inside","attr-name",{spread:{pattern:/\{\s*\.{3}\s*[a-z_$][\w$]*(?:\.[a-z_$][\w$]*)*\s*\}/,inside:{punctuation:/\.{3}|[{}.]/,"attr-value":/\w+/}}},e.languages.jsx.tag),e.languages.insertBefore("inside","attr-value",{script:{pattern:/=(?:\{(?:\{(?:\{[^{}]*\}|[^{}])*\}|[^{}])+\})/i,inside:{"script-punctuation":{pattern:/^=(?={)/,alias:"punctuation"},rest:e.languages.jsx},alias:"language-javascript"}},e.languages.jsx.tag);var n=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(n).join(""):""},r=function(t){for(var a=[],i=0;i0&&a[a.length-1].tagName===n(o.content[0].content[1])&&a.pop():"/>"===o.content[o.content.length-1].content||a.push({tagName:n(o.content[0].content[1]),openedBraces:0}):a.length>0&&"punctuation"===o.type&&"{"===o.content?a[a.length-1].openedBraces++:a.length>0&&a[a.length-1].openedBraces>0&&"punctuation"===o.type&&"}"===o.content?a[a.length-1].openedBraces--:l=!0),(l||"string"==typeof o)&&a.length>0&&0===a[a.length-1].openedBraces){var s=n(o);i0&&("string"==typeof t[i-1]||"plain-text"===t[i-1].type)&&(s=n(t[i-1])+s,t.splice(i-1,1),i--),t[i]=new e.Token("plain-text",s,null,s)}o.content&&"string"!=typeof o.content&&r(o.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||r(e.tokens)}))}(o),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:(?:Uint|Int)(?:8|16|32)|Uint8Clamped|Float(?:32|64))?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|(?:Weak)?(?:Set|Map)|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|for|finally|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|location|navigator|performance|(?:local|session)Storage|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(o),o.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/m,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/m}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},o.languages.go=o.languages.extend("clike",{string:{pattern:/(["'`])(?:\\[\s\S]|(?!\1)[^\\])*\1/,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|iota|nil|true|false)\b/,number:/(?:\b0x[a-f\d]+|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[-+]?\d+)?)i?/i,operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:bool|byte|complex(?:64|128)|error|float(?:32|64)|rune|string|u?int(?:8|16|32|64)?|uintptr|append|cap|close|complex|copy|delete|imag|len|make|new|panic|print(?:ln)?|real|recover)\b/}),delete o.languages.go["class-name"],o.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:o.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:true|false)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*)[a-zA-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,punctuation:/[!(){}\[\]:=,]/,constant:/\b(?!ID\b)[A-Z][A-Z_\d]*\b/},function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,i){if(n.language===r){var o=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof i&&!i(e))return e;for(var a,l=o.length;-1!==n.code.indexOf(a=t(r,l));)++l;return o[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,i=Object.keys(n.tokenStack);!function o(l){for(var s=0;s=i.length);s++){var u=l[s];if("string"==typeof u||u.content&&"string"==typeof u.content){var c=i[a],d=n.tokenStack[c],p="string"==typeof u?u:u.content,f=t(r,c),h=p.indexOf(f);if(h>-1){++a;var b=p.substring(0,h),m=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),g=p.substring(h+f.length),v=[];b&&v.push.apply(v,o([b])),v.push(m),g&&v.push.apply(v,o([g])),"string"==typeof u?l.splice.apply(l,[s,1].concat(v)):u.content=v}}else u.content&&o(u.content)}return l}(n.tokens)}}}})}(o),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/i,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:true|false)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/i,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")}))}(o),o.languages.json={property:{pattern:/"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,greedy:!0},string:{pattern:/"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:true|false)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},o.languages.webmanifest=o.languages.json,o.languages.less=o.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/i,operator:/[+\-*\/]/}),o.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),o.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},builtin:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,symbol:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:[/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,{pattern:/(\()(?:addsuffix|abspath|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:s|list)?)(?=[ \t])/,lookbehind:!0}],operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?!\n|\r\n?))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),i=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"font-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+i+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+i+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+i+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/``.+?``|`[^`\r\n]+`/,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+?\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete o.languages.objectivec["class-name"],o.languages.objc=o.languages.objectivec,o.languages.ocaml={comment:/\(\*[\s\S]*?\*\)/,string:[{pattern:/"(?:\\.|[^\\\r\n"])*"/,greedy:!0},{pattern:/(['`])(?:\\(?:\d+|x[\da-f]+|.)|(?!\1)[^\\\r\n])\1/i,greedy:!0}],number:/\b(?:0x[\da-f][\da-f_]+|(?:0[bo])?\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?[\d_]+)?)/i,directive:{pattern:/\B#\w+/,alias:"important"},label:{pattern:/\B~\w+/,alias:"function"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"variable"},module:{pattern:/\b[A-Z]\w+/,alias:"variable"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,operator:/:=|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/[(){}\[\]|.,:;]|\b_\b/},o.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0},"string-interpolation":{pattern:/(?:f|rf|fr)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:{{)*){(?!{)(?:[^{}]|{(?!{)(?:[^{}]|{(?!{)(?:[^{}])+})+})+}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|rb|br)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|rb|br)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^\s*)@\w+(?:\.\w+)*/im,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:and|as|assert|async|await|break|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:True|False|None)\b/,number:/(?:\b(?=\d)|\B(?=\.))(?:0[bo])?(?:(?:\d|0x[\da-f])[\da-f]*(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?j?\b/i,operator:/[-+%=]=?|!=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},o.languages.python["string-interpolation"].inside.interpolation.inside.rest=o.languages.python,o.languages.py=o.languages.python,o.languages.reason=o.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:mod|land|lor|lxor|lsl|lsr|asr)\b/}),o.languages.insertBefore("reason","class-name",{character:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,alias:"string"},constructor:{pattern:/\b[A-Z]\w*\b(?!\s*\.)/,alias:"variable"},label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete o.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,inside:{atrule:/(?:@[\w-]+|[+=])/m}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|or|not)\b/,{pattern:/(\s+)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/,lookbehind:!0}})}(o),o.languages.scss=o.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]+))/m,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),o.languages.insertBefore("scss","atrule",{keyword:[/@(?:if|else(?: if)?|forward|for|each|while|import|use|extend|debug|warn|mixin|include|function|return|content)\b/i,{pattern:/( +)(?:from|through)(?= )/,lookbehind:!0}]}),o.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),o.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|with|show|hide)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:true|false)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|or|not)(?=\s)/,lookbehind:!0}}),o.languages.scss.atrule.inside.rest=o.languages.scss,o.languages.sql={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|(?:--|\/\/|#).*)/,lookbehind:!0},variable:[{pattern:/@(["'`])(?:\\[\s\S]|(?!\1)[^\\])+\1/,greedy:!0},/@[\w.$]+/],string:{pattern:/(^|[^@\\])("|')(?:\\[\s\S]|(?!\2)[^\\]|\2\2)*\2/,greedy:!0,lookbehind:!0},function:/\b(?:AVG|COUNT|FIRST|FORMAT|LAST|LCASE|LEN|MAX|MID|MIN|MOD|NOW|ROUND|SUM|UCASE)(?=\s*\()/i,keyword:/\b(?:ACTION|ADD|AFTER|ALGORITHM|ALL|ALTER|ANALYZE|ANY|APPLY|AS|ASC|AUTHORIZATION|AUTO_INCREMENT|BACKUP|BDB|BEGIN|BERKELEYDB|BIGINT|BINARY|BIT|BLOB|BOOL|BOOLEAN|BREAK|BROWSE|BTREE|BULK|BY|CALL|CASCADED?|CASE|CHAIN|CHAR(?:ACTER|SET)?|CHECK(?:POINT)?|CLOSE|CLUSTERED|COALESCE|COLLATE|COLUMNS?|COMMENT|COMMIT(?:TED)?|COMPUTE|CONNECT|CONSISTENT|CONSTRAINT|CONTAINS(?:TABLE)?|CONTINUE|CONVERT|CREATE|CROSS|CURRENT(?:_DATE|_TIME|_TIMESTAMP|_USER)?|CURSOR|CYCLE|DATA(?:BASES?)?|DATE(?:TIME)?|DAY|DBCC|DEALLOCATE|DEC|DECIMAL|DECLARE|DEFAULT|DEFINER|DELAYED|DELETE|DELIMITERS?|DENY|DESC|DESCRIBE|DETERMINISTIC|DISABLE|DISCARD|DISK|DISTINCT|DISTINCTROW|DISTRIBUTED|DO|DOUBLE|DROP|DUMMY|DUMP(?:FILE)?|DUPLICATE|ELSE(?:IF)?|ENABLE|ENCLOSED|END|ENGINE|ENUM|ERRLVL|ERRORS|ESCAPED?|EXCEPT|EXEC(?:UTE)?|EXISTS|EXIT|EXPLAIN|EXTENDED|FETCH|FIELDS|FILE|FILLFACTOR|FIRST|FIXED|FLOAT|FOLLOWING|FOR(?: EACH ROW)?|FORCE|FOREIGN|FREETEXT(?:TABLE)?|FROM|FULL|FUNCTION|GEOMETRY(?:COLLECTION)?|GLOBAL|GOTO|GRANT|GROUP|HANDLER|HASH|HAVING|HOLDLOCK|HOUR|IDENTITY(?:_INSERT|COL)?|IF|IGNORE|IMPORT|INDEX|INFILE|INNER|INNODB|INOUT|INSERT|INT|INTEGER|INTERSECT|INTERVAL|INTO|INVOKER|ISOLATION|ITERATE|JOIN|KEYS?|KILL|LANGUAGE|LAST|LEAVE|LEFT|LEVEL|LIMIT|LINENO|LINES|LINESTRING|LOAD|LOCAL|LOCK|LONG(?:BLOB|TEXT)|LOOP|MATCH(?:ED)?|MEDIUM(?:BLOB|INT|TEXT)|MERGE|MIDDLEINT|MINUTE|MODE|MODIFIES|MODIFY|MONTH|MULTI(?:LINESTRING|POINT|POLYGON)|NATIONAL|NATURAL|NCHAR|NEXT|NO|NONCLUSTERED|NULLIF|NUMERIC|OFF?|OFFSETS?|ON|OPEN(?:DATASOURCE|QUERY|ROWSET)?|OPTIMIZE|OPTION(?:ALLY)?|ORDER|OUT(?:ER|FILE)?|OVER|PARTIAL|PARTITION|PERCENT|PIVOT|PLAN|POINT|POLYGON|PRECEDING|PRECISION|PREPARE|PREV|PRIMARY|PRINT|PRIVILEGES|PROC(?:EDURE)?|PUBLIC|PURGE|QUICK|RAISERROR|READS?|REAL|RECONFIGURE|REFERENCES|RELEASE|RENAME|REPEAT(?:ABLE)?|REPLACE|REPLICATION|REQUIRE|RESIGNAL|RESTORE|RESTRICT|RETURN(?:S|ING)?|REVOKE|RIGHT|ROLLBACK|ROUTINE|ROW(?:COUNT|GUIDCOL|S)?|RTREE|RULE|SAVE(?:POINT)?|SCHEMA|SECOND|SELECT|SERIAL(?:IZABLE)?|SESSION(?:_USER)?|SET(?:USER)?|SHARE|SHOW|SHUTDOWN|SIMPLE|SMALLINT|SNAPSHOT|SOME|SONAME|SQL|START(?:ING)?|STATISTICS|STATUS|STRIPED|SYSTEM_USER|TABLES?|TABLESPACE|TEMP(?:ORARY|TABLE)?|TERMINATED|TEXT(?:SIZE)?|THEN|TIME(?:STAMP)?|TINY(?:BLOB|INT|TEXT)|TOP?|TRAN(?:SACTIONS?)?|TRIGGER|TRUNCATE|TSEQUAL|TYPES?|UNBOUNDED|UNCOMMITTED|UNDEFINED|UNION|UNIQUE|UNLOCK|UNPIVOT|UNSIGNED|UPDATE(?:TEXT)?|USAGE|USE|USER|USING|VALUES?|VAR(?:BINARY|CHAR|CHARACTER|YING)|VIEW|WAITFOR|WARNINGS|WHEN|WHERE|WHILE|WITH(?: ROLLUP|IN)?|WORK|WRITE(?:TEXT)?|YEAR)\b/i,boolean:/\b(?:TRUE|FALSE|NULL)\b/i,number:/\b0x[\da-f]+\b|\b\d+(?:\.\d*)?|\B\.\d+\b/i,operator:/[-+*\/=%^~]|&&?|\|\|?|!=?|<(?:=>?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|IN|LIKE|NOT|OR|IS|DIV|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/url\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:if|else|for|return|unless)(?=\s+|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:rgb|hsl)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:rgb|hsl)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:true|false)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^{|}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^\s*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:if|else|for|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,](?=$)(?!(?:\r?\n|\r)(?:\{|\2[ \t]+)))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t]+)))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(o),function(e){e.languages.typescript=e.languages.extend("javascript",{"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|type)\s+)(?!keyof\b)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?:\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},keyword:/\b(?:abstract|as|asserts|async|await|break|case|catch|class|const|constructor|continue|debugger|declare|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|is|keyof|let|module|namespace|new|null|of|package|private|protected|public|readonly|return|require|set|static|super|switch|this|throw|try|type|typeof|undefined|var|void|while|with|yield)\b/,builtin:/\b(?:string|Function|any|number|boolean|Array|symbol|console|Promise|unknown|never)\b/}),delete e.languages.typescript.parameter;var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(o),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t);var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(o),o.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|nearest|neg?|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|store(?:8|16|32)?|sqrt|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^_`|~]+/i,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/},function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),i=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function o(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|]|}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+a+"|"+i+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:o(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:o(/true|false/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:o(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:o(i),lookbehind:!0,greedy:!0},number:{pattern:o(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.?\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(o);const l=o},9901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},bash:{title:"Bash",alias:"shell",aliasTitles:{shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:"hbs",owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["css","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (Scss)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),i=new Set;function o(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(o.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),i.add(e)}))}o.silent=!1,e.exports=o},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=i(e);return n(t)}function i(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=i,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=i(e);return n(t)}function i(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=i,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function o(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var o in a(t,i),l[t]=!0,n[t])l[o]=!0}t(s.require,o),t(s.optional,o),t(s.modify,o)}n[r]=l,i.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(i,o,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var i=r[a];t[a]="string"==typeof i?{title:i}:i}}return t}(i),u=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var i=e[a];t(i&&i.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);o=o.map(u),l=(l||[]).map(u);var c=n(o),d=n(l);o.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(c[t]=!0,e(t))}))}));for(var p,f=r(s),h=c;a(h);){for(var b in p={},h){var m=s[b];t(m&&m.modify,(function(e){e in d&&(p[e]=!0)}))}for(var g in d)if(!(g in c))for(var v in f(g))if(v in c){p[g]=!0;break}for(var y in h=p)c[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var i=a?a.series:void 0,o=a?a.parallel:e,l={},s={};function u(e){if(e in l)return l[e];s[e]=!0;var a,c=[];for(var d in t(e))d in n&&c.push(d);if(0===c.length)a=r(e);else{var p=o(c.map((function(e){var t=u(e);return delete s[e],t})));i?a=i(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var c in n)u(c);var d=[];for(var p in s)d.push(l[p]);return o(d)}(f,c,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function i(){}i.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,i,o){if(o!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(7418),i=n(3840);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n