Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9fd7018
Adding required tags to page template.
egilmorez Oct 26, 2020
34db981
Adding formatting and fixing typo discovered in internal review.
egilmorez Oct 26, 2020
67a53d5
More fixes/additions discovered in internal review.
egilmorez Oct 26, 2020
0d0f05e
Fixing format of toc.yaml file.
egilmorez Oct 29, 2020
02f302c
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Dec 4, 2020
2e08097
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Dec 9, 2020
27cc59d
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Mar 5, 2021
8f177fd
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Mar 23, 2021
52c9260
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Jul 29, 2021
d540ba2
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Jul 29, 2021
d213e78
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Aug 5, 2021
a1b1d26
Adding EAP TOC and index top matter.
egilmorez Aug 6, 2021
087ec85
Updating TOC prior to retrying docgen. I believe changes to other fi…
egilmorez Aug 9, 2021
7c181ef
Merging TOC and updating index top matter.
egilmorez Aug 11, 2021
ff11c26
Refine TOC, fix paths in template, attempt to hide params.
egilmorez Aug 11, 2021
f4b5f36
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Aug 11, 2021
11172be
Merge branch 'master' of github.com:firebase/firebase-functions into …
egilmorez Aug 12, 2021
9ceafff
Doing all possible to make this YAML valid. VSCode extensions believ…
egilmorez Aug 12, 2021
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
8 changes: 4 additions & 4 deletions docgen/content-sources/v2/HOME.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Firebase Functions v2 SDK Reference

The `firebase-functions` package provides an SDK for defining Cloud Functions for Firebase.
This package provides an SDK for defining Cloud Functions for Firebase v2.

To get started using Cloud Functions, see
[Get started: write, test, and deploy your first functions](/docs/functions/get-started).
To get started using Cloud Functions v2, see
the early access guide you were provided when you joined the EAP program.

For source code, see the [Cloud Functions for Firebase GitHub repo](https://github.com/firebase/firebase-functions).
**Important:** This API reference is confidential. Do not share or discuss until authorized to do so.
38 changes: 20 additions & 18 deletions docgen/content-sources/v2/toc.yaml
Original file line number Diff line number Diff line change
@@ -1,34 +1,36 @@
toc:
- title: functions
path: /docs/functions/alpha/v2.html
- title: functions.core
- title: 'functions'
path: /docs/functions/alpha/index.html
- title: 'functions.core'
path: /docs/functions/alpha/v2_core.html
section:
- title: functions.CloudEvent
path: /docs/functions/alpha/v2_core.cloudevent.html
- title: functions.CloudFunction
path: /docs/functions/alpha/v2_core.cloudfunction.html
- title: functions.https
- title: 'Functions v2'
path: /docs/functions/alpha/v2.html
- title: 'functions.CloudEvent'
path: /docs/functions/alpha/v2_core.CloudEvent.html
- title: 'functions.CloudFunction'
path: /docs/functions/alpha/v2_core.CloudFunction.html
- title: 'functions.https'
path: /docs/functions/alpha/v2_providers_https.html
section:
- title: functions.https.options
path: /docs/functions/alpha/v2_providers_https.httpsoptions.html
- title: 'functions.https.CallableFunction'
path: /docs/functions/alpha/v2_providers_https.CallableFunction.html
- title: 'functions.https.options'
path: /docs/functions/alpha/v2_providers_https.HttpsOptions.html
- title: 'functions.logger'
path: /docs/functions/alpha/logger.html
section:
- title: 'LogEntry'
path: /docs/functions/alpha/logger.LogEntry.html
- title: functions.options
- title: 'functions.options'
path: /docs/functions/alpha/v2_options.html
section:
- title: functions.options.GlobalOptions
path: /docs/functions/alpha/v2_options.globaloptions.html
- title: functions.options.EventHandlerOptions
path: /docs/functions/alpha/v2_options.eventhandleroptions.html
- title: functions.params
path: /docs/functions/alpha/v2_params.html
- title: 'functions.options.GlobalOptions'
path: /docs/functions/alpha/v2_options.GlobalOptions.html
- title: 'functions.options.EventHandlerOptions'
path: /docs/functions/alpha/v2_options.EventHandlerOptions.html
- title: 'functions.pubsub'
path: /docs/functions/v2_providers_pubsub.html
path: /docs/functions/alpha/v2_providers_pubsub.html
section:
- title: 'Message'
path: /docs/functions/alpha/v2_providers_pubsub.Message.html
Expand Down
4 changes: 2 additions & 2 deletions docgen/theme/layouts/default.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="hide_page_heading" value="true" />
<meta name="project_path" value="/_project.yaml" />
<meta name="book_path" value="/docs/reference/_book.yaml" />
<meta name="gtm_var" data-key="docType" data-value="reference">
<meta name="book_path" value="/docs/_book.yaml" />
<meta name="gtm_var" data-key="docType" data-value="how-to">
<meta name="page_type" value="reference" />
<meta name="translation" value="disabled" />
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
Expand Down
1 change: 1 addition & 0 deletions src/v2/params/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/** @hidden */
import {
BooleanParam,
FloatParam,
Expand Down
1 change: 1 addition & 0 deletions src/v2/params/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/** @hidden */
type ParamValueType = 'string' | 'list' | 'boolean' | 'int' | 'float' | 'json';

export interface ParamSpec<T = unknown> {
Expand Down