From 5b0d3140eba907bb1b6f70c9888578cd33584311 Mon Sep 17 00:00:00 2001 From: Cole Rogers Date: Mon, 3 Oct 2022 14:23:46 -0400 Subject: [PATCH 1/2] resolve conflicts --- src/v1/providers/database.ts | 9 ++++----- src/v1/providers/pubsub.ts | 4 ++-- src/v1/providers/remoteConfig.ts | 2 +- src/v1/providers/storage.ts | 8 ++++---- src/v1/providers/tasks.ts | 2 +- src/v2/providers/remoteConfig.ts | 9 ++++++--- src/v2/providers/tasks.ts | 4 ++-- 7 files changed, 20 insertions(+), 18 deletions(-) diff --git a/src/v1/providers/database.ts b/src/v1/providers/database.ts index 114a0f07c..d59d7de19 100644 --- a/src/v1/providers/database.ts +++ b/src/v1/providers/database.ts @@ -175,7 +175,7 @@ export class RefBuilder { * * @param handler Event handler that runs every time a Firebase Realtime Database * write occurs. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ onWrite( handler: ( @@ -192,8 +192,7 @@ export class RefBuilder { * * @param handler Event handler which is run every time a Firebase Realtime Database * write occurs. - * @returns A Cloud - * Function which you can export and deploy. + * @returns A function which you can export and deploy. */ onUpdate( handler: ( @@ -210,7 +209,7 @@ export class RefBuilder { * * @param handler Event handler that runs every time new data is created in * Firebase Realtime Database. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ onCreate( handler: ( @@ -234,7 +233,7 @@ export class RefBuilder { * * @param handler Event handler that runs every time data is deleted from * Firebase Realtime Database. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ onDelete( handler: ( diff --git a/src/v1/providers/pubsub.ts b/src/v1/providers/pubsub.ts index 3b36dc6ea..57a28803c 100644 --- a/src/v1/providers/pubsub.ts +++ b/src/v1/providers/pubsub.ts @@ -68,7 +68,7 @@ export class TopicBuilder { * * @param handler - Event handler that runs every time a Cloud Pub/Sub message * is published. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ onPublish( handler: (message: Message, context: EventContext) => PromiseLike | any @@ -142,7 +142,7 @@ export class ScheduleBuilder { * * @param handler - Handler that fires whenever the associated * scheduler job sends a Pub/Sub message. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ onRun(handler: (context: EventContext) => PromiseLike | any) { const cloudFunction = makeCloudFunction({ diff --git a/src/v1/providers/remoteConfig.ts b/src/v1/providers/remoteConfig.ts index cc40e4916..cf67383dc 100644 --- a/src/v1/providers/remoteConfig.ts +++ b/src/v1/providers/remoteConfig.ts @@ -35,7 +35,7 @@ export const service = "firebaseremoteconfig.googleapis.com"; * @param handler A function that takes the updated Remote Config * template version metadata as an argument. * - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. */ export function onUpdate( handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any diff --git a/src/v1/providers/storage.ts b/src/v1/providers/storage.ts index 982718432..998760eb6 100644 --- a/src/v1/providers/storage.ts +++ b/src/v1/providers/storage.ts @@ -112,7 +112,7 @@ export class ObjectBuilder { * @param handler Event handler which is run every time a Google Cloud Storage * archival occurs. * - * @returns A Cloud Function which you can export and deploy. + * @returns A function which you can export and deploy. */ onArchive( handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any @@ -132,7 +132,7 @@ export class ObjectBuilder { * @param handler Event handler which is run every time a Google Cloud Storage * deletion occurs. * - * @returns A Cloud Function which you can export and deploy. + * @returns A function which you can export and deploy. */ onDelete( handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any @@ -151,7 +151,7 @@ export class ObjectBuilder { * @param handler Event handler which is run every time a Google Cloud Storage * object creation occurs. * - * @returns A Cloud Function which you can export and deploy. + * @returns A function which you can export and deploy. */ onFinalize( handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any @@ -166,7 +166,7 @@ export class ObjectBuilder { * @param handler Event handler which is run every time a Google Cloud Storage * metadata update occurs. * - * @returns A Cloud Function which you can export and deploy. + * @returns A function which you can export and deploy. */ onMetadataUpdate( handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any diff --git a/src/v1/providers/tasks.ts b/src/v1/providers/tasks.ts index a3f5a6122..039107497 100644 --- a/src/v1/providers/tasks.ts +++ b/src/v1/providers/tasks.ts @@ -90,7 +90,7 @@ export class TaskQueueBuilder { /** * Creates a handler for tasks sent to a Google Cloud Tasks queue. * @param handler - A callback to handle task requests. - * @returns A Cloud Function you can export and deploy. + * @returns A function you can export and deploy. */ onDispatch( handler: (data: any, context: TaskContext) => void | Promise diff --git a/src/v2/providers/remoteConfig.ts b/src/v2/providers/remoteConfig.ts index d36bc617e..f3a6b485e 100644 --- a/src/v2/providers/remoteConfig.ts +++ b/src/v2/providers/remoteConfig.ts @@ -89,7 +89,8 @@ export interface ConfigUpdateData { * Event handler which triggers when data is updated in a Remote Config. * * @param handler - Event handler which is run every time a Remote Config update occurs. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. + * @alpha */ export function onConfigUpdated( handler: (event: CloudEvent) => any | Promise @@ -100,7 +101,8 @@ export function onConfigUpdated( * * @param opts - Options that can be set on an individual event-handling function. * @param handler - Event handler which is run every time a Remote Config update occurs. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. + * @alpha */ export function onConfigUpdated( opts: EventHandlerOptions, @@ -112,7 +114,8 @@ export function onConfigUpdated( * * @param optsOrHandler - Options or an event handler. * @param handler - Event handler which is run every time a Remote Config update occurs. - * @returns A Cloud Function that you can export and deploy. + * @returns A function that you can export and deploy. + * @alpha */ export function onConfigUpdated( optsOrHandler: diff --git a/src/v2/providers/tasks.ts b/src/v2/providers/tasks.ts index 2c7050e46..1300f6b09 100644 --- a/src/v2/providers/tasks.ts +++ b/src/v2/providers/tasks.ts @@ -168,7 +168,7 @@ export interface TaskQueueFunction extends HttpsFunction { * Creates a handler for tasks sent to a Google Cloud Tasks queue. * @param handler - A callback to handle task requests. * @typeParam Args - The interface for the request's `data` field. - * @returns A Cloud Function you can export and deploy. + * @returns A function you can export and deploy. */ export function onTaskDispatched( handler: (request: Request) => void | Promise @@ -179,7 +179,7 @@ export function onTaskDispatched( * @param options - Configuration for the task queue or Cloud Function. * @param handler - A callback to handle task requests. * @typeParam Args - The interface for the request's `data` field. - * @returns A Cloud Function you can export and deploy. + * @returns A function you can export and deploy. */ export function onTaskDispatched( options: TaskQueueOptions, From 70ca698dc664be1d14b154e9b74d836cad3dc2fd Mon Sep 17 00:00:00 2001 From: Cole Rogers Date: Mon, 3 Oct 2022 14:24:30 -0400 Subject: [PATCH 2/2] remove alpha after merge --- src/v2/providers/remoteConfig.ts | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/v2/providers/remoteConfig.ts b/src/v2/providers/remoteConfig.ts index f3a6b485e..4ad5af1d9 100644 --- a/src/v2/providers/remoteConfig.ts +++ b/src/v2/providers/remoteConfig.ts @@ -90,7 +90,6 @@ export interface ConfigUpdateData { * * @param handler - Event handler which is run every time a Remote Config update occurs. * @returns A function that you can export and deploy. - * @alpha */ export function onConfigUpdated( handler: (event: CloudEvent) => any | Promise @@ -102,7 +101,6 @@ export function onConfigUpdated( * @param opts - Options that can be set on an individual event-handling function. * @param handler - Event handler which is run every time a Remote Config update occurs. * @returns A function that you can export and deploy. - * @alpha */ export function onConfigUpdated( opts: EventHandlerOptions, @@ -115,7 +113,6 @@ export function onConfigUpdated( * @param optsOrHandler - Options or an event handler. * @param handler - Event handler which is run every time a Remote Config update occurs. * @returns A function that you can export and deploy. - * @alpha */ export function onConfigUpdated( optsOrHandler: