Avoid abbreviations to improve readability: opts -> options (#495)

Author: merlinnot

src/cloud-functions.ts

@@ -202,7 +202,7 @@ export interface MakeCloudFunctionArgs<EventData> {
   before?: (raw: Event) => void;
   after?: (raw: Event) => void;
   legacyEventType?: string;
-  opts?: { [key: string]: any };
+  options?: { [key: string]: any };
   labels?: { [key: string]: any };
 }
 
@@ -222,7 +222,7 @@ export function makeCloudFunction<EventData>({
     return;
   },
   legacyEventType,
-  opts = {},
+  options = {},
   labels = {},
 }: MakeCloudFunctionArgs<EventData>): CloudFunction<EventData> {
   const cloudFunction: any = (data: any, context: any) => {
@@ -291,7 +291,7 @@ export function makeCloudFunction<EventData>({
         return {};
       }
 
-      const trigger: any = _.assign(optsToTrigger(opts), {
+      const trigger: any = _.assign(optionsToTrigger(options), {
         eventTrigger: {
           resource: triggerResource(),
           eventType: legacyEventType || provider + '.' + eventType,
@@ -356,26 +356,26 @@ function _detectAuthType(event: Event) {
   return 'UNAUTHENTICATED';
 }
 
-export function optsToTrigger(opts: DeploymentOptions) {
+export function optionsToTrigger(options: DeploymentOptions) {
   const trigger: any = {};
-  if (opts.regions) {
-    trigger.regions = opts.regions;
+  if (options.regions) {
+    trigger.regions = options.regions;
   }
-  if (opts.timeoutSeconds) {
-    trigger.timeout = opts.timeoutSeconds.toString() + 's';
+  if (options.timeoutSeconds) {
+    trigger.timeout = options.timeoutSeconds.toString() + 's';
   }
-  if (opts.memory) {
+  if (options.memory) {
     const memoryLookup = {
       '128MB': 128,
       '256MB': 256,
       '512MB': 512,
       '1GB': 1024,
       '2GB': 2048,
     };
-    trigger.availableMemoryMb = _.get(memoryLookup, opts.memory);
+    trigger.availableMemoryMb = _.get(memoryLookup, options.memory);
   }
-  if (opts.schedule) {
-    trigger.schedule = opts.schedule;
+  if (options.schedule) {
+    trigger.schedule = options.schedule;
   }
   return trigger;
 }

src/function-builder.ts

@@ -149,7 +149,7 @@ export class FunctionBuilder {
        */
       onRequest: (
         handler: (req: https.Request, resp: express.Response) => void
-      ) => https._onRequestWithOpts(handler, this.options),
+      ) => https._onRequestWithOptions(handler, this.options),
       /**
        * Declares a callable method for clients to call using a Firebase SDK.
        * @param handler A method that takes a data and context and returns a value.
@@ -159,7 +159,7 @@ export class FunctionBuilder {
           data: any,
           context: https.CallableContext
         ) => any | Promise<any>
-      ) => https._onCallWithOpts(handler, this.options),
+      ) => https._onCallWithOptions(handler, this.options),
     };
   }
 
@@ -171,7 +171,7 @@ export class FunctionBuilder {
        * @param instance The Realtime Database instance to use.
        */
       instance: (instance: string) =>
-        database._instanceWithOpts(instance, this.options),
+        database._instanceWithOptions(instance, this.options),
       /**
        * Select Firebase Realtime Database Reference to listen to.
        *
@@ -195,7 +195,7 @@ export class FunctionBuilder {
        *    about the user who triggered the Cloud Function.
        * @param ref Path of the database to listen to.
        */
-      ref: (path: string) => database._refWithOpts(path, this.options),
+      ref: (path: string) => database._refWithOptions(path, this.options),
     };
   }
 
@@ -209,13 +209,13 @@ export class FunctionBuilder {
        * path is "/users/Ada".
        */
       document: (path: string) =>
-        firestore._documentWithOpts(path, this.options),
+        firestore._documentWithOptions(path, this.options),
       /** @internal */
       namespace: (namespace: string) =>
-        firestore._namespaceWithOpts(namespace, this.options),
+        firestore._namespaceWithOptions(namespace, this.options),
       /** @internal */
       database: (database: string) =>
-        firestore._databaseWithOpts(database, this.options),
+        firestore._databaseWithOptions(database, this.options),
     };
   }
 
@@ -225,7 +225,7 @@ export class FunctionBuilder {
        * Handle events related to Crashlytics issues. An issue in Crashlytics is an
        * aggregation of crashes which have a shared root cause.
        */
-      issue: () => crashlytics._issueWithOpts(this.options),
+      issue: () => crashlytics._issueWithOptions(this.options),
     };
   }
 
@@ -236,7 +236,7 @@ export class FunctionBuilder {
        * @param analyticsEventType Name of the analytics event type.
        */
       event: (analyticsEventType: string) =>
-        analytics._eventWithOpts(analyticsEventType, this.options),
+        analytics._eventWithOptions(analyticsEventType, this.options),
     };
   }
 
@@ -254,9 +254,10 @@ export class FunctionBuilder {
           context: EventContext
         ) => PromiseLike<any> | any
       ) =>
-        remoteConfig._onUpdateWithOpts(handler, this.options) as CloudFunction<
-          remoteConfig.TemplateVersion
-        >,
+        remoteConfig._onUpdateWithOptions(
+          handler,
+          this.options
+        ) as CloudFunction<remoteConfig.TemplateVersion>,
     };
   }
 
@@ -269,12 +270,12 @@ export class FunctionBuilder {
        * @param bucket Name of the Google Cloud Storage bucket to listen to.
        */
       bucket: (bucket?: string) =>
-        storage._bucketWithOpts(this.options, bucket),
+        storage._bucketWithOptions(this.options, bucket),
 
       /**
        * Handle events related to Cloud Storage objects.
        */
-      object: () => storage._objectWithOpts(this.options),
+      object: () => storage._objectWithOptions(this.options),
     };
   }
 
@@ -283,9 +284,9 @@ export class FunctionBuilder {
       /** Select Cloud Pub/Sub topic to listen to.
        * @param topic Name of Pub/Sub topic, must belong to the same project as the function.
        */
-      topic: (topic: string) => pubsub._topicWithOpts(topic, this.options),
+      topic: (topic: string) => pubsub._topicWithOptions(topic, this.options),
       schedule: (schedule: string) =>
-        pubsub._scheduleWithOpts(schedule, this.options),
+        pubsub._scheduleWithOptions(schedule, this.options),
     };
   }
 
@@ -294,7 +295,7 @@ export class FunctionBuilder {
       /**
        * Handle events related to Firebase authentication users.
        */
-      user: () => auth._userWithOpts(this.options),
+      user: () => auth._userWithOptions(this.options),
     };
   }
 }

src/handler-builder.ts

@@ -47,7 +47,7 @@ export class HandlerBuilder {
       onRequest: (
         handler: (req: express.Request, resp: express.Response) => void
       ): HttpsFunction => {
-        const func = https._onRequestWithOpts(handler, {});
+        const func = https._onRequestWithOptions(handler, {});
         func.__trigger = {};
         return func;
       },
@@ -61,7 +61,7 @@ export class HandlerBuilder {
           context: https.CallableContext
         ) => any | Promise<any>
       ): HttpsFunction => {
-        const func = https._onCallWithOpts(handler, {});
+        const func = https._onCallWithOptions(handler, {});
         func.__trigger = {};
         return func;
       },

src/providers/analytics.ts

@@ -40,13 +40,13 @@ export const service = 'app-measurement.com';
  * @param analyticsEventType Name of the analytics event type.
  */
 export function event(analyticsEventType: string) {
-  return _eventWithOpts(analyticsEventType, {});
+  return _eventWithOptions(analyticsEventType, {});
 }
 
 /** @internal */
-export function _eventWithOpts(
+export function _eventWithOptions(
   analyticsEventType: string,
-  opts: DeploymentOptions
+  options: DeploymentOptions
 ) {
   return new AnalyticsEventBuilder(() => {
     if (!process.env.GCLOUD_PROJECT) {
@@ -55,7 +55,7 @@ export function _eventWithOpts(
     return (
       'projects/' + process.env.GCLOUD_PROJECT + '/events/' + analyticsEventType
     );
-  }, opts);
+  }, options);
 }
 
 /**
@@ -67,7 +67,7 @@ export class AnalyticsEventBuilder {
   /** @internal */
   constructor(
     private triggerResource: () => string,
-    private opts: DeploymentOptions
+    private options: DeploymentOptions
   ) {}
 
   /**
@@ -97,7 +97,7 @@ export class AnalyticsEventBuilder {
       legacyEventType: `providers/google.firebase.analytics/eventTypes/event.log`,
       triggerResource: this.triggerResource,
       dataConstructor,
-      opts: this.opts,
+      options: this.options,
     });
   }
 }

src/providers/auth.ts

@@ -39,17 +39,17 @@ export const service = 'firebaseauth.googleapis.com';
  * Handle events related to Firebase authentication users.
  */
 export function user() {
-  return _userWithOpts({});
+  return _userWithOptions({});
 }
 
 /** @internal */
-export function _userWithOpts(opts: DeploymentOptions) {
+export function _userWithOptions(options: DeploymentOptions) {
   return new UserBuilder(() => {
     if (!process.env.GCLOUD_PROJECT) {
       throw new Error('process.env.GCLOUD_PROJECT is not set.');
     }
     return 'projects/' + process.env.GCLOUD_PROJECT;
-  }, opts);
+  }, options);
 }
 
 export class UserRecordMetadata implements firebase.auth.UserMetadata {
@@ -73,7 +73,7 @@ export class UserBuilder {
   /** @internal */
   constructor(
     private triggerResource: () => string,
-    private opts?: DeploymentOptions
+    private options?: DeploymentOptions
   ) {}
 
   /** Respond to the creation of a Firebase Auth user. */
@@ -105,7 +105,7 @@ export class UserBuilder {
       triggerResource: this.triggerResource,
       dataConstructor: UserBuilder.dataConstructor,
       legacyEventType: `providers/firebase.auth/eventTypes/${eventType}`,
-      opts: this.opts,
+      options: this.options,
     });
   }
 }

src/providers/crashlytics.ts

@@ -37,25 +37,25 @@ export const service = 'fabric.io';
  * aggregation of crashes which have a shared root cause.
  */
 export function issue() {
-  return _issueWithOpts({});
+  return _issueWithOptions({});
 }
 
 /** @internal */
-export function _issueWithOpts(opts: DeploymentOptions) {
+export function _issueWithOptions(options: DeploymentOptions) {
   return new IssueBuilder(() => {
     if (!process.env.GCLOUD_PROJECT) {
       throw new Error('process.env.GCLOUD_PROJECT is not set.');
     }
     return 'projects/' + process.env.GCLOUD_PROJECT;
-  }, opts);
+  }, options);
 }
 
 /** Builder used to create Cloud Functions for Crashlytics issue events. */
 export class IssueBuilder {
   /** @internal */
   constructor(
     private triggerResource: () => string,
-    private opts: DeploymentOptions
+    private options: DeploymentOptions
   ) {}
 
   /** @internal */
@@ -95,7 +95,7 @@ export class IssueBuilder {
       service,
       legacyEventType: `providers/firebase.crashlytics/eventTypes/${eventType}`,
       triggerResource: this.triggerResource,
-      opts: this.opts,
+      options: this.options,
     });
   }
 }