Skip to content

Commit edcb35d

Browse files
authored
Porting in minimal content for functions.config() reference (#582)
* I persist in trying to fix links. * Adding comments for functions.config() along with a change that somehow evaded my last update to storage.ts. * Adding new entry for new config.Config.html file. * Removing circular link per review.
1 parent dd6cde1 commit edcb35d

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docgen/content-sources/toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ toc:
2020
section:
2121
- title: 'Config'
2222
path: /docs/reference/functions/config_.config.html
23+
- title: 'config.Config'
24+
path: /docs/reference/functions/config_.config.config.html
2325

2426
- title: 'functions.analytics'
2527
path: /docs/reference/functions/providers_analytics_.html

src/config.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,18 @@ export function config(): config.Config {
2929
return config.singleton;
3030
}
3131

32+
/**
33+
* Store and retrieve project configuration data such as third-party API
34+
* keys or other settings. You can set configuration values using the
35+
* Firebase CLI as described in
36+
* [Environment Configuration](/docs/functions/config-env).
37+
*/
3238
export namespace config {
33-
// Config type is usable as a object (dot notation allowed), and firebase
34-
// property will also code complete.
39+
/**
40+
* The Functions configuration interface.
41+
*
42+
* Access via `functions.config()`.
43+
*/
3544
export interface Config {
3645
[key: string]: any;
3746
}

src/providers/storage.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export function _objectWithOptions(options: DeploymentOptions): ObjectBuilder {
8484
/**
8585
* The Google Cloud Storage bucket builder interface.
8686
*
87-
* Access via [`functions.storage.bucket()`](functions.storage#.bucket).
87+
* Access via [`functions.storage.bucket()`](providers_storage_.html#bucket).
8888
*/
8989
export class BucketBuilder {
9090
/** @hidden */
@@ -107,7 +107,7 @@ export class BucketBuilder {
107107
/**
108108
* The Google Cloud Storage object builder interface.
109109
*
110-
* Access via [`functions.storage.object()`](functions.storage#.object).
110+
* Access via [`functions.storage.object()`](providers_storage_.html#object).
111111
*/
112112
export class ObjectBuilder {
113113
/** @hidden */

0 commit comments

Comments
 (0)