README.md

pubsub-http-handler

pubsub-http-handler

Table of contents

Classes

• PubSubHandlerResponse

Interfaces

• HandlePubSubMessageArgs
• PubSubCloudFunctionsConfig
• PubSubConfig
• PubSubHandlerFastifyConfig

Type Aliases

• CloudFunctionFun
• OnErrorHandler
• PubSubHandler
• PubSubMessage
• PubSubRequest

Variables

• pubSubMessageSchema
• pubSubRequestSchema

Functions

• createPubSubCloudFunctions
• handlePubSubMessage
• makePubSubConfig
• pubSubFastifyPlugin

Type Aliases

CloudFunctionFun

Ƭ CloudFunctionFun: (req: express.Request, res: express.Response) => Promise<void>

Type declaration

▸ (req, res): Promise<void>

Parameters

Name	Type
req	express.Request
res	express.Response

Returns

Promise<void>

Defined in

src/cloud-functions.ts:14

---

OnErrorHandler

Ƭ OnErrorHandler<Context>: (error: unknown, context: Context) => void | Promise<void>

Type parameters

Name
Context

Type declaration

▸ (error, context): void | Promise<void>

Parameters

Name	Type
error	unknown
context	Context

Returns

void | Promise<void>

Defined in

src/types.ts:30

---

PubSubHandler

Ƭ PubSubHandler<Data, Context, Logger>: (args: { context: Context ; data: Data ; log: Logger ; message: PubSubMessage }) => Promise<PubSubHandlerResponse | void> | PubSubHandlerResponse | void

Type parameters

Name
Data
Context
Logger

Type declaration

▸ (args): Promise<PubSubHandlerResponse | void> | PubSubHandlerResponse | void

Parameters

Name	Type
args	Object
args.context	Context
args.data	Data
args.log	Logger
args.message	PubSubMessage

Returns

Promise<PubSubHandlerResponse | void> | PubSubHandlerResponse | void

Defined in

src/types.ts:39

---

PubSubMessage

Ƭ PubSubMessage: Static<typeof pubSubMessageSchema>

Defined in

src/types.ts:15

---

PubSubRequest

Ƭ PubSubRequest: Static<typeof pubSubRequestSchema>

Defined in

src/types.ts:28

Variables

pubSubMessageSchema

• Const pubSubMessageSchema: TObject<{ attributes: TOptional<TRecord<TString, TString>> ; data: TString ; messageId: TOptional<TString> }>

PubSub Message Type

This describes the message object that is sent to the handler from Google PubSub.

Defined in

src/types.ts:9

---

pubSubRequestSchema

• Const pubSubRequestSchema: TObject<{ message: TObject<{ attributes: TOptional<TRecord<TString, TString>> ; data: TString ; messageId: TOptional<TString> }> = pubSubMessageSchema; subscription: TString }>

PubSub Request Type

This describes the request object that is sent to the handler from Google PubSub.

Defined in

src/types.ts:23

Functions

createPubSubCloudFunctions

▸ createPubSubCloudFunctions<Data, Context>(handler, options?): CloudFunctionFun

Type parameters

Name	Type
Data	unknown
Context	unknown

Parameters

Name	Type
handler	PubSubHandler<Data, Context, Logger<LoggerOptions>>
options	PubSubCloudFunctionsConfig<Data, Context>

Returns

CloudFunctionFun

Defined in

src/cloud-functions.ts:19

---

handlePubSubMessage

▸ handlePubSubMessage<Data, Context, Logger>(args): Promise<PubSubHandlerResponse | void>

Type parameters

Name
Data
Context
Logger

Parameters

Name	Type
args	HandlePubSubMessageArgs<Data, Context, Logger>

Returns

Promise<PubSubHandlerResponse | void>

Defined in

src/common.ts:12

---

makePubSubConfig

▸ makePubSubConfig<Data, Context>(data): PubSubHandlerFastifyConfig<Data, Context>

Type parameters

Name
Data
Context

Parameters

Name	Type
data	PubSubHandlerFastifyConfig<Data, Context>

Returns

PubSubHandlerFastifyConfig<Data, Context>

Defined in

src/utils.ts:3

---

pubSubFastifyPlugin

▸ pubSubFastifyPlugin<Data, Context>(fastify, options): Promise<void>

Type parameters

Name
Data
Context

Parameters

Name	Type
fastify	FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>
options	PubSubHandlerFastifyConfig<Data, Context>

Returns

Promise<void>

Defined in

src/fastify-plugin.ts:14