Skip to content

docs: clarify makeMessage is a v1-only helper #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cabljac wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: clarify makeMessage is a v1-only helper #332

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae195a4
docs: clarify makeMessage is a v1-only helper
cabljac Jul 23, 2026
f7fa88e
docs: repeat wrapV2 examples on string overload
cabljac Jul 23, 2026
59d537c
Merge branch 'master' into docs/make-message-v1-only
IzaakGough Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/providers/pubsub.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,31 @@

import { pubsub } from 'firebase-functions/v1';

/** Create a Message from a JSON object. */
/**
* Create a Message from a JSON object.
*
* Note: this helper is for v1 `functions.pubsub.topic(...).onPublish` functions
* only. Do not pass its result to `wrapV2`; for v2 `onMessagePublished`
* functions, pass a plain CloudEvent partial instead, e.g.
* `wrapV2(fn)({ data: { message: { json: { hello: 'world' } } } })` or
* `wrapV2(fn)({ data: { message: { data: base64String } } })`.
*/
export function makeMessage(
/** Content of message. */
json: { [key: string]: any },
/** Optional Pubsub message attributes. */
attributes?: { [key: string]: string }
): pubsub.Message;

/** Create a Message from a base-64 encoded string. */
/**
* Create a Message from a base-64 encoded string.
*
* Note: this helper is for v1 `functions.pubsub.topic(...).onPublish` functions
* only. Do not pass its result to `wrapV2`; for v2 `onMessagePublished`
* functions, pass a plain CloudEvent partial instead, e.g.
* `wrapV2(fn)({ data: { message: { json: { hello: 'world' } } } })` or
* `wrapV2(fn)({ data: { message: { data: base64String } } })`.
*/
export function makeMessage(
/** Base-64 encoded message string. */
encodedString: string,
Expand Down
Loading