From 1af16c13c2e6d63537923ebd0698edc8d41e0117 Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Wed, 30 Oct 2019 13:58:22 -0700 Subject: [PATCH 1/4] I persist in trying to fix links. --- src/cloud-functions.ts | 2 +- src/providers/analytics.ts | 5 +++-- src/providers/database.ts | 4 ++-- src/providers/pubsub.ts | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/cloud-functions.ts b/src/cloud-functions.ts index e8d099dca..1309aba61 100644 --- a/src/cloud-functions.ts +++ b/src/cloud-functions.ts @@ -114,7 +114,7 @@ export interface EventContext { /** * An object containing the values of the wildcards in the `path` parameter - * provided to the [`ref()`](functions.database#.ref) method for a Realtime + * provided to the [`ref()`](providers_database_.html#ref) method for a Realtime * Database trigger. Cannot be accessed while inside the handler namespace. */ params: { [option: string]: any }; diff --git a/src/providers/analytics.ts b/src/providers/analytics.ts index 43578f8b6..2d57d6f5e 100644 --- a/src/providers/analytics.ts +++ b/src/providers/analytics.ts @@ -184,7 +184,7 @@ export class UserDimensions { * A map of user properties set with the * [`setUserProperty`](https://firebase.google.com/docs/analytics/android/properties) API. * - * All values are [`UserPropertyValue`](functions.analytics.UserPropertyValue) objects. + * All values are [`UserPropertyValue`](providers_analytics_.userpropertyvalue) objects. */ userProperties: { [key: string]: UserPropertyValue }; @@ -319,7 +319,8 @@ export interface DeviceInfo { /** * The time zone of the device when data was uploaded, as seconds skew from UTC. - * Use this to calculate the device's local time for [`event.timestamp`](functions.Event#timestamp). + * Use this to calculate the device's local time for + * [`EventContext.timestamp`](cloud_functions_eventcontext.html#timestamp). */ deviceTimeZoneOffsetSeconds: number; diff --git a/src/providers/database.ts b/src/providers/database.ts index 8a2f9453a..e648be20e 100644 --- a/src/providers/database.ts +++ b/src/providers/database.ts @@ -75,7 +75,7 @@ export function instance(instance: string) { * 1. Cloud Functions allows wildcards in the `path` name. Any `path` component * in curly brackets (`{}`) is a wildcard that matches all strings. The value * that matched a certain invocation of a Cloud Function is returned as part - * of the [`event.params`](functions.EventContext#params) object. For + * of the [`EventContext.params`](cloud_functions_eventcontext.html#params object. For * example, `ref("messages/{messageId}")` matches changes at * `/messages/message1` or `/messages/message2`, resulting in * `event.params.messageId` being set to `"message1"` or `"message2"`, @@ -104,7 +104,7 @@ export function _instanceWithOptions( /** * The Firebase Realtime Database instance builder interface. * - * Access via [`functions.database.instance()`](functions.database#.instance). + * Access via [`database.instance()`](providers_database_.html#instance). */ export class InstanceBuilder { /** @hidden */ diff --git a/src/providers/pubsub.ts b/src/providers/pubsub.ts index d1a687819..aee9e6c17 100644 --- a/src/providers/pubsub.ts +++ b/src/providers/pubsub.ts @@ -112,7 +112,7 @@ export function _scheduleWithOptions( /** * The Google Cloud Pub/Sub topic builder. * - * Access via [`functions.pubsub.topic()`](functions.pubsub#.topic). + * Access via [`functions.pubsub.topic()`](providers_pubsub_.html#topic). */ export class TopicBuilder { /** @hidden */ From 44582af421ce94156e02b15bf55a0ed05ee081dd Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Tue, 12 Nov 2019 10:03:55 -0800 Subject: [PATCH 2/4] Adding comments for functions.config() along with a change that somehow evaded my last update to storage.ts. --- src/config.ts | 13 +++++++++++-- src/providers/storage.ts | 4 ++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src/config.ts b/src/config.ts index 9823b3746..e16457570 100644 --- a/src/config.ts +++ b/src/config.ts @@ -29,9 +29,18 @@ export function config(): config.Config { return config.singleton; } +/** + * Store and retrieve project configuration data such as third-party API + * keys or other settings. You can set configuration values using the + * Firebase CLI as described in + * [Environment Configuration](/docs/functions/config-env). + */ export namespace config { - // Config type is usable as a object (dot notation allowed), and firebase - // property will also code complete. + /** + * The Functions configuration interface. + * + * Access via [`functions.config()`](functions.config#config). + */ export interface Config { [key: string]: any; } diff --git a/src/providers/storage.ts b/src/providers/storage.ts index 3ba98ea72..33b2a64eb 100644 --- a/src/providers/storage.ts +++ b/src/providers/storage.ts @@ -84,7 +84,7 @@ export function _objectWithOptions(options: DeploymentOptions): ObjectBuilder { /** * The Google Cloud Storage bucket builder interface. * - * Access via [`functions.storage.bucket()`](functions.storage#.bucket). + * Access via [`functions.storage.bucket()`](providers_storage_.html#bucket). */ export class BucketBuilder { /** @hidden */ @@ -107,7 +107,7 @@ export class BucketBuilder { /** * The Google Cloud Storage object builder interface. * - * Access via [`functions.storage.object()`](functions.storage#.object). + * Access via [`functions.storage.object()`](providers_storage_.html#object). */ export class ObjectBuilder { /** @hidden */ From 910eaa3c780321379c4f48508cb09156ef9a0f11 Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Tue, 12 Nov 2019 10:41:09 -0800 Subject: [PATCH 3/4] Adding new entry for new config.Config.html file. --- docgen/content-sources/toc.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docgen/content-sources/toc.yaml b/docgen/content-sources/toc.yaml index 9ba761c15..378af2eef 100644 --- a/docgen/content-sources/toc.yaml +++ b/docgen/content-sources/toc.yaml @@ -20,6 +20,8 @@ toc: section: - title: 'Config' path: /docs/reference/functions/config_.config.html + - title: 'config.Config' + path: /docs/reference/functions/config_.config.config.html - title: 'functions.analytics' path: /docs/reference/functions/providers_analytics_.html From f6f6c4615eb35f7307615ba9212e9b56c1f2d534 Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Thu, 14 Nov 2019 14:16:20 -0800 Subject: [PATCH 4/4] Removing circular link per review. --- src/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/config.ts b/src/config.ts index e16457570..8cd4d3dd1 100644 --- a/src/config.ts +++ b/src/config.ts @@ -39,7 +39,7 @@ export namespace config { /** * The Functions configuration interface. * - * Access via [`functions.config()`](functions.config#config). + * Access via `functions.config()`. */ export interface Config { [key: string]: any;