Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

pubsub-http-handler

pubsub-http-handler

Table of contents

Classes

Interfaces

Type Aliases

Variables

Functions

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

methods/cloud-functions.ts:12


OnErrorHandler

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

Type declaration

▸ (error): void | Promise<void>

Parameters
Name Type
error unknown
Returns

void | Promise<void>

Defined in

types.ts:56


PubSubHandler

Ƭ PubSubHandler<T>: (args: { context?: unknown ; data?: T ; log: FastifyLoggerInstance ; message: PubSubMessageType }) => Promise<PubSubHandlerResponse | void> | PubSubHandlerResponse | void

Type parameters

Name Type
T any

Type declaration

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

Parameters
Name Type
args Object
args.context? unknown
args.data? T
args.log FastifyLoggerInstance
args.message PubSubMessageType
Returns

Promise<PubSubHandlerResponse | void> | PubSubHandlerResponse | void

Defined in

types.ts:49


PubSubMessageType

Ƭ PubSubMessageType: Static<typeof PubSubMessage>

Defined in

types.ts:36


PubSubRequestType

Ƭ PubSubRequestType: Static<typeof PubSubRequest>

Defined in

types.ts:43

Variables

PubSubMessage

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

Defined in

types.ts:30


PubSubRequest

Const PubSubRequest: TObject<{ message: TObject<{ attributes: TOptional<TRecord<TString, TString>> ; data: TString ; messageId: TOptional<TString> }> = PubSubMessage; subscription: TString }>

Defined in

types.ts:38

Functions

createPubSubCloudFunctions

createPubSubCloudFunctions<T>(handler, options?): CloudFunctionFun

Type parameters

Name Type
T unknown

Parameters

Name Type
handler PubSubHandler<T>
options PubSubCloudFunctionsConfig

Returns

CloudFunctionFun

Defined in

methods/cloud-functions.ts:17


createPubSubServer

createPubSubServer<T>(handler, config?): CreatePubSubHandlerResponse

Type parameters

Name Type
T unknown

Parameters

Name Type
handler PubSubHandler<T>
config PubSubServerConfig

Returns

CreatePubSubHandlerResponse

Defined in

methods/server.ts:35


handlePubSubMessage

handlePubSubMessage<Context>(args): Promise<PubSubHandlerResponse | void>

Type parameters

Name Type
Context unknown

Parameters

Name Type
args HandlePubSubMessageArgs<Context>

Returns

Promise<PubSubHandlerResponse | void>

Defined in

common.ts:16


pubSubFastifyPlugin

pubSubFastifyPlugin(instance, opts): Promise<void>

Parameters

Name Type
instance FastifyInstance<Server, IncomingMessage, ServerResponse, FastifyLoggerInstance, FastifyTypeProviderDefault>
opts PubSubConfig

Returns

Promise<void>

Defined in

methods/fastify-plugin.ts:5