From b5e07c920582cdeec5effcc497e32a7a7cac028d Mon Sep 17 00:00:00 2001 From: Michael Bleigh Date: Wed, 8 Sep 2021 10:26:21 -0700 Subject: [PATCH 1/5] half-hearted attempt at rushstack - much work to be done --- .gitignore | 4 +- docgen/api-extractor.base.json | 364 + docgen/api-extractor.v1.json | 14 + docgen/api-extractor.v2.json | 14 + docgen/tsconfig.json | 3 - docgen/v1/firebase-functions.api.json | 13215 ++++++++++++++++++++++++ docgen/v1/firebase-functions.api.md | 1080 ++ docgen/v2/firebase-functions.api.json | 3668 +++++++ docgen/v2/firebase-functions.api.md | 329 + package-lock.json | 496 +- package.json | 12 + 11 files changed, 19192 insertions(+), 7 deletions(-) create mode 100644 docgen/api-extractor.base.json create mode 100644 docgen/api-extractor.v1.json create mode 100644 docgen/api-extractor.v2.json delete mode 100644 docgen/tsconfig.json create mode 100644 docgen/v1/firebase-functions.api.json create mode 100644 docgen/v1/firebase-functions.api.md create mode 100644 docgen/v2/firebase-functions.api.json create mode 100644 docgen/v2/firebase-functions.api.md diff --git a/.gitignore b/.gitignore index b5a890408..a413de2d6 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,8 @@ .vscode/ coverage docgen/html +docgen/*/temp +docgen/*/markdown firebase-functions-*.tgz integration_test/.firebaserc integration_test/*.log @@ -14,4 +16,4 @@ node_modules npm-debug.log typings yarn.lock -.DS_Store +.DS_Store \ No newline at end of file diff --git a/docgen/api-extractor.base.json b/docgen/api-extractor.base.json new file mode 100644 index 000000000..007e0b60f --- /dev/null +++ b/docgen/api-extractor.base.json @@ -0,0 +1,364 @@ +/** + * Config file for API Extractor. For more info, please visit: https://api-extractor.com + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + /** + * Optionally specifies another JSON config file that this file extends from. This provides a way for + * standard settings to be shared across multiple projects. + * + * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains + * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be + * resolved using NodeJS require(). + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "extends": "./shared/api-extractor-base.json" + // "extends": "my-package/include/api-extractor-base.json" + + /** + * Determines the "" token that can be used with other config file settings. The project folder + * typically contains the tsconfig.json and package.json config files, but the path is user-defined. + * + * The path is resolved relative to the folder of the config file that contains the setting. + * + * The default value for "projectFolder" is the token "", which means the folder is determined by traversing + * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder + * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error + * will be reported. + * + * SUPPORTED TOKENS: + * DEFAULT VALUE: "" + */ + "projectFolder": "..", + + /** + * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor + * analyzes the symbols exported by this module. + * + * The file extension must be ".d.ts" and not ".ts". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + */ + "mainEntryPointFilePath": "/lib/index.d.ts", + + /** + * A list of NPM package names whose exports should be treated as part of this package. + * + * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", + * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part + * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly + * imports library2. To avoid this, we can specify: + * + * "bundledPackages": [ "library2" ], + * + * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been + * local files for library1. + */ + "bundledPackages": [], + + /** + * Determines how the TypeScript compiler engine will be invoked by API Extractor. + */ + "compiler": { + /** + * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * Note: This setting will be ignored if "overrideTsconfig" is used. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/tsconfig.json" + */ + // "tsconfigFilePath": "/tsconfig.json", + /** + * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + * The object must conform to the TypeScript tsconfig schema: + * + * http://json.schemastore.org/tsconfig + * + * If omitted, then the tsconfig.json file will be read from the "projectFolder". + * + * DEFAULT VALUE: no overrideTsconfig section + */ + // "overrideTsconfig": { + // . . . + // } + /** + * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended + * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when + * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses + * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + * + * DEFAULT VALUE: false + */ + // "skipLibCheck": true, + }, + + /** + * Configures how the API report file (*.api.md) will be generated. + */ + "apiReport": { + /** + * (REQUIRED) Whether to generate an API report. + */ + "enabled": true, + + /** + * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce + * a full file path. + * + * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". + * + * SUPPORTED TOKENS: , + * DEFAULT VALUE: ".api.md" + */ + // "reportFileName": ".api.md", + + /** + * Specifies the folder where the API report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, + * e.g. for an API review. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/etc/" + */ + "reportFolder": "/docgen/etc/", + + /** + * Specifies the folder where the temporary report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * After the temporary file is written to disk, it is compared with the file in the "reportFolder". + * If they are different, a production build will fail. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + "reportTempFolder": "/docgen/temp/" + }, + + /** + * Configures how the doc model file (*.api.json) will be generated. + */ + "docModel": { + /** + * (REQUIRED) Whether to generate a doc model file. + */ + "enabled": true, + + /** + * The output path for the doc model file. The file extension should be ".api.json". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/.api.json" + */ + "apiJsonFilePath": "/docgen/.api.json" + }, + + /** + * Configures how the .d.ts rollup file will be generated. + */ + "dtsRollup": { + /** + * (REQUIRED) Whether to generate the .d.ts rollup file. + */ + "enabled": true + + /** + * Specifies the output path for a .d.ts rollup file to be generated without any trimming. + * This file will include all declarations that are exported by the main entry point. + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/dist/.d.ts" + */ + // "untrimmedFilePath": "/dist/.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + * This file will include only declarations that are marked as "@public" or "@beta". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "betaTrimmedFilePath": "/dist/-beta.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + * This file will include only declarations that are marked as "@public". + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "publicTrimmedFilePath": "/dist/-public.d.ts", + + /** + * When a declaration is trimmed, by default it will be replaced by a code comment such as + * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the + * declaration completely. + * + * DEFAULT VALUE: false + */ + // "omitTrimmingComments": true + }, + + /** + * Configures how the tsdoc-metadata.json file will be generated. + */ + "tsdocMetadata": { + /** + * Whether to generate the tsdoc-metadata.json file. + * + * DEFAULT VALUE: true + */ + // "enabled": true, + /** + * Specifies where the TSDoc metadata file should be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", + * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup + * falls back to "tsdoc-metadata.json" in the package folder. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" + }, + + /** + * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files + * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. + * To use the OS's default newline kind, specify "os". + * + * DEFAULT VALUE: "crlf" + */ + // "newlineKind": "crlf", + + /** + * Configures how API Extractor reports error and warning messages produced during analysis. + * + * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. + */ + "messages": { + /** + * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing + * the input .d.ts files. + * + * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "compilerMessageReporting": { + /** + * Configures the default routing for messages that don't match an explicit rule in this table. + */ + "default": { + /** + * Specifies whether the message should be written to the the tool's output log. Note that + * the "addToApiReportFile" property may supersede this option. + * + * Possible values: "error", "warning", "none" + * + * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail + * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes + * the "--local" option), the warning is displayed but the build will not fail. + * + * DEFAULT VALUE: "warning" + */ + "logLevel": "warning" + + /** + * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), + * then the message will be written inside that file; otherwise, the message is instead logged according to + * the "logLevel" option. + * + * DEFAULT VALUE: false + */ + // "addToApiReportFile": false + } + + // "TS2551": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by API Extractor during its analysis. + * + * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" + * + * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings + */ + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "ae-extra-release-tag": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by the TSDoc parser when analyzing code comments. + * + * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "tsdoc-link-tag-unescaped-text": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + } + } +} diff --git a/docgen/api-extractor.v1.json b/docgen/api-extractor.v1.json new file mode 100644 index 000000000..f03058f13 --- /dev/null +++ b/docgen/api-extractor.v1.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "extends": "./api-extractor.base.json", + "mainEntryPointFilePath": "/lib/index.d.ts", + "docModel": { + "enabled": true, + "apiJsonFilePath": "/docgen/v1/firebase-functions.api.json" + }, + "apiReport": { + "enabled": true, + "reportTempFolder": "/docgen/v1/temp", + "reportFolder": "/docgen/v1" + } +} diff --git a/docgen/api-extractor.v2.json b/docgen/api-extractor.v2.json new file mode 100644 index 000000000..2cf0596b7 --- /dev/null +++ b/docgen/api-extractor.v2.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "extends": "./api-extractor.base.json", + "mainEntryPointFilePath": "/lib/v2/index.d.ts", + "docModel": { + "enabled": true, + "apiJsonFilePath": "/docgen/v2/firebase-functions.api.json" + }, + "apiReport": { + "enabled": true, + "reportTempFolder": "/docgen/v2/temp", + "reportFolder": "/docgen/v2" + } +} diff --git a/docgen/tsconfig.json b/docgen/tsconfig.json deleted file mode 100644 index 3c43903cf..000000000 --- a/docgen/tsconfig.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "../tsconfig.json" -} diff --git a/docgen/v1/firebase-functions.api.json b/docgen/v1/firebase-functions.api.json new file mode 100644 index 000000000..f719b75e1 --- /dev/null +++ b/docgen/v1/firebase-functions.api.json @@ -0,0 +1,13215 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.18.7", + "schemaVersion": 1004, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + } + } + }, + "kind": "Package", + "canonicalReference": "firebase-functions!", + "docComment": "", + "name": "firebase-functions", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "firebase-functions!", + "name": "", + "members": [ + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!analytics:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "analytics", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!analytics._eventWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _eventWithOptions(analyticsEventType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AnalyticsEventBuilder", + "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "analyticsEventType", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_eventWithOptions" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent:class", + "docComment": "/**\n * Interface representing a Firebase Analytics event that was logged for a specific user.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class AnalyticsEvent " + } + ], + "releaseTag": "Public", + "name": "AnalyticsEvent", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `AnalyticsEvent` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(wireFormat: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "wireFormat", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#logTime:member", + "docComment": "/**\n * UTC client time when the event happened.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "logTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#name:member", + "docComment": "/**\n * The name of the event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#params:member", + "docComment": "/**\n * A map of parameters and their values associated with the event.\n *\n * Note: Values in this map are cast to the most appropriate type. Due to the nature of JavaScript's number handling, this might entail a loss of precision in cases of very large integers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "params: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "params", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#previousLogTime:member", + "docComment": "/**\n * UTC client time when the previous event happened.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "previousLogTime?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "previousLogTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#reportingDate:member", + "docComment": "/**\n * The date on which the event.was logged. (`YYYYMMDD` format in the registered timezone of your app).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "reportingDate: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "reportingDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#user:member", + "docComment": "/**\n * User-related dimensions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "user?: " + }, + { + "kind": "Reference", + "text": "UserDimensions", + "canonicalReference": "firebase-functions!UserDimensions:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "user", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#valueInUSD:member", + "docComment": "/**\n * Value parameter in USD.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "valueInUSD?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "valueInUSD", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder:class", + "docComment": "/**\n * The Firebase Analytics event builder interface.\n *\n * Access via [`functions.analytics.event()`](functions.analytics#.event).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class AnalyticsEventBuilder " + } + ], + "releaseTag": "Public", + "name": "AnalyticsEventBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `AnalyticsEventBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder#onLog:member(1)", + "docComment": "/**\n * Event handler that fires every time a Firebase Analytics event occurs.\n *\n * @param handler - Event handler that fires every time a Firebase Analytics event occurs.\n *\n * @return A function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onLog(handler: " + }, + { + "kind": "Content", + "text": "(event: " + }, + { + "kind": "Reference", + "text": "AnalyticsEvent", + "canonicalReference": "firebase-functions!AnalyticsEvent:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AnalyticsEvent", + "canonicalReference": "firebase-functions!AnalyticsEvent:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onLog" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!analytics.AppInfo:interface", + "docComment": "/**\n * Interface representing the application that triggered these events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface AppInfo " + } + ], + "releaseTag": "Public", + "name": "AppInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.AppInfo#appId:member", + "docComment": "/**\n * Unique application identifier within an app store.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "appId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.AppInfo#appInstanceId:member", + "docComment": "/**\n * Unique ID for this instance of the app.\n *\n * Example: \"71683BF9FA3B4B0D9535A1F05188BAF3\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appInstanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "appInstanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.AppInfo#appPlatform:member", + "docComment": "/**\n * The app platform.\n *\n * Examples: \"ANDROID\", \"IOS\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appPlatform: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "appPlatform", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.AppInfo#appStore:member", + "docComment": "/**\n * The identifier of the store that installed the app.\n *\n * Examples: \"com.sec.android.app.samsungapps\", \"com.amazon.venezia\", \"com.nokia.nstore\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appStore?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "appStore", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.AppInfo#appVersion:member", + "docComment": "/**\n * The app's version name.\n *\n * Examples: \"1.0\", \"4.3.1.1.213361\", \"2.3 (1824253)\", \"v1.8b22p6\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appVersion?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "appVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!analytics.DeviceInfo:interface", + "docComment": "/**\n * Interface representing the device that triggered these Firebase Analytics events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface DeviceInfo " + } + ], + "releaseTag": "Public", + "name": "DeviceInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceCategory:member", + "docComment": "/**\n * Device category.\n *\n * Examples: \"tablet\" or \"mobile\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deviceCategory?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "deviceCategory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceId:member", + "docComment": "/**\n * Vendor specific device identifier. This is IDFV on iOS. Not used for Android.\n *\n * Example: '599F9C00-92DC-4B5C-9464-7971F01F8370'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deviceId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "deviceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceModel:member", + "docComment": "/**\n * Device model, as read from the OS.\n *\n * Example: \"iPhone9,1\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deviceModel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "deviceModel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceTimeZoneOffsetSeconds:member", + "docComment": "/**\n * 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 [`EventContext.timestamp`](cloud_functions_eventcontext.html#timestamp).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deviceTimeZoneOffsetSeconds: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "deviceTimeZoneOffsetSeconds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#limitedAdTracking:member", + "docComment": "/**\n * The device's Limit Ad Tracking setting. When `true`, you cannot use `resettableDeviceId` for remarketing, demographics or influencing ads serving behaviour. However, you can use `resettableDeviceId` for conversion tracking and campaign attribution.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "limitedAdTracking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "limitedAdTracking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileBrandName:member", + "docComment": "/**\n * Device brand name.\n *\n * Examples: \"Samsung\", \"HTC\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mobileBrandName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "mobileBrandName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileMarketingName:member", + "docComment": "/**\n * Device marketing name.\n *\n * Example: \"Galaxy S4 Mini\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mobileMarketingName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "mobileMarketingName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileModelName:member", + "docComment": "/**\n * Device model name in human-readable format.\n *\n * Example: \"iPhone 7\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mobileModelName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "mobileModelName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#platformVersion:member", + "docComment": "/**\n * Device OS version when data capture ended.\n *\n * Example: \"4.4.2\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "platformVersion?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "platformVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#resettableDeviceId:member", + "docComment": "/**\n * The type of the [`resettable_device_id`](https://support.google.com/dfp_premium/answer/6238701?hl=en) is IDFA on iOS (when available) and AdId on Android.\n *\n * Example: \"71683BF9-FA3B-4B0D-9535-A1F05188BAF3\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resettableDeviceId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "resettableDeviceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.DeviceInfo#userDefaultLanguage:member", + "docComment": "/**\n * The user language in language-country format, where language is an ISO 639 value and country is an ISO 3166 value.\n *\n * Examples: \"en-us\", \"en-za\", \"zh-tw\", \"jp\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "userDefaultLanguage: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "userDefaultLanguage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!analytics.event:function(1)", + "docComment": "/**\n * Registers a function to handle analytics events.\n *\n * @param analyticsEventType - Name of the analytics event type to which this Cloud Function is scoped.\n *\n * @return Analytics event builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function event(analyticsEventType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AnalyticsEventBuilder", + "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "analyticsEventType", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "event" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!analytics.ExportBundleInfo:class", + "docComment": "/**\n * Interface representing the bundle these events were uploaded to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ExportBundleInfo " + } + ], + "releaseTag": "Public", + "name": "ExportBundleInfo", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!analytics.ExportBundleInfo:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `ExportBundleInfo` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(wireFormat: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "wireFormat", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.ExportBundleInfo#bundleSequenceId:member", + "docComment": "/**\n * Monotonically increasing index for each bundle set by the Analytics SDK.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bundleSequenceId: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bundleSequenceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.ExportBundleInfo#serverTimestampOffset:member", + "docComment": "/**\n * Timestamp offset (in milliseconds) between collection time and upload time.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "serverTimestampOffset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "serverTimestampOffset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!analytics.GeoInfo:interface", + "docComment": "/**\n * Interface representing the geographic origin of the events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface GeoInfo " + } + ], + "releaseTag": "Public", + "name": "GeoInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.GeoInfo#city:member", + "docComment": "/**\n * The geographic city.\n *\n * Example: \"Sao Paulo\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "city?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "city", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.GeoInfo#continent:member", + "docComment": "/**\n * The geographic continent.\n *\n * Example: \"South America\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "continent?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "continent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.GeoInfo#country:member", + "docComment": "/**\n * The geographic country.\n *\n * Example: \"Brazil\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "country?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "country", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!analytics.GeoInfo#region:member", + "docComment": "/**\n * The geographic region.\n *\n * Example: \"State of Sao Paulo\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "region?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "region", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!analytics.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.analytics\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!analytics.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"app-measurement.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!analytics.UserDimensions:class", + "docComment": "/**\n * Interface representing the user who triggered the events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class UserDimensions " + } + ], + "releaseTag": "Public", + "name": "UserDimensions", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!analytics.UserDimensions:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `UserDimensions` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(wireFormat: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "wireFormat", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#appInfo:member", + "docComment": "/**\n * App information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "appInfo?: " + }, + { + "kind": "Reference", + "text": "AppInfo", + "canonicalReference": "firebase-functions!AppInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "appInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#bundleInfo:member", + "docComment": "/**\n * Information regarding the bundle in which these events were uploaded.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bundleInfo: " + }, + { + "kind": "Reference", + "text": "ExportBundleInfo", + "canonicalReference": "firebase-functions!ExportBundleInfo:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bundleInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#deviceInfo:member", + "docComment": "/**\n * Device information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deviceInfo: " + }, + { + "kind": "Reference", + "text": "DeviceInfo", + "canonicalReference": "firebase-functions!DeviceInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "deviceInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#firstOpenTime:member", + "docComment": "/**\n * The time (in UTC) at which the user first opened the app.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "firstOpenTime?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "firstOpenTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#geoInfo:member", + "docComment": "/**\n * User's geographic information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "geoInfo: " + }, + { + "kind": "Reference", + "text": "GeoInfo", + "canonicalReference": "firebase-functions!GeoInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "geoInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#userId:member", + "docComment": "/**\n * The user ID set via the `setUserId` API. [Android](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#setUserId(java.lang.String)) [iOS](https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#/c:objc(cs)FIRAnalytics(cm)setUserID)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "userId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "userId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserDimensions#userProperties:member", + "docComment": "/**\n * A map of user properties set with the [`setUserProperty`](https://firebase.google.com/docs/analytics/android/properties) API.\n *\n * All values are [`UserPropertyValue`](providers_analytics_.userpropertyvalue) objects.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "userProperties: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: " + }, + { + "kind": "Reference", + "text": "UserPropertyValue", + "canonicalReference": "firebase-functions!UserPropertyValue:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "userProperties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!analytics.UserPropertyValue:class", + "docComment": "/**\n * Predefined or custom properties stored on the client side.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class UserPropertyValue " + } + ], + "releaseTag": "Public", + "name": "UserPropertyValue", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!analytics.UserPropertyValue:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `UserPropertyValue` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(wireFormat: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "wireFormat", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserPropertyValue#setTime:member", + "docComment": "/**\n * UTC client time when the user property was last set.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "setTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!analytics.UserPropertyValue#value:member", + "docComment": "/**\n * The last set value of a user property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "value: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!app:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "app: " + }, + { + "kind": "Content", + "text": "apps." + }, + { + "kind": "Reference", + "text": "apps.Apps", + "canonicalReference": "firebase-functions!apps.Apps:class" + } + ], + "releaseTag": "Public", + "name": "app", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!auth:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "auth", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!auth._userWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _userWithOptions(options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "UserBuilder", + "canonicalReference": "firebase-functions!UserBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "_userWithOptions" + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!auth.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.firebase.auth\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!auth.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"firebaseauth.googleapis.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!auth.user:function(1)", + "docComment": "/**\n * Handle events related to Firebase authentication users.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function user(): " + }, + { + "kind": "Reference", + "text": "UserBuilder", + "canonicalReference": "firebase-functions!UserBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "user" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!auth.UserBuilder:class", + "docComment": "/**\n * Builder used to create Cloud Functions for Firebase Auth user lifecycle events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class UserBuilder " + } + ], + "releaseTag": "Public", + "name": "UserBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!auth.UserBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `UserBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!auth.UserBuilder#onCreate:member(1)", + "docComment": "/**\n * Respond to the creation of a Firebase Auth user.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onCreate(handler: " + }, + { + "kind": "Content", + "text": "(user: " + }, + { + "kind": "Reference", + "text": "UserRecord", + "canonicalReference": "firebase-functions!UserRecord:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UserRecord", + "canonicalReference": "firebase-functions!UserRecord:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onCreate" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!auth.UserBuilder#onDelete:member(1)", + "docComment": "/**\n * Respond to the deletion of a Firebase Auth user.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDelete(handler: " + }, + { + "kind": "Content", + "text": "(user: " + }, + { + "kind": "Reference", + "text": "UserRecord", + "canonicalReference": "firebase-functions!UserRecord:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UserRecord", + "canonicalReference": "firebase-functions!UserRecord:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onDelete" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!auth.UserInfo:type", + "docComment": "/**\n * UserInfo that is part of the UserRecord\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type UserInfo = " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "auth.UserInfo", + "canonicalReference": "firebase-admin!auth.UserInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UserInfo", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!auth.UserRecord:type", + "docComment": "/**\n * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin SDK.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type UserRecord = " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "auth.UserRecord", + "canonicalReference": "firebase-admin!auth.UserRecord:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UserRecord", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!auth.userRecordConstructor:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function userRecordConstructor(wireData: " + }, + { + "kind": "Reference", + "text": "Object", + "canonicalReference": "!Object:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "auth.UserRecord", + "canonicalReference": "firebase-admin!auth.UserRecord:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "wireData", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "userRecordConstructor" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!auth.UserRecordMetadata:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class UserRecordMetadata implements " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "auth.UserMetadata", + "canonicalReference": "firebase-admin!auth.UserMetadata:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "UserRecordMetadata", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!auth.UserRecordMetadata:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `UserRecordMetadata` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(creationTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", lastSignInTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "creationTime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "lastSignInTime", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!auth.UserRecordMetadata#creationTime:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "creationTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "creationTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!auth.UserRecordMetadata#lastSignInTime:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "lastSignInTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "lastSignInTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!auth.UserRecordMetadata#toJSON:member(1)", + "docComment": "/**\n * Returns a plain JavaScript object with the properties of UserRecordMetadata.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Content", + "text": "{\n creationTime: string;\n lastSignInTime: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + } + ] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!Change:class", + "docComment": "/**\n * The Functions interface for events that change state, such as Realtime Database or Cloud Firestore `onWrite` and `onUpdate`.\n *\n * For more information about the format used to construct `Change` objects, see [`cloud-functions.ChangeJson`](/docs/reference/functions/cloud_functions_.changejson).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Change " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "Change", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!Change:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Change` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(before: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ", after: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "before", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "after", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!Change#after:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "after: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "after", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!Change#before:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "before: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "before", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!Change:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare namespace Change " + } + ], + "releaseTag": "Public", + "name": "Change", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!Change.applyFieldMask:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "function applyFieldMask(sparseBefore: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", after: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", fieldMask: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sparseBefore", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "after", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "fieldMask", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "applyFieldMask" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!Change.fromJSON:function(1)", + "docComment": "/**\n * @hidden Factory method for creating a Change from a JSON and an optional customizer function to be applied to both the `before` and the `after` fields.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "function fromJSON(json: " + }, + { + "kind": "Reference", + "text": "ChangeJson", + "canonicalReference": "firebase-functions!ChangeJson:interface" + }, + { + "kind": "Content", + "text": ", customizer?: " + }, + { + "kind": "Content", + "text": "(x: any) => T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "json", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "customizer", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "fromJSON" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!Change.fromObjects:function(1)", + "docComment": "/**\n * @hidden Factory method for creating a Change from a `before` object and an `after` object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "function fromObjects(before: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ", after: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "before", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "after", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "fromObjects" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!ChangeJson:interface", + "docComment": "/**\n * `ChangeJson` is the JSON format used to construct a Change object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ChangeJson " + } + ], + "releaseTag": "Public", + "name": "ChangeJson", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ChangeJson#after:member", + "docComment": "/**\n * Key-value pairs representing state of data after the change.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "after?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "after", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ChangeJson#before:member", + "docComment": "/**\n * Key-value pairs representing state of data before the change. If `fieldMask` is set, then only fields that changed are present in `before`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "before?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "before", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ChangeJson#fieldMask:member", + "docComment": "/**\n * @hidden Comma-separated string that represents names of fields that changed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fieldMask?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "fieldMask", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!CloudFunction:type", + "docComment": "/**\n * The Cloud Function type for all non-HTTPS triggers. This should be exported from your JavaScript file to define a Cloud Function.\n *\n * This type is a special JavaScript function which takes a templated `Event` object as its only argument.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type CloudFunction = " + }, + { + "kind": "Reference", + "text": "Runnable", + "canonicalReference": "firebase-functions!Runnable:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "TriggerAnnotated", + "canonicalReference": "firebase-functions!TriggerAnnotated:interface" + }, + { + "kind": "Content", + "text": " & ((input: any, context?: any) => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any)" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CloudFunction", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!config:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function config(): " + }, + { + "kind": "Reference", + "text": "config.Config", + "canonicalReference": "firebase-functions!config.Config:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "config" + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!config:namespace", + "docComment": "/**\n * 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).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare namespace config " + } + ], + "releaseTag": "Public", + "name": "config", + "members": [ + { + "kind": "Interface", + "canonicalReference": "firebase-functions!config.Config:interface", + "docComment": "/**\n * The Functions configuration interface.\n *\n * Access via `functions.config()`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Config " + } + ], + "releaseTag": "Public", + "name": "Config", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "firebase-functions!config.Config:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!config.singleton:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "singleton: " + }, + { + "kind": "Reference", + "text": "config.Config", + "canonicalReference": "firebase-functions!config.Config:interface" + } + ], + "releaseTag": "Public", + "name": "singleton", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!database:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "database", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!database._instanceWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _instanceWithOptions(instance: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "InstanceBuilder", + "canonicalReference": "firebase-functions!InstanceBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "instance", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_instanceWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!database._refWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _refWithOptions(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "RefBuilder", + "canonicalReference": "firebase-functions!RefBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_refWithOptions" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!database.DataSnapshot:class", + "docComment": "/**\n * Interface representing a Firebase Realtime Database data snapshot.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class DataSnapshot " + } + ], + "releaseTag": "Public", + "name": "DataSnapshot", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!database.DataSnapshot:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `DataSnapshot` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(data: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", path?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", // path will be undefined for the database root\n app?: " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "app.App", + "canonicalReference": "firebase-admin!app.App:interface" + }, + { + "kind": "Content", + "text": ", instance?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "app", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + } + }, + { + "parameterName": "instance", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#child:member(1)", + "docComment": "/**\n * Gets a `DataSnapshot` for the location at the specified relative path.\n *\n * The relative path can either be a simple child name (for example, \"ada\") or a deeper slash-separated path (for example, \"ada/name/first\").\n *\n * @param path - A relative path from this location to the desired child location. @return The specified child location.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "child(childPath: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "childPath", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "child" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#exists:member(1)", + "docComment": "/**\n * Returns `true` if this `DataSnapshot` contains any data. It is slightly more efficient than using `snapshot.val() !== null`.\n *\n * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exists(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "exists" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#exportVal:member(1)", + "docComment": "/**\n * Exports the entire contents of the `DataSnapshot` as a JavaScript object.\n *\n * The `exportVal()` method is similar to `val()`, except priority information is included (if available), making it suitable for backing up your data.\n *\n * @return The contents of the `DataSnapshot` as a JavaScript value (Object, Array, string, number, boolean, or `null`).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exportVal(): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "exportVal" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#forEach:member(1)", + "docComment": "/**\n * Enumerates the `DataSnapshot`s of the children items.\n *\n * Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by `val()` is not guaranteed to match the ordering on the server nor the ordering of `child_added` events. That is where `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` will be iterated in their query order.\n *\n * If no explicit `orderBy*()` method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority).\n *\n * @param action - A function that will be called for each child `DataSnapshot`. The callback can return `true` to cancel further enumeration.\n *\n * @return `true` if enumeration was canceled due to your callback returning `true`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forEach(action: " + }, + { + "kind": "Content", + "text": "(a: " + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ") => boolean | void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "action", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "forEach" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#getPriority:member(1)", + "docComment": "/**\n * Gets the priority value of the data in this `DataSnapshot`.\n *\n * As an alternative to using priority, applications can order collections by ordinary properties. See [Sorting and filtering data](/docs/database/web/lists-of-data#sorting_and_filtering_data).\n *\n * @return The priority value of the data.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPriority(): " + }, + { + "kind": "Content", + "text": "string | number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPriority" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#hasChild:member(1)", + "docComment": "/**\n * Returns `true` if the specified child path has (non-`null`) data.\n *\n * @param path - A relative path to the location of a potential child. @return `true` if data exists at the specified child path; otherwise, `false`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasChild(childPath: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "childPath", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hasChild" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#hasChildren:member(1)", + "docComment": "/**\n * Returns whether or not the `DataSnapshot` has any non-`null` child properties.\n *\n * You can use `hasChildren()` to determine if a `DataSnapshot` has any children. If it does, you can enumerate them using `forEach()`. If it doesn't, then either this snapshot contains a primitive value (which can be retrieved with `val()`) or it is empty (in which case, `val()` will return `null`).\n *\n * @return `true` if this snapshot has any children; else `false`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasChildren(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "hasChildren" + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!database.DataSnapshot#instance:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "instance: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "instance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!database.DataSnapshot#key:member", + "docComment": "/**\n * The key (last part of the path) of the location of this `DataSnapshot`.\n *\n * The last token in a Database location is considered its key. For example, \"ada\" is the key for the `/users/ada/` node. Accessing the key on any `DataSnapshot` will return the key for the location that generated it. However, accessing the key on the root URL of a Database will return `null`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "get key(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "key", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#numChildren:member(1)", + "docComment": "/**\n * Returns the number of child properties of this `DataSnapshot`.\n *\n * @return Number of child properties of this `DataSnapshot`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "numChildren(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "numChildren" + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!database.DataSnapshot#ref:member", + "docComment": "/**\n * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference) to the Database location where the triggering write occurred. Has full read and write access.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "get ref(): " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "database.Reference", + "canonicalReference": "@firebase/database-types!Reference:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ref", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#toJSON:member(1)", + "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Reference", + "text": "Object", + "canonicalReference": "!Object:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.DataSnapshot#val:member(1)", + "docComment": "/**\n * Extracts a JavaScript value from a `DataSnapshot`.\n *\n * Depending on the data in a `DataSnapshot`, the `val()` method may return a scalar type (string, number, or boolean), an array, or an object. It may also return `null`, indicating that the `DataSnapshot` is empty (contains no data).\n *\n * @return The DataSnapshot's contents as a JavaScript value (Object, Array, string, number, boolean, or `null`).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "val(): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "val" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!database.extractInstanceAndPath:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function extractInstanceAndPath(resource: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", domain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "resource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "domain", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "extractInstanceAndPath" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!database.instance:function(1)", + "docComment": "/**\n * Registers a function that triggers on events from a specific Firebase Realtime Database instance.\n *\n * Use this method together with `ref` to specify the instance on which to watch for database events. For example: `firebase.database.instance('my-app-db-2').ref('/foo/bar')`\n *\n * Note that `functions.database.ref` used without `instance` watches the *default* instance for events.\n *\n * @param instance - The instance name of the database instance to watch for write events. @return Firebase Realtime Database instance builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function instance(instance: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "InstanceBuilder", + "canonicalReference": "firebase-functions!InstanceBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "instance", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "instance" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!database.InstanceBuilder:class", + "docComment": "/**\n * The Firebase Realtime Database instance builder interface.\n *\n * Access via [`database.instance()`](providers_database_.html#instance).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class InstanceBuilder " + } + ], + "releaseTag": "Public", + "name": "InstanceBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!database.InstanceBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `InstanceBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(instance: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "instance", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.InstanceBuilder#ref:member(1)", + "docComment": "/**\n * @return Firebase Realtime Database reference builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ref(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "RefBuilder", + "canonicalReference": "firebase-functions!RefBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ref" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!database.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.firebase.database\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!database.ref:function(1)", + "docComment": "/**\n * Registers a function that triggers on Firebase Realtime Database write events.\n *\n * This method behaves very similarly to the method of the same name in the client and Admin Firebase SDKs. Any change to the Database that affects the data at or below the provided `path` will fire an event in Cloud Functions.\n *\n * There are three important differences between listening to a Realtime Database event in Cloud Functions and using the Realtime Database in the client and Admin SDKs: 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 [`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\"`, respectively. 2. Cloud Functions do not fire an event for data that already existed before the Cloud Function was deployed. 3. Cloud Function events have access to more information, including a snapshot of the previous event data and information about the user who triggered the Cloud Function.\n *\n * @param path - The path within the Database to watch for write events. @return Firebase Realtime Database builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function ref(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "RefBuilder", + "canonicalReference": "firebase-functions!RefBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ref" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!database.RefBuilder:class", + "docComment": "/**\n * The Firebase Realtime Database reference builder interface.\n *\n * Access via [`functions.database.ref()`](functions.database#.ref).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class RefBuilder " + } + ], + "releaseTag": "Public", + "name": "RefBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!database.RefBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `RefBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(apps: " + }, + { + "kind": "Reference", + "text": "apps.Apps", + "canonicalReference": "firebase-functions!apps.Apps:class" + }, + { + "kind": "Content", + "text": ", triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "apps", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.RefBuilder#onCreate:member(1)", + "docComment": "/**\n * Event handler that fires every time new data is created in Firebase Realtime Database.\n *\n * @param handler - Event handler that runs every time new data is created in Firebase Realtime Database. @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onCreate(handler: " + }, + { + "kind": "Content", + "text": "(snapshot: " + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onCreate" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.RefBuilder#onDelete:member(1)", + "docComment": "/**\n * Event handler that fires every time data is deleted from Firebase Realtime Database.\n *\n * @param handler - Event handler that runs every time data is deleted from Firebase Realtime Database. @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDelete(handler: " + }, + { + "kind": "Content", + "text": "(snapshot: " + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onDelete" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.RefBuilder#onUpdate:member(1)", + "docComment": "/**\n * Event handler that fires every time data is updated in Firebase Realtime Database.\n *\n * @param handler - Event handler which is run every time a Firebase Realtime Database write occurs. @return A Cloud Function which you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onUpdate(handler: " + }, + { + "kind": "Content", + "text": "(change: " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">, context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 10 + } + } + ], + "name": "onUpdate" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!database.RefBuilder#onWrite:member(1)", + "docComment": "/**\n * Event handler that fires every time a Firebase Realtime Database write of any kind (creation, update, or delete) occurs.\n *\n * @param handler - Event handler that runs every time a Firebase Realtime Database write occurs. @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onWrite(handler: " + }, + { + "kind": "Content", + "text": "(change: " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">, context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DataSnapshot", + "canonicalReference": "firebase-functions!DataSnapshot:class" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 10 + } + } + ], + "name": "onWrite" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!database.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"firebaseio.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!DEFAULT_FAILURE_POLICY:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DEFAULT_FAILURE_POLICY: " + }, + { + "kind": "Reference", + "text": "FailurePolicy", + "canonicalReference": "firebase-functions!FailurePolicy:interface" + } + ], + "releaseTag": "Public", + "name": "DEFAULT_FAILURE_POLICY", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!DeploymentOptions:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface DeploymentOptions extends " + }, + { + "kind": "Reference", + "text": "RuntimeOptions", + "canonicalReference": "firebase-functions!RuntimeOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DeploymentOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!DeploymentOptions#regions:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "regions?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "regions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!DeploymentOptions#schedule:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schedule?: " + }, + { + "kind": "Reference", + "text": "Schedule", + "canonicalReference": "firebase-functions!Schedule:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "schedule", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!Event:interface", + "docComment": "/**\n * @hidden\n *\n * Wire format for an event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Event " + } + ], + "releaseTag": "Public", + "name": "Event", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Event#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context: " + }, + { + "kind": "Content", + "text": "{\n eventId: string;\n timestamp: string;\n eventType: string;\n resource: " + }, + { + "kind": "Reference", + "text": "Resource", + "canonicalReference": "firebase-functions!Resource:interface" + }, + { + "kind": "Content", + "text": ";\n domain?: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Event#data:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "data: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!EventContext:interface", + "docComment": "/**\n * The context in which an event occurred.\n *\n * An EventContext describes: - The time an event occurred. - A unique identifier of the event. - The resource on which the event occurred, if applicable. - Authorization of the request that triggered the event, if applicable and available.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface EventContext " + } + ], + "releaseTag": "Public", + "name": "EventContext", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#auth:member", + "docComment": "/**\n * Authentication information for the user that triggered the function. This object contains `uid` and `token` properties for authenticated users. For more detail including token keys, see the [security rules reference](/docs/firestore/reference/security/#properties).\n *\n * This field is only populated for Realtime Database triggers and Callable functions. For an unauthenticated user, this field is null. For Firebase admin users and event types that do not provide user information, this field does not exist.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "auth?: " + }, + { + "kind": "Content", + "text": "{\n token: object;\n uid: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "auth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#authType:member", + "docComment": "/**\n * The level of permissions for a user. Valid values are:\n *\n * * `ADMIN` Developer user or user authenticated via a service account. * `USER` Known user. * `UNAUTHENTICATED` Unauthenticated action * `null` For event types that do not provide user information (all except Realtime Database).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "authType?: " + }, + { + "kind": "Content", + "text": "'ADMIN' | 'USER' | 'UNAUTHENTICATED'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "authType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#eventId:member", + "docComment": "/**\n * The event’s unique identifier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "eventId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "eventId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#eventType:member", + "docComment": "/**\n * Type of event. Possible values are:\n *\n * * `google.analytics.event.log` * `google.firebase.auth.user.create` * `google.firebase.auth.user.delete` * `google.firebase.database.ref.write` * `google.firebase.database.ref.create` * `google.firebase.database.ref.update` * `google.firebase.database.ref.delete` * `google.firestore.document.write` * `google.firestore.document.create` * `google.firestore.document.update` * `google.firestore.document.delete` * `google.pubsub.topic.publish` * `google.firebase.remoteconfig.update` * `google.storage.object.finalize` * `google.storage.object.archive` * `google.storage.object.delete` * `google.storage.object.metadataUpdate` * `google.testing.testMatrix.complete`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "eventType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "eventType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#params:member", + "docComment": "/**\n * An object containing the values of the wildcards in the `path` parameter provided to the [`ref()`](providers_database_.html#ref) method for a Realtime Database trigger. Cannot be accessed while inside the handler namespace.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "params: " + }, + { + "kind": "Content", + "text": "{\n [option: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "params", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#resource:member", + "docComment": "/**\n * The resource that emitted the event. Valid values are:\n *\n * * Analytics — `projects//events/` * Realtime Database — `projects/_/instances//refs/` * Storage — `projects/_/buckets//objects/#` * Authentication — `projects/` * Pub/Sub — `projects//topics/`\n *\n * Because Realtime Database instances and Cloud Storage buckets are globally unique and not tied to the project, their resources start with `projects/_`. Underscore is not a valid project name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resource: " + }, + { + "kind": "Reference", + "text": "Resource", + "canonicalReference": "firebase-functions!Resource:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "resource", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!EventContext#timestamp:member", + "docComment": "/**\n * Timestamp for the event as an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timestamp: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timestamp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!FailurePolicy:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface FailurePolicy " + } + ], + "releaseTag": "Public", + "name": "FailurePolicy", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!FailurePolicy#retry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "retry: " + }, + { + "kind": "Content", + "text": "{}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "retry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firebaseConfig:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function firebaseConfig(): " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "AppOptions", + "canonicalReference": "firebase-admin!AppOptions:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "firebaseConfig" + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!firebaseConfigCache:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "firebaseConfigCache: " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "AppOptions", + "canonicalReference": "firebase-admin!AppOptions:interface" + }, + { + "kind": "Content", + "text": " | null" + } + ], + "releaseTag": "Public", + "name": "firebaseConfigCache", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!firestore:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "firestore", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore._databaseWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _databaseWithOptions(database: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DatabaseBuilder", + "canonicalReference": "firebase-functions!DatabaseBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "database", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_databaseWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore._documentWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _documentWithOptions(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentBuilder", + "canonicalReference": "firebase-functions!DocumentBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_documentWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore._namespaceWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _namespaceWithOptions(namespace: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NamespaceBuilder", + "canonicalReference": "firebase-functions!NamespaceBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "namespace", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_namespaceWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore.beforeSnapshotConstructor:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function beforeSnapshotConstructor(event: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "firebase-functions!Event:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentSnapshot", + "canonicalReference": "firebase-functions!DocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "beforeSnapshotConstructor" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore.database:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function database(database: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DatabaseBuilder", + "canonicalReference": "firebase-functions!DatabaseBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "database", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "database" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!firestore.DatabaseBuilder:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class DatabaseBuilder " + } + ], + "releaseTag": "Public", + "name": "DatabaseBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!firestore.DatabaseBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `DatabaseBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(database: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "database", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DatabaseBuilder#document:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "document(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentBuilder", + "canonicalReference": "firebase-functions!DocumentBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "document" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DatabaseBuilder#namespace:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "namespace(namespace: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NamespaceBuilder", + "canonicalReference": "firebase-functions!NamespaceBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "namespace", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "namespace" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!firestore.defaultDatabase:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultDatabase = \"(default)\"" + } + ], + "releaseTag": "Public", + "name": "defaultDatabase", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore.document:function(1)", + "docComment": "/**\n * Select the Firestore document to listen to for events.\n *\n * @param path - Full database path to listen to. This includes the name of the collection that the document is a part of. For example, if the collection is named \"users\" and the document is named \"Ada\", then the path is \"/users/Ada\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function document(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentBuilder", + "canonicalReference": "firebase-functions!DocumentBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "document" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class DocumentBuilder " + } + ], + "releaseTag": "Public", + "name": "DocumentBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `DocumentBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onCreate:member(1)", + "docComment": "/**\n * Respond only to document creations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onCreate(handler: " + }, + { + "kind": "Content", + "text": "(snapshot: " + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onCreate" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onDelete:member(1)", + "docComment": "/**\n * Respond only to document deletions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDelete(handler: " + }, + { + "kind": "Content", + "text": "(snapshot: " + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onDelete" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onUpdate:member(1)", + "docComment": "/**\n * Respond only to document updates.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onUpdate(handler: " + }, + { + "kind": "Content", + "text": "(change: " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">, context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "QueryDocumentSnapshot", + "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 10 + } + } + ], + "name": "onUpdate" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onWrite:member(1)", + "docComment": "/**\n * Respond to all document writes (creates, updates, or deletes).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onWrite(handler: " + }, + { + "kind": "Content", + "text": "(change: " + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DocumentSnapshot", + "canonicalReference": "firebase-functions!DocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">, context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Change", + "canonicalReference": "firebase-functions!Change:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DocumentSnapshot", + "canonicalReference": "firebase-functions!DocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 10 + } + } + ], + "name": "onWrite" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!firestore.DocumentSnapshot:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type DocumentSnapshot = " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "firestore.DocumentSnapshot", + "canonicalReference": "!FirebaseFirestore.DocumentSnapshot:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "DocumentSnapshot", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore.namespace:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function namespace(namespace: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NamespaceBuilder", + "canonicalReference": "firebase-functions!NamespaceBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "namespace", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "namespace" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!firestore.NamespaceBuilder:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class NamespaceBuilder " + } + ], + "releaseTag": "Public", + "name": "NamespaceBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!firestore.NamespaceBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `NamespaceBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(database: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ", namespace?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "database", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "namespace", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!firestore.NamespaceBuilder#document:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "document(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentBuilder", + "canonicalReference": "firebase-functions!DocumentBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "document" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!firestore.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.firestore\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!firestore.QueryDocumentSnapshot:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type QueryDocumentSnapshot = " + }, + { + "kind": "Content", + "text": "firebase." + }, + { + "kind": "Reference", + "text": "firestore.QueryDocumentSnapshot", + "canonicalReference": "!FirebaseFirestore.QueryDocumentSnapshot:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "QueryDocumentSnapshot", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!firestore.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"firestore.googleapis.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!firestore.snapshotConstructor:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function snapshotConstructor(event: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "firebase-functions!Event:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "DocumentSnapshot", + "canonicalReference": "firebase-functions!DocumentSnapshot:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "snapshotConstructor" + } + ] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!FunctionBuilder:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FunctionBuilder " + } + ], + "releaseTag": "Public", + "name": "FunctionBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!FunctionBuilder:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `FunctionBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#analytics:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get analytics(): " + }, + { + "kind": "Content", + "text": "{\n event: (analyticsEventType: string) => analytics." + }, + { + "kind": "Reference", + "text": "AnalyticsEventBuilder", + "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "analytics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#auth:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get auth(): " + }, + { + "kind": "Content", + "text": "{\n user: () => auth." + }, + { + "kind": "Reference", + "text": "UserBuilder", + "canonicalReference": "firebase-functions!UserBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "auth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#database:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get database(): " + }, + { + "kind": "Content", + "text": "{\n instance: (instance: string) => database." + }, + { + "kind": "Reference", + "text": "InstanceBuilder", + "canonicalReference": "firebase-functions!InstanceBuilder:class" + }, + { + "kind": "Content", + "text": ";\n ref: (path: string) => database." + }, + { + "kind": "Reference", + "text": "RefBuilder", + "canonicalReference": "firebase-functions!RefBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "database", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#firestore:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get firestore(): " + }, + { + "kind": "Content", + "text": "{\n document: (path: string) => firestore." + }, + { + "kind": "Reference", + "text": "DocumentBuilder", + "canonicalReference": "firebase-functions!DocumentBuilder:class" + }, + { + "kind": "Content", + "text": ";\n namespace: (namespace: string) => firestore." + }, + { + "kind": "Reference", + "text": "NamespaceBuilder", + "canonicalReference": "firebase-functions!NamespaceBuilder:class" + }, + { + "kind": "Content", + "text": ";\n database: (database: string) => firestore." + }, + { + "kind": "Reference", + "text": "DatabaseBuilder", + "canonicalReference": "firebase-functions!DatabaseBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "firestore", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#https:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get https(): " + }, + { + "kind": "Content", + "text": "{\n onRequest: (handler: (req: https." + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", resp: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ") => import(\"./cloud-functions\")." + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": ";\n onCall: (handler: (data: any, context: https." + }, + { + "kind": "Reference", + "text": "CallableContext", + "canonicalReference": "firebase-functions!CallableContext:interface" + }, + { + "kind": "Content", + "text": ") => any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ") => import(\"./cloud-functions\")." + }, + { + "kind": "Reference", + "text": "TriggerAnnotated", + "canonicalReference": "firebase-functions!TriggerAnnotated:interface" + }, + { + "kind": "Content", + "text": " & ((req: " + }, + { + "kind": "Reference", + "text": "express.Request", + "canonicalReference": "@types/express!~e.Request:interface" + }, + { + "kind": "Content", + "text": ", resp: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ") & import(\"./cloud-functions\")." + }, + { + "kind": "Reference", + "text": "Runnable", + "canonicalReference": "firebase-functions!Runnable:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "https", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 26 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#pubsub:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get pubsub(): " + }, + { + "kind": "Content", + "text": "{\n topic: (topic: string) => pubsub." + }, + { + "kind": "Reference", + "text": "TopicBuilder", + "canonicalReference": "firebase-functions!TopicBuilder:class" + }, + { + "kind": "Content", + "text": ";\n schedule: (schedule: string) => pubsub." + }, + { + "kind": "Reference", + "text": "ScheduleBuilder", + "canonicalReference": "firebase-functions!ScheduleBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "pubsub", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!FunctionBuilder#region:member(1)", + "docComment": "/**\n * Configure the regions that the function is deployed to.\n *\n * @param regions - One or more region strings.\n *\n * @example\n *\n * functions.region('us-east1')\n *\n * @example\n *\n * functions.region('us-east1', 'us-central1')\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "region(...regions: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "FunctionBuilder", + "canonicalReference": "firebase-functions!FunctionBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "regions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "name": "region" + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#remoteConfig:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get remoteConfig(): " + }, + { + "kind": "Content", + "text": "{\n onUpdate: (handler: (version: remoteConfig." + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any) => " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "remoteConfig", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 12 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!FunctionBuilder#runWith:member(1)", + "docComment": "/**\n * Configure runtime options for the function.\n *\n * @param runtimeOptions - Object with optional fields: 1. `memory`: amount of memory to allocate to the function, possible values are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'. 2. `timeoutSeconds`: timeout for the function in seconds, possible values are 0 to 540. 3. `failurePolicy`: failure policy of the function, with boolean `true` being equivalent to providing an empty retry object. 4. `vpcConnector`: id of a VPC connector in the same project and region 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which egress traffic is sent through the `vpcConnector`.\n *\n * Value must not be null.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "runWith(runtimeOptions: " + }, + { + "kind": "Reference", + "text": "RuntimeOptions", + "canonicalReference": "firebase-functions!RuntimeOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "FunctionBuilder", + "canonicalReference": "firebase-functions!FunctionBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "runtimeOptions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "runWith" + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#storage:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get storage(): " + }, + { + "kind": "Content", + "text": "{\n bucket: (bucket?: string) => storage." + }, + { + "kind": "Reference", + "text": "BucketBuilder", + "canonicalReference": "firebase-functions!BucketBuilder:class" + }, + { + "kind": "Content", + "text": ";\n object: () => storage." + }, + { + "kind": "Reference", + "text": "ObjectBuilder", + "canonicalReference": "firebase-functions!ObjectBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "storage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!FunctionBuilder#testLab:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get testLab(): " + }, + { + "kind": "Content", + "text": "{\n testMatrix: () => testLab." + }, + { + "kind": "Reference", + "text": "TestMatrixBuilder", + "canonicalReference": "firebase-functions!TestMatrixBuilder:class" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "testLab", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!handler:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handler: " + }, + { + "kind": "Reference", + "text": "HandlerBuilder", + "canonicalReference": "firebase-functions!HandlerBuilder:class" + } + ], + "releaseTag": "Public", + "name": "handler", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!https:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "https", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!https._onCallWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _onCallWithOptions(handler: " + }, + { + "kind": "Content", + "text": "(data: any, context: " + }, + { + "kind": "Reference", + "text": "CallableContext", + "canonicalReference": "firebase-functions!CallableContext:interface" + }, + { + "kind": "Content", + "text": ") => any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "Runnable", + "canonicalReference": "firebase-functions!Runnable:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "_onCallWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https._onRequestWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _onRequestWithOptions(handler: " + }, + { + "kind": "Content", + "text": "(req: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", resp: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "_onRequestWithOptions" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.CallableContext:interface", + "docComment": "/**\n * The interface for metadata for the API as passed to the handler.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CallableContext " + } + ], + "releaseTag": "Public", + "name": "CallableContext", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableContext#app:member", + "docComment": "/**\n * The result of decoding and verifying a Firebase AppCheck token.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "app?: " + }, + { + "kind": "Reference", + "text": "AppCheckData", + "canonicalReference": "firebase-functions!AppCheckData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "app", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableContext#auth:member", + "docComment": "/**\n * The result of decoding and verifying a Firebase Auth ID token.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "auth?: " + }, + { + "kind": "Reference", + "text": "AuthData", + "canonicalReference": "firebase-functions!AuthData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "auth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableContext#instanceIdToken:member", + "docComment": "/**\n * An unverified token for a Firebase Instance ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "instanceIdToken?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "instanceIdToken", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableContext#rawRequest:member", + "docComment": "/**\n * The raw request handled by the callable.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rawRequest: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "rawRequest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!https.FunctionsErrorCode:type", + "docComment": "/**\n * The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md\n *\n * Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FunctionsErrorCode = " + }, + { + "kind": "Content", + "text": "'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FunctionsErrorCode", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!https.HttpsError:class", + "docComment": "/**\n * An explicit error that can be thrown from a handler to send an error to the client that called the function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class HttpsError extends " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpsError", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!https.HttpsError:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `HttpsError` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(code: " + }, + { + "kind": "Reference", + "text": "FunctionsErrorCode", + "canonicalReference": "firebase-functions!FunctionsErrorCode:type" + }, + { + "kind": "Content", + "text": ", message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", details?: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "code", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "details", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#code:member", + "docComment": "/**\n * A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly code: " + }, + { + "kind": "Reference", + "text": "FunctionsErrorCode", + "canonicalReference": "firebase-functions!FunctionsErrorCode:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "code", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#details:member", + "docComment": "/**\n * Extra data to be converted to JSON and included in the error response.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly details: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "details", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#httpErrorCode:member", + "docComment": "/**\n * A wire format representation of a provided error code.\n *\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly httpErrorCode: " + }, + { + "kind": "Reference", + "text": "HttpErrorCode", + "canonicalReference": "firebase-functions!~HttpErrorCode:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "httpErrorCode", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!https.HttpsError#toJSON:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Reference", + "text": "HttpErrorWireFormat", + "canonicalReference": "firebase-functions!~HttpErrorWireFormat:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onCall:function(1)", + "docComment": "/**\n * Declares a callable method for clients to call using a Firebase SDK.\n *\n * @param handler - A method that takes a data and context and returns a value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onCall(handler: " + }, + { + "kind": "Content", + "text": "(data: any, context: " + }, + { + "kind": "Reference", + "text": "CallableContext", + "canonicalReference": "firebase-functions!CallableContext:interface" + }, + { + "kind": "Content", + "text": ") => any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "Runnable", + "canonicalReference": "firebase-functions!Runnable:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + } + ], + "name": "onCall" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onRequest:function(1)", + "docComment": "/**\n * Handle HTTP requests.\n *\n * @param handler - A function that takes a request and response object, same signature as an Express app.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onRequest(handler: " + }, + { + "kind": "Content", + "text": "(req: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", resp: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onRequest" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.Request:interface", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Request extends " + }, + { + "kind": "Reference", + "text": "express.Request", + "canonicalReference": "@types/express!~e.Request:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Request", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.Request#rawBody:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "rawBody: " + }, + { + "kind": "Reference", + "text": "Buffer", + "canonicalReference": "!Buffer:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "rawBody", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!HttpsFunction:type", + "docComment": "/**\n * The Cloud Function type for HTTPS triggers. This should be exported from your JavaScript file to define a Cloud Function.\n *\n * This type is a special JavaScript function which takes Express [`Request`](https://expressjs.com/en/api.html#req) and [`Response`](https://expressjs.com/en/api.html#res) objects as its only arguments.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type HttpsFunction = " + }, + { + "kind": "Reference", + "text": "TriggerAnnotated", + "canonicalReference": "firebase-functions!TriggerAnnotated:interface" + }, + { + "kind": "Content", + "text": " & ((req: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "@types/express!~e.Request:interface" + }, + { + "kind": "Content", + "text": ", resp: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ")" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "HttpsFunction", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 9 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!INGRESS_SETTINGS_OPTIONS:var", + "docComment": "/**\n * List of available options for IngressSettings.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "INGRESS_SETTINGS_OPTIONS: " + }, + { + "kind": "Content", + "text": "readonly [\"INGRESS_SETTINGS_UNSPECIFIED\", \"ALLOW_ALL\", \"ALLOW_INTERNAL_ONLY\", \"ALLOW_INTERNAL_AND_GCLB\"]" + } + ], + "releaseTag": "Public", + "name": "INGRESS_SETTINGS_OPTIONS", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!logger:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "logger", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.debug:function(1)", + "docComment": "/**\n * Writes a `DEBUG` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function debug(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "debug" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.error:function(1)", + "docComment": "/**\n * Writes an `ERROR` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function error(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "error" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.info:function(1)", + "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function info(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "info" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.log:function(1)", + "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function log(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "log" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!logger.LogEntry:interface", + "docComment": "/**\n * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging) entry. All keys aside from `severity` and `message` are included in the `jsonPayload` of the logged entry.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogEntry " + } + ], + "releaseTag": "Public", + "name": "LogEntry", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "firebase-functions!logger.LogEntry:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!logger.LogEntry#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "message?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!logger.LogEntry#severity:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "severity: " + }, + { + "kind": "Reference", + "text": "LogSeverity", + "canonicalReference": "firebase-functions!LogSeverity:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "severity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!logger.LogSeverity:type", + "docComment": "/**\n * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type LogSeverity = " + }, + { + "kind": "Content", + "text": "'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LogSeverity", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.warn:function(1)", + "docComment": "/**\n * Writes a `WARNING` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function warn(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "warn" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.write:function(1)", + "docComment": "/**\n * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).\n *\n * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function write(entry: " + }, + { + "kind": "Reference", + "text": "LogEntry", + "canonicalReference": "firebase-functions!LogEntry:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "entry", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "write" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!makeCloudFunction:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function makeCloudFunction({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: " + }, + { + "kind": "Reference", + "text": "MakeCloudFunctionArgs", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "{ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "EventData", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "makeCloudFunction" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs:interface", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface MakeCloudFunctionArgs " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "EventData", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "MakeCloudFunctionArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#after:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "after?: " + }, + { + "kind": "Content", + "text": "(raw: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "firebase-functions!Event:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "after", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#before:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "before?: " + }, + { + "kind": "Content", + "text": "(raw: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "firebase-functions!Event:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "before", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#contextOnlyHandler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "contextOnlyHandler?: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "contextOnlyHandler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#dataConstructor:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataConstructor?: " + }, + { + "kind": "Content", + "text": "(raw: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "firebase-functions!Event:interface" + }, + { + "kind": "Content", + "text": ") => EventData" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "dataConstructor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#eventType:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "eventType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "eventType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#handler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handler?: " + }, + { + "kind": "Content", + "text": "(data: EventData, context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "handler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#labels:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "labels?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "labels", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#legacyEventType:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "legacyEventType?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "legacyEventType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#options:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "options?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "options", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#provider:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "provider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#service:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "service: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#triggerResource:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "triggerResource", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!MAX_NUMBER_USER_LABELS:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "MAX_NUMBER_USER_LABELS = 58" + } + ], + "releaseTag": "Public", + "name": "MAX_NUMBER_USER_LABELS", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!MAX_TIMEOUT_SECONDS:var", + "docComment": "/**\n * Cloud Functions max timeout value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MAX_TIMEOUT_SECONDS = 540" + } + ], + "releaseTag": "Public", + "name": "MAX_TIMEOUT_SECONDS", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!MIN_TIMEOUT_SECONDS:var", + "docComment": "/**\n * Cloud Functions min timeout value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MIN_TIMEOUT_SECONDS = 0" + } + ], + "releaseTag": "Public", + "name": "MIN_TIMEOUT_SECONDS", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!optionsToTrigger:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function optionsToTrigger(options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "optionsToTrigger" + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!pubsub:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "pubsub", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub._scheduleWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _scheduleWithOptions(schedule: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ScheduleBuilder", + "canonicalReference": "firebase-functions!ScheduleBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "schedule", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_scheduleWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub._topicWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _topicWithOptions(topic: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "TopicBuilder", + "canonicalReference": "firebase-functions!TopicBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "topic", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_topicWithOptions" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!pubsub.Message:class", + "docComment": "/**\n * Interface representing a Google Cloud Pub/Sub message.\n *\n * @param data - Payload of a Pub/Sub message.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Message " + } + ], + "releaseTag": "Public", + "name": "Message", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!pubsub.Message:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(data: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#attributes:member", + "docComment": "/**\n * User-defined attributes published with the message, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly attributes: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "attributes", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#data:member", + "docComment": "/**\n * The data payload of this message object as a base64-encoded string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly data: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#json:member", + "docComment": "/**\n * The JSON data payload of this message object, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "get json(): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "json", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.Message#toJSON:member(1)", + "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!pubsub.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.pubsub\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub.schedule:function(1)", + "docComment": "/**\n * Registers a Cloud Function to run at specified times.\n *\n * @param schedule - The schedule, in Unix Crontab or AppEngine syntax. @return ScheduleBuilder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function schedule(schedule: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ScheduleBuilder", + "canonicalReference": "firebase-functions!ScheduleBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "schedule", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "schedule" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder:class", + "docComment": "/**\n * The builder for scheduled functions, which are powered by Google Pub/Sub and Cloud Scheduler. Describes the Cloud Scheduler job that is deployed to trigger a scheduled function at the provided frequency. For more information, see [Schedule functions](/docs/functions/schedule-functions).\n *\n * Access via [`functions.pubsub.schedule()`](providers_pubsub_.html#schedule).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ScheduleBuilder " + } + ], + "releaseTag": "Public", + "name": "ScheduleBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `ScheduleBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#onRun:member(1)", + "docComment": "/**\n * Event handler for scheduled functions. Triggered whenever the associated scheduler job sends a Pub/Sub message.\n *\n * @param handler - Handler that fires whenever the associated scheduler job sends a Pub/Sub message. @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRun(handler: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + } + ], + "name": "onRun" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#retryConfig:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "retryConfig(config: " + }, + { + "kind": "Reference", + "text": "ScheduleRetryConfig", + "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ScheduleBuilder", + "canonicalReference": "firebase-functions!ScheduleBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "retryConfig" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#timeZone:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeZone(timeZone: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ScheduleBuilder", + "canonicalReference": "firebase-functions!ScheduleBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "timeZone", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "timeZone" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!pubsub.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"pubsub.googleapis.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub.topic:function(1)", + "docComment": "/**\n * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message is sent to a specified topic.\n *\n * @param topic - The Pub/Sub topic to watch for message events. @return Pub/Sub topic builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function topic(topic: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "TopicBuilder", + "canonicalReference": "firebase-functions!TopicBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "topic", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "topic" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!pubsub.TopicBuilder:class", + "docComment": "/**\n * The Google Cloud Pub/Sub topic builder.\n *\n * Access via [`functions.pubsub.topic()`](providers_pubsub_.html#topic).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class TopicBuilder " + } + ], + "releaseTag": "Public", + "name": "TopicBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!pubsub.TopicBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `TopicBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.TopicBuilder#onPublish:member(1)", + "docComment": "/**\n * Event handler that fires every time a Cloud Pub/Sub message is published.\n *\n * @param handler - Event handler that runs every time a Cloud Pub/Sub message is published. @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onPublish(handler: " + }, + { + "kind": "Content", + "text": "(message: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "firebase-functions!Message:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "firebase-functions!Message:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onPublish" + } + ], + "implementsTokenRanges": [] + } + ] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!region:function(1)", + "docComment": "/**\n * Configure the regions that the function is deployed to.\n *\n * @param regions - One of more region strings.\n *\n * @example\n *\n * functions.region('us-east1')\n *\n * @example\n *\n * functions.region('us-east1', 'us-central1')\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function region(...regions: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "FunctionBuilder", + "canonicalReference": "firebase-functions!FunctionBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "regions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "name": "region" + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!remoteConfig:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "remoteConfig", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!remoteConfig._onUpdateWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _onUpdateWithOptions(handler: " + }, + { + "kind": "Content", + "text": "(version: " + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "_onUpdateWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!remoteConfig.onUpdate:function(1)", + "docComment": "/**\n * Registers a function that triggers on Firebase Remote Config template update events.\n *\n * @param handler - A function that takes the updated Remote Config template version metadata as an argument.\n *\n * @return A Cloud Function that you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onUpdate(handler: " + }, + { + "kind": "Content", + "text": "(version: " + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onUpdate" + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!remoteConfig.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.firebase.remoteconfig\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser:interface", + "docComment": "/**\n * An interface representing metadata for a Remote Config account that performed the update. Contains the same fields as [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RemoteConfigUser " + } + ], + "releaseTag": "Public", + "name": "RemoteConfigUser", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#email:member", + "docComment": "/**\n * Email address of the Remote Config account that performed the update.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "email: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "email", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#imageUrl:member", + "docComment": "/**\n * Image URL of the Remote Config account that performed the update.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "imageUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "imageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#name:member", + "docComment": "/**\n * Name of the Remote Config account that performed the update.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!remoteConfig.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"firebaseremoteconfig.googleapis.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion:interface", + "docComment": "/**\n * An interface representing a Remote Config template version metadata object emitted when a project is updated.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface TemplateVersion " + } + ], + "releaseTag": "Public", + "name": "TemplateVersion", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#description:member", + "docComment": "/**\n * A description associated with this Remote Config template version.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#rollbackSource:member", + "docComment": "/**\n * The version number of the Remote Config template that this update rolled back to. Only applies if this update was a rollback.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rollbackSource?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "rollbackSource", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateOrigin:member", + "docComment": "/**\n * The origin of the caller - either the Firebase console or the Remote Config REST API. See [`RemoteConfigUpdateOrigin`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdateorigin) for valid values.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateOrigin: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "updateOrigin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateTime:member", + "docComment": "/**\n * When the template was updated in format (ISO8601 timestamp).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "updateTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateType:member", + "docComment": "/**\n * The type of update action that was performed, whether forced, incremental, or a rollback operation. See [`RemoteConfigUpdateType`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdatetype) for valid values.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "updateType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateUser:member", + "docComment": "/**\n * Metadata about the account that performed the update, of type [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateUser: " + }, + { + "kind": "Reference", + "text": "RemoteConfigUser", + "canonicalReference": "firebase-functions!RemoteConfigUser:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "updateUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#versionNumber:member", + "docComment": "/**\n * The version number of the updated Remote Config template.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "versionNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "versionNumber", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder:class", + "docComment": "/**\n * Builder used to create Cloud Functions for Remote Config.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class UpdateBuilder " + } + ], + "releaseTag": "Public", + "name": "UpdateBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `UpdateBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder#onUpdate:member(1)", + "docComment": "/**\n * Handle all updates (including rollbacks) that affect a Remote Config project.\n *\n * @param handler - A function that takes the updated Remote Config template version metadata as an argument.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onUpdate(handler: " + }, + { + "kind": "Content", + "text": "(version: " + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TemplateVersion", + "canonicalReference": "firebase-functions!TemplateVersion:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onUpdate" + } + ], + "implementsTokenRanges": [] + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!Resource:interface", + "docComment": "/**\n * Resource is a standard format for defining a resource (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the resource that triggered the function - such as a storage bucket.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Resource " + } + ], + "releaseTag": "Public", + "name": "Resource", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Resource#labels:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "labels?: " + }, + { + "kind": "Content", + "text": "{\n [tag: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "labels", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Resource#name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Resource#service:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "service: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Resource#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!Runnable:interface", + "docComment": "/**\n * A Runnable has a `run` method which directly invokes the user-defined function - useful for unit testing.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Runnable " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "Runnable", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Runnable#run:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "run: " + }, + { + "kind": "Content", + "text": "(data: T, context: any) => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "run", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!RuntimeOptions:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RuntimeOptions " + } + ], + "releaseTag": "Public", + "name": "RuntimeOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#failurePolicy:member", + "docComment": "/**\n * Failure policy of the function, with boolean `true` being equivalent to providing an empty retry object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "failurePolicy?: " + }, + { + "kind": "Reference", + "text": "FailurePolicy", + "canonicalReference": "firebase-functions!FailurePolicy:interface" + }, + { + "kind": "Content", + "text": " | boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "failurePolicy", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#ingressSettings:member", + "docComment": "/**\n * Ingress settings which control where this function can be called from.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ingressSettings?: " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "INGRESS_SETTINGS_OPTIONS", + "canonicalReference": "firebase-functions!INGRESS_SETTINGS_OPTIONS:var" + }, + { + "kind": "Content", + "text": "[number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "ingressSettings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#invoker:member", + "docComment": "/**\n * Invoker to set access control on https functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "invoker?: " + }, + { + "kind": "Content", + "text": "'public' | 'private' | string | string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "invoker", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#labels:member", + "docComment": "/**\n * User labels to set on the function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "labels?: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "labels", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#maxInstances:member", + "docComment": "/**\n * Max number of actual instances allowed to be running in parallel.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxInstances?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "maxInstances", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#memory:member", + "docComment": "/**\n * Amount of memory to allocate to the function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "memory?: " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "VALID_MEMORY_OPTIONS", + "canonicalReference": "firebase-functions!VALID_MEMORY_OPTIONS:var" + }, + { + "kind": "Content", + "text": "[number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "memory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#minInstances:member", + "docComment": "/**\n * Min number of actual instances to be running at a given time. Instances will be billed for memory allocation and 10% of CPU allocation while idle.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "minInstances?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "minInstances", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#platform:member", + "docComment": "/**\n * Which platform should host the backend. Valid options are \"gcfv1\" @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "platform?: " + }, + { + "kind": "Content", + "text": "'gcfv1'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "platform", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#serviceAccount:member", + "docComment": "/**\n * Specific service account for the function to run as.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "serviceAccount?: " + }, + { + "kind": "Content", + "text": "'default' | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "serviceAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#timeoutSeconds:member", + "docComment": "/**\n * Timeout for the function in seconds, possible values are 0 to 540.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeoutSeconds?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "timeoutSeconds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#vpcConnector:member", + "docComment": "/**\n * Connect cloud function to specified VPC connector.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vpcConnector?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "vpcConnector", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!RuntimeOptions#vpcConnectorEgressSettings:member", + "docComment": "/**\n * Egress settings for VPC connector.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vpcConnectorEgressSettings?: " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "VPC_EGRESS_SETTINGS_OPTIONS", + "canonicalReference": "firebase-functions!VPC_EGRESS_SETTINGS_OPTIONS:var" + }, + { + "kind": "Content", + "text": "[number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "vpcConnectorEgressSettings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!runWith:function(1)", + "docComment": "/**\n * Configure runtime options for the function.\n *\n * @param runtimeOptions - Object with optional fields: 1. `memory`: amount of memory to allocate to the function, possible values are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'. 2. `timeoutSeconds`: timeout for the function in seconds, possible values are 0 to 540. 3. `failurePolicy`: failure policy of the function, with boolean `true` being equivalent to providing an empty retry object. 4. `vpcConnector`: id of a VPC connector in same project and region. 5. `vpcConnectorEgressSettings`: when a vpcConnector is set, control which egress traffic is sent through the vpcConnector. 6. `serviceAccount`: Specific service account for the function. 7. `ingressSettings`: ingress settings for the function, which control where a HTTPS function can be called from.\n *\n * Value must not be null.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function runWith(runtimeOptions: " + }, + { + "kind": "Reference", + "text": "RuntimeOptions", + "canonicalReference": "firebase-functions!RuntimeOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "FunctionBuilder", + "canonicalReference": "firebase-functions!FunctionBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "runtimeOptions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "runWith" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!Schedule:interface", + "docComment": "/**\n * Configuration options for scheduled functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Schedule " + } + ], + "releaseTag": "Public", + "name": "Schedule", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Schedule#retryConfig:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "retryConfig?: " + }, + { + "kind": "Reference", + "text": "ScheduleRetryConfig", + "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "retryConfig", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Schedule#schedule:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schedule: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "schedule", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!Schedule#timeZone:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeZone?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "timeZone", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface", + "docComment": "/**\n * Scheduler retry options. Applies only to scheduled functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ScheduleRetryConfig " + } + ], + "releaseTag": "Public", + "name": "ScheduleRetryConfig", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxBackoffDuration:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxBackoffDuration?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "maxBackoffDuration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxDoublings:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxDoublings?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "maxDoublings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxRetryDuration:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxRetryDuration?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "maxRetryDuration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ScheduleRetryConfig#minBackoffDuration:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "minBackoffDuration?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "minBackoffDuration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!ScheduleRetryConfig#retryCount:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "retryCount?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "retryCount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!storage:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "storage", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!storage._bucketWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _bucketWithOptions(options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ", bucket?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "BucketBuilder", + "canonicalReference": "firebase-functions!BucketBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "bucket", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "_bucketWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!storage._objectWithOptions:function(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function _objectWithOptions(options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ObjectBuilder", + "canonicalReference": "firebase-functions!ObjectBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "_objectWithOptions" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!storage.bucket:function(1)", + "docComment": "/**\n * Registers a Cloud Function scoped to a specific storage bucket.\n *\n * @param bucket - Name of the bucket to which this Cloud Function is scoped.\n *\n * @return Storage bucket builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function bucket(bucket?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "BucketBuilder", + "canonicalReference": "firebase-functions!BucketBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "bucket", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "bucket" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!storage.BucketBuilder:class", + "docComment": "/**\n * The Google Cloud Storage bucket builder interface.\n *\n * Access via [`functions.storage.bucket()`](providers_storage_.html#bucket).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class BucketBuilder " + } + ], + "releaseTag": "Public", + "name": "BucketBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!storage.BucketBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `BucketBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.BucketBuilder#object:member(1)", + "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage change occurs.\n *\n * @return Storage object builder interface scoped to the specified storage bucket.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "object(): " + }, + { + "kind": "Reference", + "text": "ObjectBuilder", + "canonicalReference": "firebase-functions!ObjectBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "object" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!storage.object:function(1)", + "docComment": "/**\n * Registers a Cloud Function scoped to the default storage bucket for the project.\n *\n * @return Storage object builder interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function object(): " + }, + { + "kind": "Reference", + "text": "ObjectBuilder", + "canonicalReference": "firebase-functions!ObjectBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "object" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!storage.ObjectBuilder:class", + "docComment": "/**\n * The Google Cloud Storage object builder interface.\n *\n * Access via [`functions.storage.object()`](providers_storage_.html#object).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ObjectBuilder " + } + ], + "releaseTag": "Public", + "name": "ObjectBuilder", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!storage.ObjectBuilder:constructor(1)", + "docComment": "/**\n * @hidden Constructs a new instance of the `ObjectBuilder` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(triggerResource: " + }, + { + "kind": "Content", + "text": "() => string" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "DeploymentOptions", + "canonicalReference": "firebase-functions!DeploymentOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "triggerResource", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.ObjectBuilder#onArchive:member(1)", + "docComment": "/**\n * Event handler sent only when a bucket has enabled object versioning. This event indicates that the live version of an object has become an archived version, either because it was archived or because it was overwritten by the upload of an object of the same name.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onArchive(handler: " + }, + { + "kind": "Content", + "text": "(object: " + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onArchive" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.ObjectBuilder#onChange:member(1)", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onChange(handler: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onChange" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.ObjectBuilder#onDelete:member(1)", + "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage deletion occurs.\n *\n * Sent when an object has been permanently deleted. This includes objects that are overwritten or are deleted as part of the bucket's lifecycle configuration. For buckets with object versioning enabled, this is not sent when an object is archived, even if archival occurs via the `storage.objects.delete` method.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage deletion occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDelete(handler: " + }, + { + "kind": "Content", + "text": "(object: " + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onDelete" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.ObjectBuilder#onFinalize:member(1)", + "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage object creation occurs.\n *\n * Sent when a new object (or a new generation of an existing object) is successfully created in the bucket. This includes copying or rewriting an existing object. A failed upload does not trigger this event.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onFinalize(handler: " + }, + { + "kind": "Content", + "text": "(object: " + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onFinalize" + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!storage.ObjectBuilder#onMetadataUpdate:member(1)", + "docComment": "/**\n * Event handler which fires every time the metadata of an existing object changes.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage metadata update occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onMetadataUpdate(handler: " + }, + { + "kind": "Content", + "text": "(object: " + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ObjectMetadata", + "canonicalReference": "firebase-functions!ObjectMetadata:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onMetadataUpdate" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!storage.ObjectMetadata:interface", + "docComment": "/**\n * Interface representing a Google Google Cloud Storage object metadata object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ObjectMetadata " + } + ], + "releaseTag": "Public", + "name": "ObjectMetadata", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#acl:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "acl?: " + }, + { + "kind": "Content", + "text": "[\n {\n kind?: string;\n id?: string;\n selfLink?: string;\n bucket?: string;\n object?: string;\n generation?: string;\n entity?: string;\n role?: string;\n email?: string;\n entityId?: string;\n domain?: string;\n projectTeam?: {\n projectNumber?: string;\n team?: string;\n };\n etag?: string;\n }\n ]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "acl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#bucket:member", + "docComment": "/**\n * Storage bucket that contains the object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bucket: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bucket", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#cacheControl:member", + "docComment": "/**\n * The value of the `Cache-Control` header, used to determine whether Internet caches are allowed to cache public data for an object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cacheControl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "cacheControl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#componentCount:member", + "docComment": "/**\n * Specifies the number of originally uploaded objects from which a composite object was created.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentCount?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "componentCount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentDisposition:member", + "docComment": "/**\n * The value of the `Content-Disposition` header, used to specify presentation information about the data being transmitted.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "contentDisposition?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "contentDisposition", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentEncoding:member", + "docComment": "/**\n * Content-Encoding to indicate that an object is compressed (for example, with gzip compression) while maintaining its Content-Type.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "contentEncoding?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "contentEncoding", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentLanguage:member", + "docComment": "/**\n * ISO 639-1 language code of the content.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "contentLanguage?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "contentLanguage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentType:member", + "docComment": "/**\n * The object's content type, also known as the MIME type.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "contentType?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "contentType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#crc32c:member", + "docComment": "/**\n * The object's CRC32C hash. All Google Cloud Storage objects have a CRC32C hash or MD5 hash.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crc32c?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "crc32c", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#customerEncryption:member", + "docComment": "/**\n * Customer-supplied encryption key.\n *\n * This object contains the following properties: * `encryptionAlgorithm` (`string|undefined`): The encryption algorithm that was used. Always contains the value `AES256`. * `keySha256` (`string|undefined`): An RFC 4648 base64-encoded string of the SHA256 hash of your encryption key. You can use this SHA256 hash to uniquely identify the AES-256 encryption key required to decrypt the object, which you must store securely.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "customerEncryption?: " + }, + { + "kind": "Content", + "text": "{\n encryptionAlgorithm?: string;\n keySha256?: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "customerEncryption", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#etag:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "etag?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "etag", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#generation:member", + "docComment": "/**\n * Generation version number that changes each time the object is overwritten.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "generation?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "generation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#id:member", + "docComment": "/**\n * The ID of the object, including the bucket name, object name, and generation number.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#kind:member", + "docComment": "/**\n * The kind of the object, which is always `storage#object`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kind: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "kind", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#md5Hash:member", + "docComment": "/**\n * MD5 hash for the object. All Google Cloud Storage objects have a CRC32C hash or MD5 hash.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "md5Hash?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "md5Hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#mediaLink:member", + "docComment": "/**\n * Media download link.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mediaLink?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "mediaLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#metadata:member", + "docComment": "/**\n * User-provided metadata.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#metageneration:member", + "docComment": "/**\n * Meta-generation version number that changes each time the object's metadata is updated.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metageneration?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "metageneration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#name:member", + "docComment": "/**\n * The object's name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#owner:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "owner?: " + }, + { + "kind": "Content", + "text": "{\n entity?: string;\n entityId?: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "owner", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#selfLink:member", + "docComment": "/**\n * Link to access the object, assuming you have sufficient permissions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "selfLink?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "selfLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#size:member", + "docComment": "/**\n * The value of the `Content-Length` header, used to determine the length of the object data in bytes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "size: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "size", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#storageClass:member", + "docComment": "/**\n * Storage class of the object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "storageClass: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "storageClass", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeCreated:member", + "docComment": "/**\n * The creation time of the object in RFC 3339 format.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeCreated: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeCreated", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeDeleted:member", + "docComment": "/**\n * The deletion time of the object in RFC 3339 format. Returned only if this version of the object has been deleted.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeDeleted?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "timeDeleted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeStorageClassUpdated:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeStorageClassUpdated?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "timeStorageClassUpdated", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!storage.ObjectMetadata#updated:member", + "docComment": "/**\n * The modification time of the object metadata in RFC 3339 format.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "updated: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "updated", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!storage.provider:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider = \"google.storage\"" + } + ], + "releaseTag": "Public", + "name": "provider", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!storage.service:var", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service = \"storage.googleapis.com\"" + } + ], + "releaseTag": "Public", + "name": "service", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!SUPPORTED_REGIONS:var", + "docComment": "/**\n * List of all regions supported by Cloud Functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SUPPORTED_REGIONS: " + }, + { + "kind": "Content", + "text": "readonly [\"us-central1\", \"us-east1\", \"us-east4\", \"us-west2\", \"us-west3\", \"us-west4\", \"europe-central2\", \"europe-west1\", \"europe-west2\", \"europe-west3\", \"europe-west6\", \"asia-east1\", \"asia-east2\", \"asia-northeast1\", \"asia-northeast2\", \"asia-northeast3\", \"asia-south1\", \"asia-southeast1\", \"asia-southeast2\", \"northamerica-northeast1\", \"southamerica-east1\", \"australia-southeast1\"]" + } + ], + "releaseTag": "Public", + "name": "SUPPORTED_REGIONS", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!testLab:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "testLab", + "members": [ + { + "kind": "Class", + "canonicalReference": "firebase-functions!testLab.ClientInfo:class", + "docComment": "/**\n * Information about the client which invoked the test.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ClientInfo " + } + ], + "releaseTag": "Public", + "name": "ClientInfo", + "members": [ + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ClientInfo#details:member", + "docComment": "/**\n * Map of detailed information about the client which invoked the test.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "details: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "details", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ClientInfo#name:member", + "docComment": "/**\n * Client name, e.g. 'gcloud'.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!testLab.InvalidMatrixDetails:type", + "docComment": "/**\n * The detailed reason that a Matrix was deemed INVALID.\n *\n * Possible values: - 'DETAILS_UNAVAILABLE': The matrix is INVALID, but there are no further details available. - 'MALFORMED_APK': The input app APK could not be parsed. - 'MALFORMED_TEST_APK': The input test APK could not be parsed. - 'NO_MANIFEST': The AndroidManifest.xml could not be found. - 'NO_PACKAGE_NAME': The APK manifest does not declare a package name. - 'INVALID_PACKAGE_NAME': The APK application ID is invalid. - 'TEST_SAME_AS_APP': The test package and app package are the same. - 'NO_INSTRUMENTATION': The test apk does not declare an instrumentation. - 'NO_SIGNATURE': The input app apk does not have a signature. - 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE': The test runner class specified by user or in the test APK's manifest file is not compatible with Android Test Orchestrator. - 'NO_TEST_RUNNER_CLASS': The test APK does not contain the test runner class specified by user or in the manifest file. - 'NO_LAUNCHER_ACTIVITY': A main launcher activity could not be found. - 'FORBIDDEN_PERMISSIONS': The app declares one or more permissions that are not allowed. - 'INVALID_ROBO_DIRECTIVES': There is a conflict in the provided robo_directives. - 'INVALID_RESOURCE_NAME': There is at least one invalid resource name in the provided robo directives. - 'INVALID_DIRECTIVE_ACTION': Invalid definition of action in the robo directives, e.g. a click or ignore action includes an input text field. - 'TEST_LOOP_INTENT_FILTER_NOT_FOUND': There is no test loop intent filter, or the one that is given is not formatted correctly. - 'SCENARIO_LABEL_NOT_DECLARED': The request contains a scenario label that was not declared in the manifest. - 'SCENARIO_LABEL_MALFORMED': There was an error when parsing a label value. - 'SCENARIO_NOT_DECLARED': The request contains a scenario number that was not declared in the manifest. - 'DEVICE_ADMIN_RECEIVER': Device administrator applications are not allowed. - 'MALFORMED_XC_TEST_ZIP': The zipped XCTest was malformed. The zip did not ] contain a single .xctestrun file and the contents of the DerivedData/Build/Products directory. - 'BUILT_FOR_IOS_SIMULATOR': The zipped XCTest was built for the iOS simulator rather than for a physical device. - 'NO_TESTS_IN_XC_TEST_ZIP': The .xctestrun file did not specify any test targets. - 'USE_DESTINATION_ARTIFACTS': One or more of the test targets defined in the .xctestrun file specifies \"UseDestinationArtifacts\", which is disallowed. - 'TEST_NON_APP_HOSTED': XC tests which run on physical devices must have \"IsAppHostedTestBundle\" == \"true\" in the xctestrun file. - 'PLIST_CANNOT_BE_PARSED': An Info.plist file in the XCTest zip could not be parsed. - 'NO_CODE_APK': APK contains no code. - 'INVALID_INPUT_APK': Either the provided input APK path was malformed, the APK file does not exist, or the user does not have permission to access the APK file. - 'INVALID_APK_PREVIEW_SDK': APK is built for a preview SDK which is unsupported.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type InvalidMatrixDetails = " + }, + { + "kind": "Content", + "text": "'DETAILS_UNAVAILABLE' | 'MALFORMED_APK' | 'MALFORMED_TEST_APK' | 'NO_MANIFEST' | 'NO_PACKAGE_NAME' | 'INVALID_PACKAGE_NAME' | 'TEST_SAME_AS_APP' | 'NO_INSTRUMENTATION' | 'NO_SIGNATURE' | 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE' | 'NO_TEST_RUNNER_CLASS' | 'NO_LAUNCHER_ACTIVITY' | 'FORBIDDEN_PERMISSIONS' | 'INVALID_ROBO_DIRECTIVES' | 'INVALID_RESOURCE_NAME' | 'INVALID_DIRECTIVE_ACTION' | 'TEST_LOOP_INTENT_FILTER_NOT_FOUND' | 'SCENARIO_LABEL_NOT_DECLARED' | 'SCENARIO_LABEL_MALFORMED' | 'SCENARIO_NOT_DECLARED' | 'DEVICE_ADMIN_RECEIVER' | 'MALFORMED_XC_TEST_ZIP' | 'BUILT_FOR_IOS_SIMULATOR' | 'NO_TESTS_IN_XC_TEST_ZIP' | 'USE_DESTINATION_ARTIFACTS' | 'TEST_NOT_APP_HOSTED' | 'PLIST_CANNOT_BE_PARSED' | 'NO_CODE_APK' | 'INVALID_INPUT_APK' | 'INVALID_APK_PREVIEW_SDK'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "InvalidMatrixDetails", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!testLab.OutcomeSummary:type", + "docComment": "/**\n * Outcome summary for a finished TestMatrix.\n *\n * Possible values: - 'SUCCESS': The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test. - 'FAILURE': The test run failed, for instance: - One or more test cases failed. - A test timed out. - The application under test crashed. - 'INCONCLUSIVE': Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful. - 'SKIPPED': All tests were skipped, for instance: - All device configurations were incompatible.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type OutcomeSummary = " + }, + { + "kind": "Content", + "text": "'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "OutcomeSummary", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!testLab.ResultStorage:class", + "docComment": "/**\n * Locations where the test results are stored.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ResultStorage " + } + ], + "releaseTag": "Public", + "name": "ResultStorage", + "members": [ + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ResultStorage#gcsPath:member", + "docComment": "/**\n * A storage location within Google Cloud Storage (GCS) for the test artifacts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gcsPath?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "gcsPath", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ResultStorage#resultsUrl:member", + "docComment": "/**\n * URL to test results in Firebase Console.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resultsUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "resultsUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ResultStorage#toolResultsExecutionId:member", + "docComment": "/**\n * Id of the ToolResults execution that the detailed TestMatrix results are written to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toolResultsExecutionId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "toolResultsExecutionId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.ResultStorage#toolResultsHistoryId:member", + "docComment": "/**\n * Id of the ToolResults History containing these results.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toolResultsHistoryId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "toolResultsHistoryId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!testLab.TestMatrix:class", + "docComment": "/**\n * TestMatrix captures details about a test run.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class TestMatrix " + } + ], + "releaseTag": "Public", + "name": "TestMatrix", + "members": [ + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#clientInfo:member", + "docComment": "/**\n * Information about the client which invoked the test.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clientInfo: " + }, + { + "kind": "Reference", + "text": "ClientInfo", + "canonicalReference": "firebase-functions!ClientInfo:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "clientInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#createTime:member", + "docComment": "/**\n * When this test matrix was initially created (ISO8601 timestamp).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "createTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#invalidMatrixDetails:member", + "docComment": "/**\n * For 'INVALID' matrices only, describes why the matrix is invalid.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "invalidMatrixDetails?: " + }, + { + "kind": "Reference", + "text": "InvalidMatrixDetails", + "canonicalReference": "firebase-functions!InvalidMatrixDetails:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "invalidMatrixDetails", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#outcomeSummary:member", + "docComment": "/**\n * The overall outcome of the test matrix run. Only set when the test matrix state is FINISHED.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "outcomeSummary?: " + }, + { + "kind": "Reference", + "text": "OutcomeSummary", + "canonicalReference": "firebase-functions!OutcomeSummary:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "outcomeSummary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#resultStorage:member", + "docComment": "/**\n * Where the results for the matrix are located.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resultStorage: " + }, + { + "kind": "Reference", + "text": "ResultStorage", + "canonicalReference": "firebase-functions!ResultStorage:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "resultStorage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#state:member", + "docComment": "/**\n * Indicates the current progress of the test matrix\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "TestState", + "canonicalReference": "firebase-functions!TestState:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!testLab.TestMatrix#testMatrixId:member", + "docComment": "/**\n * Unique id set by the service.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "testMatrixId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "testMatrixId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!testLab.testMatrix:function(1)", + "docComment": "/**\n * Handle events related to Test Lab test matrices.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function testMatrix(): " + }, + { + "kind": "Reference", + "text": "TestMatrixBuilder", + "canonicalReference": "firebase-functions!TestMatrixBuilder:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "testMatrix" + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!testLab.TestMatrixBuilder:class", + "docComment": "/**\n * Builder used to create Cloud Functions for Test Lab test matrices events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class TestMatrixBuilder " + } + ], + "releaseTag": "Public", + "name": "TestMatrixBuilder", + "members": [ + { + "kind": "Method", + "canonicalReference": "firebase-functions!testLab.TestMatrixBuilder#onComplete:member(1)", + "docComment": "/**\n * Handle a TestMatrix that reached a final test state.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onComplete(handler: " + }, + { + "kind": "Content", + "text": "(testMatrix: " + }, + { + "kind": "Reference", + "text": "TestMatrix", + "canonicalReference": "firebase-functions!TestMatrix:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "EventContext", + "canonicalReference": "firebase-functions!EventContext:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "PromiseLike", + "canonicalReference": "!PromiseLike:interface" + }, + { + "kind": "Content", + "text": " | any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TestMatrix", + "canonicalReference": "firebase-functions!TestMatrix:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onComplete" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!testLab.TestState:type", + "docComment": "/**\n * The state (i.e. progress) of a TestMatrix.\n *\n * Possible values: - 'VALIDATING': The matrix is being validated. - 'PENDING': The matrix is waiting for resources to become available. - 'FINISHED': The matrix has terminated normally. This means that the matrix level processing completed normally, but individual executions may be in an ERROR state. - 'ERROR': The matrix has stopped because it encountered an infrastructure failure. - 'INVALID': The matrix was not run because the provided inputs are not valid. E.g. the input file is not of the expected type, or is malformed/corrupt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TestState = " + }, + { + "kind": "Content", + "text": "'VALIDATING' | 'PENDING' | 'FINISHED' | 'ERROR' | 'INVALID'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TestState", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!TriggerAnnotated:interface", + "docComment": "/**\n * @hidden TriggerAnnotated is used internally by the firebase CLI to understand what type of Cloud Function to deploy.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface TriggerAnnotated " + } + ], + "releaseTag": "Public", + "name": "TriggerAnnotated", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!TriggerAnnotated#__trigger:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "__trigger: " + }, + { + "kind": "Content", + "text": "{\n availableMemoryMb?: number;\n eventTrigger?: {\n eventType: string;\n resource: string;\n service: string;\n };\n failurePolicy?: " + }, + { + "kind": "Reference", + "text": "FailurePolicy", + "canonicalReference": "firebase-functions!FailurePolicy:interface" + }, + { + "kind": "Content", + "text": ";\n httpsTrigger?: {\n invoker?: string[];\n };\n labels?: {\n [key: string]: string;\n };\n regions?: string[];\n schedule?: " + }, + { + "kind": "Reference", + "text": "Schedule", + "canonicalReference": "firebase-functions!Schedule:interface" + }, + { + "kind": "Content", + "text": ";\n timeout?: " + }, + { + "kind": "Reference", + "text": "Duration", + "canonicalReference": "firebase-functions!Duration:type" + }, + { + "kind": "Content", + "text": ";\n vpcConnector?: string;\n vpcConnectorEgressSettings?: string;\n serviceAccountEmail?: string;\n ingressSettings?: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "__trigger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!VALID_MEMORY_OPTIONS:var", + "docComment": "/**\n * List of available memory options supported by Cloud Functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "VALID_MEMORY_OPTIONS: " + }, + { + "kind": "Content", + "text": "readonly [\"128MB\", \"256MB\", \"512MB\", \"1GB\", \"2GB\", \"4GB\", \"8GB\"]" + } + ], + "releaseTag": "Public", + "name": "VALID_MEMORY_OPTIONS", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "firebase-functions!VPC_EGRESS_SETTINGS_OPTIONS:var", + "docComment": "/**\n * List of available options for VpcConnectorEgressSettings.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "VPC_EGRESS_SETTINGS_OPTIONS: " + }, + { + "kind": "Content", + "text": "readonly [\"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED\", \"PRIVATE_RANGES_ONLY\", \"ALL_TRAFFIC\"]" + } + ], + "releaseTag": "Public", + "name": "VPC_EGRESS_SETTINGS_OPTIONS", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/docgen/v1/firebase-functions.api.md b/docgen/v1/firebase-functions.api.md new file mode 100644 index 000000000..495dca09e --- /dev/null +++ b/docgen/v1/firebase-functions.api.md @@ -0,0 +1,1080 @@ +## API Report File for "firebase-functions" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +/// + +import * as express from 'express'; +import * as firebase from 'firebase-admin'; +import { ParamsDictionary } from 'express-serve-static-core'; +import { Request } from 'express'; +import { Response } from 'express'; + +declare namespace analytics { + export { + event, + _eventWithOptions, + provider, + service, + AnalyticsEventBuilder, + AnalyticsEvent, + UserDimensions, + UserPropertyValue, + DeviceInfo, + GeoInfo, + AppInfo, + ExportBundleInfo + } +} +export { analytics } + +// @public +class AnalyticsEvent { + constructor(wireFormat: any); + logTime: string; + name: string; + params: { + [key: string]: any; + }; + previousLogTime?: string; + reportingDate: string; + user?: UserDimensions; + valueInUSD?: number; +} + +// @public +class AnalyticsEventBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onLog(handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// Warning: (ae-forgotten-export) The symbol "apps" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export const app: apps.apps.Apps; + +// @public +interface AppInfo { + appId?: string; + appInstanceId: string; + appPlatform: string; + appStore?: string; + appVersion?: string; +} + +// @public (undocumented) +function apps_2(): apps_2.Apps; + +// @public (undocumented) +namespace apps_2 { + const // (undocumented) + garbageCollectionInterval: number; + // (undocumented) + class Apps { + constructor(); + // (undocumented) + get admin(): firebase.app.App; + // (undocumented) + _appAlive(appName: string): boolean; + // (undocumented) + _destroyApp(appName: string): void; + // (undocumented) + release(): Promise; + // (undocumented) + retain(): void; + setEmulatedAdminApp(app: firebase.app.App): void; + } + let // (undocumented) + singleton: apps_2.Apps; + let // (undocumented) + init: () => Apps; + // (undocumented) + interface AuthMode { + // (undocumented) + admin: boolean; + // (undocumented) + variable?: any; + } + // (undocumented) + function delay(delay: number): Promise; + // (undocumented) + interface RefCounter { + // (undocumented) + [appName: string]: number; + } +} + +declare namespace auth { + export { + user, + _userWithOptions, + userRecordConstructor, + provider_2 as provider, + service_2 as service, + UserRecordMetadata, + UserBuilder, + UserRecord, + UserInfo + } +} +export { auth } + +// @public (undocumented) +function beforeSnapshotConstructor(event: Event): DocumentSnapshot; + +// @public +function bucket(bucket?: string): BucketBuilder; + +// @public +class BucketBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + object(): ObjectBuilder; +} + +// @public (undocumented) +function _bucketWithOptions(options: DeploymentOptions, bucket?: string): BucketBuilder; + +// @public +interface CallableContext { + // Warning: (ae-forgotten-export) The symbol "AppCheckData" needs to be exported by the entry point index.d.ts + app?: AppCheckData; + // Warning: (ae-forgotten-export) The symbol "AuthData" needs to be exported by the entry point index.d.ts + auth?: AuthData; + instanceIdToken?: string; + rawRequest: Request_2; +} + +// @public +export class Change { + constructor(before: T, after: T); + // (undocumented) + after: T; + // (undocumented) + before: T; +} + +// @public (undocumented) +export namespace Change { + // (undocumented) + export function applyFieldMask(sparseBefore: any, after: any, fieldMask: string): any; + export function fromJSON(json: ChangeJson, customizer?: (x: any) => T): Change; + export function fromObjects(before: T, after: T): Change; +} + +// @public +export interface ChangeJson { + after?: any; + before?: any; + fieldMask?: string; +} + +// @public +class ClientInfo { + details: { + [key: string]: string; + }; + name: string; +} + +// @public +export type CloudFunction = Runnable & TriggerAnnotated & ((input: any, context?: any) => PromiseLike | any); + +// @public (undocumented) +export function config(): config.Config; + +// @public +export namespace config { + export interface Config { + // (undocumented) + [key: string]: any; + } + let // (undocumented) + singleton: config.Config; +} + +declare namespace database { + export { + instance, + ref, + _instanceWithOptions, + _refWithOptions, + extractInstanceAndPath, + provider_3 as provider, + service_3 as service, + InstanceBuilder, + RefBuilder, + DataSnapshot + } +} +export { database } + +// @public (undocumented) +function database_2(database: string): DatabaseBuilder; + +// @public (undocumented) +class DatabaseBuilder { + constructor(database: string, options: DeploymentOptions); + // (undocumented) + document(path: string): DocumentBuilder; + // (undocumented) + namespace(namespace: string): NamespaceBuilder; +} + +// @public (undocumented) +function _databaseWithOptions(database: string, options: DeploymentOptions): DatabaseBuilder; + +// @public +class DataSnapshot { + constructor(data: any, path?: string, // path will be undefined for the database root + app?: firebase.app.App, instance?: string); + child(childPath: string): DataSnapshot; + exists(): boolean; + exportVal(): any; + forEach(action: (a: DataSnapshot) => boolean | void): boolean; + getPriority(): string | number | null; + hasChild(childPath: string): boolean; + hasChildren(): boolean; + // (undocumented) + instance: string; + get key(): string; + numChildren(): number; + get ref(): firebase.database.Reference; + toJSON(): Object; + val(): any; +} + +// @public +function debug(...args: any[]): void; + +// @public (undocumented) +export const DEFAULT_FAILURE_POLICY: FailurePolicy; + +// @public (undocumented) +const defaultDatabase = "(default)"; + +// @public (undocumented) +export interface DeploymentOptions extends RuntimeOptions { + // (undocumented) + regions?: Array; + // (undocumented) + schedule?: Schedule; +} + +// @public +interface DeviceInfo { + deviceCategory?: string; + deviceId?: string; + deviceModel?: string; + deviceTimeZoneOffsetSeconds: number; + limitedAdTracking: boolean; + mobileBrandName?: string; + mobileMarketingName?: string; + mobileModelName?: string; + platformVersion?: string; + resettableDeviceId?: string; + userDefaultLanguage: string; +} + +// @public +function document(path: string): DocumentBuilder; + +// @public (undocumented) +class DocumentBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; + onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; + onUpdate(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; + onWrite(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; +} + +// @public (undocumented) +type DocumentSnapshot = firebase.firestore.DocumentSnapshot; + +// @public (undocumented) +function _documentWithOptions(path: string, options: DeploymentOptions): DocumentBuilder; + +// @public +function error(...args: any[]): void; + +// @public +export interface Event { + // (undocumented) + context: { + eventId: string; + timestamp: string; + eventType: string; + resource: Resource; + domain?: string; + }; + // (undocumented) + data: any; +} + +// @public +function event(analyticsEventType: string): AnalyticsEventBuilder; + +// @public +export interface EventContext { + auth?: { + token: object; + uid: string; + }; + authType?: 'ADMIN' | 'USER' | 'UNAUTHENTICATED'; + eventId: string; + eventType: string; + params: { + [option: string]: any; + }; + resource: Resource; + timestamp: string; +} + +// @public (undocumented) +function _eventWithOptions(analyticsEventType: string, options: DeploymentOptions): AnalyticsEventBuilder; + +// @public +class ExportBundleInfo { + constructor(wireFormat: any); + bundleSequenceId: number; + serverTimestampOffset: number; +} + +// @public (undocumented) +function extractInstanceAndPath(resource: string, domain?: string): string[]; + +// @public (undocumented) +export interface FailurePolicy { + // (undocumented) + retry: {}; +} + +// @public (undocumented) +export function firebaseConfig(): firebase.AppOptions | null; + +// @public (undocumented) +export let firebaseConfigCache: firebase.AppOptions | null; + +declare namespace firestore { + export { + document, + namespace, + database_2 as database, + _databaseWithOptions, + _namespaceWithOptions, + _documentWithOptions, + snapshotConstructor, + beforeSnapshotConstructor, + provider_4 as provider, + service_4 as service, + defaultDatabase, + DocumentSnapshot, + QueryDocumentSnapshot, + DatabaseBuilder, + NamespaceBuilder, + DocumentBuilder + } +} +export { firestore } + +// @public (undocumented) +export class FunctionBuilder { + constructor(options: DeploymentOptions); + // (undocumented) + get analytics(): { + event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; + }; + // (undocumented) + get auth(): { + user: () => auth.UserBuilder; + }; + // (undocumented) + get database(): { + instance: (instance: string) => database.InstanceBuilder; + ref: (path: string) => database.RefBuilder; + }; + // (undocumented) + get firestore(): { + document: (path: string) => firestore.DocumentBuilder; + namespace: (namespace: string) => firestore.NamespaceBuilder; + database: (database: string) => firestore.DatabaseBuilder; + }; + // (undocumented) + get https(): { + onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise) => HttpsFunction; + onCall: (handler: (data: any, context: https.CallableContext) => any | Promise) => TriggerAnnotated & ((req: express.Request, resp: express.Response) => void | Promise) & Runnable; + }; + // (undocumented) + get pubsub(): { + topic: (topic: string) => pubsub.TopicBuilder; + schedule: (schedule: string) => pubsub.ScheduleBuilder; + }; + region(...regions: Array): FunctionBuilder; + // (undocumented) + get remoteConfig(): { + onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike | any) => CloudFunction; + }; + runWith(runtimeOptions: RuntimeOptions): FunctionBuilder; + // (undocumented) + get storage(): { + bucket: (bucket?: string) => storage.BucketBuilder; + object: () => storage.ObjectBuilder; + }; + // (undocumented) + get testLab(): { + testMatrix: () => testLab.TestMatrixBuilder; + }; +} + +// @public +type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'; + +// @public +interface GeoInfo { + city?: string; + continent?: string; + country?: string; + region?: string; +} + +// Warning: (ae-forgotten-export) The symbol "HandlerBuilder" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export let handler: HandlerBuilder; + +declare namespace https { + export { + onRequest, + onCall, + _onRequestWithOptions, + _onCallWithOptions, + Request_2 as Request, + CallableContext, + FunctionsErrorCode, + HttpsError + } +} +export { https } + +// @public +class HttpsError extends Error { + constructor(code: FunctionsErrorCode, message: string, details?: unknown); + readonly code: FunctionsErrorCode; + readonly details: unknown; + // Warning: (ae-forgotten-export) The symbol "HttpErrorCode" needs to be exported by the entry point index.d.ts + readonly httpErrorCode: HttpErrorCode; + // Warning: (ae-forgotten-export) The symbol "HttpErrorWireFormat" needs to be exported by the entry point index.d.ts + // + // (undocumented) + toJSON(): HttpErrorWireFormat; +} + +// @public +export type HttpsFunction = TriggerAnnotated & ((req: Request, resp: Response) => void | Promise); + +// @public +function info(...args: any[]): void; + +// @public +export const INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]; + +// @public +function instance(instance: string): InstanceBuilder; + +// @public +class InstanceBuilder { + constructor(instance: string, options: DeploymentOptions); + ref(path: string): RefBuilder; +} + +// @public (undocumented) +function _instanceWithOptions(instance: string, options: DeploymentOptions): InstanceBuilder; + +// @public +type InvalidMatrixDetails = 'DETAILS_UNAVAILABLE' | 'MALFORMED_APK' | 'MALFORMED_TEST_APK' | 'NO_MANIFEST' | 'NO_PACKAGE_NAME' | 'INVALID_PACKAGE_NAME' | 'TEST_SAME_AS_APP' | 'NO_INSTRUMENTATION' | 'NO_SIGNATURE' | 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE' | 'NO_TEST_RUNNER_CLASS' | 'NO_LAUNCHER_ACTIVITY' | 'FORBIDDEN_PERMISSIONS' | 'INVALID_ROBO_DIRECTIVES' | 'INVALID_RESOURCE_NAME' | 'INVALID_DIRECTIVE_ACTION' | 'TEST_LOOP_INTENT_FILTER_NOT_FOUND' | 'SCENARIO_LABEL_NOT_DECLARED' | 'SCENARIO_LABEL_MALFORMED' | 'SCENARIO_NOT_DECLARED' | 'DEVICE_ADMIN_RECEIVER' | 'MALFORMED_XC_TEST_ZIP' | 'BUILT_FOR_IOS_SIMULATOR' | 'NO_TESTS_IN_XC_TEST_ZIP' | 'USE_DESTINATION_ARTIFACTS' | 'TEST_NOT_APP_HOSTED' | 'PLIST_CANNOT_BE_PARSED' | 'NO_CODE_APK' | 'INVALID_INPUT_APK' | 'INVALID_APK_PREVIEW_SDK'; + +// @public +function log(...args: any[]): void; + +// @public +interface LogEntry { + // (undocumented) + [key: string]: any; + // (undocumented) + message?: string; + // (undocumented) + severity: LogSeverity; +} + +declare namespace logger { + export { + write, + debug, + log, + info, + warn, + error, + LogSeverity, + LogEntry + } +} +export { logger } + +// @public +type LogSeverity = 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'; + +// @public (undocumented) +export function makeCloudFunction({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: MakeCloudFunctionArgs): CloudFunction; + +// @public (undocumented) +export interface MakeCloudFunctionArgs { + // (undocumented) + after?: (raw: Event) => void; + // (undocumented) + before?: (raw: Event) => void; + // (undocumented) + contextOnlyHandler?: (context: EventContext) => PromiseLike | any; + // (undocumented) + dataConstructor?: (raw: Event) => EventData; + // (undocumented) + eventType: string; + // (undocumented) + handler?: (data: EventData, context: EventContext) => PromiseLike | any; + // (undocumented) + labels?: { + [key: string]: any; + }; + // (undocumented) + legacyEventType?: string; + // (undocumented) + options?: { + [key: string]: any; + }; + // (undocumented) + provider: string; + // (undocumented) + service: string; + // (undocumented) + triggerResource: () => string; +} + +// @public (undocumented) +export const MAX_NUMBER_USER_LABELS = 58; + +// @public +export const MAX_TIMEOUT_SECONDS = 540; + +// @public +class Message { + constructor(data: any); + readonly attributes: { + [key: string]: string; + }; + readonly data: string; + get json(): any; + toJSON(): any; +} + +// @public +export const MIN_TIMEOUT_SECONDS = 0; + +// @public (undocumented) +function namespace(namespace: string): NamespaceBuilder; + +// @public (undocumented) +class NamespaceBuilder { + constructor(database: string, options: DeploymentOptions, namespace?: string); + // (undocumented) + document(path: string): DocumentBuilder; +} + +// @public (undocumented) +function _namespaceWithOptions(namespace: string, options: DeploymentOptions): NamespaceBuilder; + +// @public +function object(): ObjectBuilder; + +// @public +class ObjectBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onArchive(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; + // (undocumented) + onChange(handler: any): Error; + onDelete(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; + onFinalize(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; + onMetadataUpdate(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// @public +interface ObjectMetadata { + // (undocumented) + acl?: [ + { + kind?: string; + id?: string; + selfLink?: string; + bucket?: string; + object?: string; + generation?: string; + entity?: string; + role?: string; + email?: string; + entityId?: string; + domain?: string; + projectTeam?: { + projectNumber?: string; + team?: string; + }; + etag?: string; + } + ]; + bucket: string; + cacheControl?: string; + componentCount?: string; + contentDisposition?: string; + contentEncoding?: string; + contentLanguage?: string; + contentType?: string; + crc32c?: string; + customerEncryption?: { + encryptionAlgorithm?: string; + keySha256?: string; + }; + // (undocumented) + etag?: string; + generation?: string; + id: string; + kind: string; + md5Hash?: string; + mediaLink?: string; + metadata?: { + [key: string]: string; + }; + metageneration?: string; + name?: string; + // (undocumented) + owner?: { + entity?: string; + entityId?: string; + }; + selfLink?: string; + size: string; + storageClass: string; + timeCreated: string; + timeDeleted?: string; + // (undocumented) + timeStorageClassUpdated?: string; + updated: string; +} + +// @public (undocumented) +function _objectWithOptions(options: DeploymentOptions): ObjectBuilder; + +// @public +function onCall(handler: (data: any, context: CallableContext) => any | Promise): HttpsFunction & Runnable; + +// @public (undocumented) +function _onCallWithOptions(handler: (data: any, context: CallableContext) => any | Promise, options: DeploymentOptions): HttpsFunction & Runnable; + +// @public +function onRequest(handler: (req: Request_2, resp: express.Response) => void | Promise): HttpsFunction; + +// @public (undocumented) +function _onRequestWithOptions(handler: (req: Request_2, resp: express.Response) => void | Promise, options: DeploymentOptions): HttpsFunction; + +// @public +function onUpdate(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any): CloudFunction; + +// @public (undocumented) +function _onUpdateWithOptions(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any, options: DeploymentOptions): CloudFunction; + +// @public (undocumented) +export function optionsToTrigger(options: DeploymentOptions): any; + +// @public +type OutcomeSummary = 'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED'; + +// @public (undocumented) +const provider = "google.analytics"; + +// @public (undocumented) +const provider_2 = "google.firebase.auth"; + +// @public (undocumented) +const provider_3 = "google.firebase.database"; + +// @public (undocumented) +const provider_4 = "google.firestore"; + +// @public (undocumented) +const provider_5 = "google.firebase.remoteconfig"; + +// @public (undocumented) +const provider_6 = "google.storage"; + +// @public (undocumented) +const provider_7 = "google.pubsub"; + +declare namespace pubsub { + export { + topic, + _topicWithOptions, + schedule, + _scheduleWithOptions, + provider_7 as provider, + service_7 as service, + TopicBuilder, + ScheduleBuilder, + Message + } +} +export { pubsub } + +// @public (undocumented) +type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnapshot; + +// @public +function ref(path: string): RefBuilder; + +// @public +class RefBuilder { + constructor(apps: apps_2.Apps, triggerResource: () => string, options: DeploymentOptions); + onCreate(handler: (snapshot: DataSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; + onDelete(handler: (snapshot: DataSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; + onUpdate(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; + onWrite(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; +} + +// @public (undocumented) +function _refWithOptions(path: string, options: DeploymentOptions): RefBuilder; + +// @public +export function region(...regions: Array): FunctionBuilder; + +declare namespace remoteConfig { + export { + onUpdate, + _onUpdateWithOptions, + provider_5 as provider, + service_5 as service, + UpdateBuilder, + TemplateVersion, + RemoteConfigUser + } +} +export { remoteConfig } + +// @public +interface RemoteConfigUser { + email: string; + imageUrl?: string; + name?: string; +} + +export { Request } + +// @public (undocumented) +interface Request_2 extends express.Request { + // (undocumented) + rawBody: Buffer; +} + +// @public +export interface Resource { + // (undocumented) + labels?: { + [tag: string]: string; + }; + // (undocumented) + name: string; + // (undocumented) + service: string; + // (undocumented) + type?: string; +} + +export { Response } + +// @public +class ResultStorage { + gcsPath?: string; + resultsUrl?: string; + toolResultsExecutionId?: string; + toolResultsHistoryId?: string; +} + +// @public +export interface Runnable { + // (undocumented) + run: (data: T, context: any) => PromiseLike | any; +} + +// @public (undocumented) +export interface RuntimeOptions { + failurePolicy?: FailurePolicy | boolean; + ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number]; + invoker?: 'public' | 'private' | string | string[]; + labels?: Record; + maxInstances?: number; + memory?: typeof VALID_MEMORY_OPTIONS[number]; + minInstances?: number; + platform?: 'gcfv1'; + serviceAccount?: 'default' | string; + timeoutSeconds?: number; + vpcConnector?: string; + vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number]; +} + +// @public +export function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder; + +// @public +export interface Schedule { + // (undocumented) + retryConfig?: ScheduleRetryConfig; + // (undocumented) + schedule: string; + // (undocumented) + timeZone?: string; +} + +// @public +function schedule(schedule: string): ScheduleBuilder; + +// @public +class ScheduleBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onRun(handler: (context: EventContext) => PromiseLike | any): CloudFunction; + // (undocumented) + retryConfig(config: ScheduleRetryConfig): ScheduleBuilder; + // (undocumented) + timeZone(timeZone: string): ScheduleBuilder; +} + +// @public +export interface ScheduleRetryConfig { + // (undocumented) + maxBackoffDuration?: string; + // (undocumented) + maxDoublings?: number; + // (undocumented) + maxRetryDuration?: string; + // (undocumented) + minBackoffDuration?: string; + // (undocumented) + retryCount?: number; +} + +// @public (undocumented) +function _scheduleWithOptions(schedule: string, options: DeploymentOptions): ScheduleBuilder; + +// @public (undocumented) +const service = "app-measurement.com"; + +// @public (undocumented) +const service_2 = "firebaseauth.googleapis.com"; + +// @public (undocumented) +const service_3 = "firebaseio.com"; + +// @public (undocumented) +const service_4 = "firestore.googleapis.com"; + +// @public (undocumented) +const service_5 = "firebaseremoteconfig.googleapis.com"; + +// @public (undocumented) +const service_6 = "storage.googleapis.com"; + +// @public (undocumented) +const service_7 = "pubsub.googleapis.com"; + +// @public (undocumented) +function snapshotConstructor(event: Event): DocumentSnapshot; + +declare namespace storage { + export { + bucket, + object, + _bucketWithOptions, + _objectWithOptions, + provider_6 as provider, + service_6 as service, + BucketBuilder, + ObjectBuilder, + ObjectMetadata + } +} +export { storage } + +// @public +export const SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]; + +// @public +interface TemplateVersion { + description: string; + rollbackSource?: number; + updateOrigin: string; + updateTime: string; + updateType: string; + updateUser: RemoteConfigUser; + versionNumber: number; +} + +declare namespace testLab { + export { + testMatrix, + TestMatrixBuilder, + TestMatrix, + ClientInfo, + ResultStorage, + InvalidMatrixDetails, + TestState, + OutcomeSummary + } +} +export { testLab } + +// @public +class TestMatrix { + clientInfo: ClientInfo; + createTime: string; + invalidMatrixDetails?: InvalidMatrixDetails; + outcomeSummary?: OutcomeSummary; + resultStorage: ResultStorage; + state: TestState; + testMatrixId: string; +} + +// @public +function testMatrix(): TestMatrixBuilder; + +// @public +class TestMatrixBuilder { + onComplete(handler: (testMatrix: TestMatrix, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// @public +type TestState = 'VALIDATING' | 'PENDING' | 'FINISHED' | 'ERROR' | 'INVALID'; + +// @public +function topic(topic: string): TopicBuilder; + +// @public +class TopicBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onPublish(handler: (message: Message, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// @public (undocumented) +function _topicWithOptions(topic: string, options: DeploymentOptions): TopicBuilder; + +// @public +export interface TriggerAnnotated { + // (undocumented) + __trigger: { + availableMemoryMb?: number; + eventTrigger?: { + eventType: string; + resource: string; + service: string; + }; + failurePolicy?: FailurePolicy; + httpsTrigger?: { + invoker?: string[]; + }; + labels?: { + [key: string]: string; + }; + regions?: string[]; + schedule?: Schedule; + timeout?: Duration; + vpcConnector?: string; + vpcConnectorEgressSettings?: string; + serviceAccountEmail?: string; + ingressSettings?: string; + }; +} + +// @public +class UpdateBuilder { + constructor(triggerResource: () => string, options: DeploymentOptions); + onUpdate(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// @public +function user(): UserBuilder; + +// @public +class UserBuilder { + constructor(triggerResource: () => string, options?: DeploymentOptions); + onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike | any): CloudFunction; + onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike | any): CloudFunction; +} + +// @public +class UserDimensions { + constructor(wireFormat: any); + appInfo?: AppInfo; + bundleInfo: ExportBundleInfo; + deviceInfo: DeviceInfo; + firstOpenTime?: string; + geoInfo: GeoInfo; + userId?: string; + userProperties: { + [key: string]: UserPropertyValue; + }; +} + +// @public +type UserInfo = firebase.auth.UserInfo; + +// @public +class UserPropertyValue { + constructor(wireFormat: any); + setTime: string; + value: string; +} + +// @public +type UserRecord = firebase.auth.UserRecord; + +// @public (undocumented) +function userRecordConstructor(wireData: Object): firebase.auth.UserRecord; + +// @public (undocumented) +class UserRecordMetadata implements firebase.auth.UserMetadata { + constructor(creationTime: string, lastSignInTime: string); + // (undocumented) + creationTime: string; + // (undocumented) + lastSignInTime: string; + toJSON(): { + creationTime: string; + lastSignInTime: string; + }; +} + +// @public (undocumented) +function _userWithOptions(options: DeploymentOptions): UserBuilder; + +// @public +export const VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]; + +// @public +export const VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]; + +// @public +function warn(...args: any[]): void; + +// @public +function write(entry: LogEntry): void; + +// Warnings were encountered during analysis: +// +// lib/cloud-functions.d.ts:196:9 - (ae-forgotten-export) The symbol "Duration" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/docgen/v2/firebase-functions.api.json b/docgen/v2/firebase-functions.api.json new file mode 100644 index 000000000..999d49045 --- /dev/null +++ b/docgen/v2/firebase-functions.api.json @@ -0,0 +1,3668 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.18.7", + "schemaVersion": 1004, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + } + } + }, + "kind": "Package", + "canonicalReference": "firebase-functions!", + "docComment": "", + "name": "firebase-functions", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "firebase-functions!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "firebase-functions!CloudEvent:interface", + "docComment": "/**\n * A CloudEvent is a cross-platform format for encoding a serverless event. More information can be found in https://github.com/cloudevents/spec\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CloudEvent " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "CloudEvent", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#data:member", + "docComment": "/**\n * Information about this specific event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "data: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#id:member", + "docComment": "/**\n * A globally unique ID for this event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#params:member", + "docComment": "/**\n * A map of template parameter name to value for subject strings.\n *\n * This map is only available on some event types that allow templates in the subject string, such as Firestore. When listening to a document template \"/users/{uid}\", an event with subject \"/documents/users/1234\" would have a params of {\"uid\": \"1234\"}.\n *\n * Params are generated inside the firebase-functions SDK and are not part of the CloudEvents spec nor the payload that a Cloud Function actually receives.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "params?: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "params", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#source:member", + "docComment": "/**\n * The resource which published this event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "source", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#specversion:member", + "docComment": "/**\n * Version of the CloudEvents spec for this event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly specversion: " + }, + { + "kind": "Content", + "text": "'1.0'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "specversion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#subject:member", + "docComment": "/**\n * The resource, provided by source, that this event relates to\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subject?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "subject", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#time:member", + "docComment": "/**\n * When this event occurred.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "time: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "time", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudEvent#type:member", + "docComment": "/**\n * The type of event that this represents.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!CloudFunction:interface", + "docComment": "/**\n * A handler for CloudEvents.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CloudFunction " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "CloudFunction", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!CloudFunction#__trigger:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "__trigger: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "__trigger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "CallSignature", + "canonicalReference": "firebase-functions!CloudFunction:call(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "(raw: " + }, + { + "kind": "Reference", + "text": "CloudEvent", + "canonicalReference": "firebase-functions!CloudEvent:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "raw", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ] + }, + { + "kind": "MethodSignature", + "canonicalReference": "firebase-functions!CloudFunction#run:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "run(event: " + }, + { + "kind": "Reference", + "text": "CloudEvent", + "canonicalReference": "firebase-functions!CloudEvent:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "name": "run" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!GlobalOptions:interface", + "docComment": "/**\n * GlobalOptions are options that can be set across an entire project. These options are common to HTTPS and Event handling functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface GlobalOptions " + } + ], + "releaseTag": "Public", + "name": "GlobalOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#concurrency:member", + "docComment": "/**\n * Number of requests a function can serve at once. Can only be applied to functions running on Cloud Functions v2. A value of null restores the default concurrency.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "concurrency?: " + }, + { + "kind": "Content", + "text": "number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "concurrency", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#ingressSettings:member", + "docComment": "/**\n * Ingress settings which control where this function can be called from. A value of null turns off ingress settings.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ingressSettings?: " + }, + { + "kind": "Reference", + "text": "IngressSetting", + "canonicalReference": "firebase-functions!IngressSetting:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "ingressSettings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#invoker:member", + "docComment": "/**\n * Invoker to set access control on https functions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "invoker?: " + }, + { + "kind": "Content", + "text": "'public' | 'private' | string | string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "invoker", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#labels:member", + "docComment": "/**\n * User labels to set on the function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "labels?: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "labels", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#maxInstances:member", + "docComment": "/**\n * Max number of instances to be running in parallel. A value of null restores the default max instances.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxInstances?: " + }, + { + "kind": "Content", + "text": "number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "maxInstances", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#memory:member", + "docComment": "/**\n * Amount of memory to allocate to a function. A value of null restores the defaults of 256MB.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "memory?: " + }, + { + "kind": "Reference", + "text": "MemoryOption", + "canonicalReference": "firebase-functions!MemoryOption:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "memory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#minInstances:member", + "docComment": "/**\n * Min number of actual instances to be running at a given time. Instances will be billed for memory allocation and 10% of CPU allocation while idle. A value of null restores the default min instances.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "minInstances?: " + }, + { + "kind": "Content", + "text": "number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "minInstances", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#region:member", + "docComment": "/**\n * Region where functions should be deployed. HTTP functions can override and specify more than one region.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "region?: " + }, + { + "kind": "Reference", + "text": "SupportedRegion", + "canonicalReference": "firebase-functions!SupportedRegion:type" + }, + { + "kind": "Content", + "text": " | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "region", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#serviceAccount:member", + "docComment": "/**\n * Specific service account for the function to run as. A value of null restores the default service account.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "serviceAccount?: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "serviceAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#timeoutSeconds:member", + "docComment": "/**\n * Timeout for the function in sections, possible values are 0 to 540. HTTPS functions can specify a higher timeout. A value of null restores the default of 60s\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeoutSeconds?: " + }, + { + "kind": "Content", + "text": "number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "timeoutSeconds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#vpcConnector:member", + "docComment": "/**\n * Connect cloud function to specified VPC connector. A value of null removes the VPC connector\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vpcConnector?: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "vpcConnector", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!GlobalOptions#vpcConnectorEgressSettings:member", + "docComment": "/**\n * Egress settings for VPC connector. A value of null turns off VPC connector egress settings\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vpcConnectorEgressSettings?: " + }, + { + "kind": "Reference", + "text": "VpcEgressSetting", + "canonicalReference": "firebase-functions!VpcEgressSetting:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "vpcConnectorEgressSettings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!https:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "https", + "members": [ + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.CallableFunction:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CallableFunction extends " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Return", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "CallableFunction", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "firebase-functions!https.CallableFunction#run:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "run(data: " + }, + { + "kind": "Reference", + "text": "CallableRequest", + "canonicalReference": "firebase-functions!CallableRequest:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "Return" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "name": "run" + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.CallableRequest:interface", + "docComment": "/**\n * The request used to call a callable function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CallableRequest " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "CallableRequest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableRequest#app:member", + "docComment": "/**\n * The result of decoding and verifying a Firebase AppCheck token.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "app?: " + }, + { + "kind": "Reference", + "text": "AppCheckData", + "canonicalReference": "firebase-functions!AppCheckData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "app", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableRequest#auth:member", + "docComment": "/**\n * The result of decoding and verifying a Firebase Auth ID token.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "auth?: " + }, + { + "kind": "Reference", + "text": "AuthData", + "canonicalReference": "firebase-functions!AuthData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "auth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableRequest#data:member", + "docComment": "/**\n * The parameters used by a client when calling this function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "data: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableRequest#instanceIdToken:member", + "docComment": "/**\n * An unverified token for a Firebase Instance ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "instanceIdToken?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "instanceIdToken", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.CallableRequest#rawRequest:member", + "docComment": "/**\n * The raw request handled by the callable.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rawRequest: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "rawRequest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!https.FunctionsErrorCode:type", + "docComment": "/**\n * The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md\n *\n * Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FunctionsErrorCode = " + }, + { + "kind": "Content", + "text": "'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FunctionsErrorCode", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "firebase-functions!https.HttpsError:class", + "docComment": "/**\n * An explicit error that can be thrown from a handler to send an error to the client that called the function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class HttpsError extends " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpsError", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!https.HttpsError:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `HttpsError` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(code: " + }, + { + "kind": "Reference", + "text": "FunctionsErrorCode", + "canonicalReference": "firebase-functions!FunctionsErrorCode:type" + }, + { + "kind": "Content", + "text": ", message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", details?: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "code", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "details", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#code:member", + "docComment": "/**\n * A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly code: " + }, + { + "kind": "Reference", + "text": "FunctionsErrorCode", + "canonicalReference": "firebase-functions!FunctionsErrorCode:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "code", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#details:member", + "docComment": "/**\n * Extra data to be converted to JSON and included in the error response.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly details: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "details", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!https.HttpsError#httpErrorCode:member", + "docComment": "/**\n * A wire format representation of a provided error code.\n *\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly httpErrorCode: " + }, + { + "kind": "Reference", + "text": "HttpErrorCode", + "canonicalReference": "firebase-functions!~HttpErrorCode:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "httpErrorCode", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!https.HttpsError#toJSON:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Reference", + "text": "HttpErrorWireFormat", + "canonicalReference": "firebase-functions!~HttpErrorWireFormat:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!https.HttpsFunction:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type HttpsFunction = " + }, + { + "kind": "Content", + "text": "((req: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", res: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ") & {\n __trigger: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "HttpsFunction", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.HttpsOptions:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface HttpsOptions extends " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpsOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.HttpsOptions#cors:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "cors?: " + }, + { + "kind": "Content", + "text": "string | boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "cors", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.HttpsOptions#region:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "region?: " + }, + { + "kind": "Content", + "text": "options." + }, + { + "kind": "Reference", + "text": "SupportedRegion", + "canonicalReference": "firebase-functions!SupportedRegion:type" + }, + { + "kind": "Content", + "text": " | string | " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "region", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 5 + } + ] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onCall:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onCall" + }, + { + "kind": "Content", + "text": ">(opts: " + }, + { + "kind": "Reference", + "text": "HttpsOptions", + "canonicalReference": "firebase-functions!HttpsOptions:interface" + }, + { + "kind": "Content", + "text": ", handler: " + }, + { + "kind": "Content", + "text": "(request: " + }, + { + "kind": "Reference", + "text": "CallableRequest", + "canonicalReference": "firebase-functions!CallableRequest:interface" + }, + { + "kind": "Content", + "text": ") => Return" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CallableFunction", + "canonicalReference": "firebase-functions!CallableFunction:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 12 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "typeParameterName": "Return", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + } + } + ], + "name": "onCall" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onCall:function(2)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onCall" + }, + { + "kind": "Content", + "text": ">(handler: " + }, + { + "kind": "Content", + "text": "(request: " + }, + { + "kind": "Reference", + "text": "CallableRequest", + "canonicalReference": "firebase-functions!CallableRequest:interface" + }, + { + "kind": "Content", + "text": ") => Return" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CallableFunction", + "canonicalReference": "firebase-functions!CallableFunction:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 10 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "typeParameterName": "Return", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + } + } + ], + "name": "onCall" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onRequest:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onRequest(opts: " + }, + { + "kind": "Reference", + "text": "HttpsOptions", + "canonicalReference": "firebase-functions!HttpsOptions:interface" + }, + { + "kind": "Content", + "text": ", handler: " + }, + { + "kind": "Content", + "text": "(request: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", response: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "onRequest" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!https.onRequest:function(2)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onRequest(handler: " + }, + { + "kind": "Content", + "text": "(request: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "firebase-functions!Request:interface" + }, + { + "kind": "Content", + "text": ", response: " + }, + { + "kind": "Reference", + "text": "express.Response", + "canonicalReference": "@types/express!~e.Response:interface" + }, + { + "kind": "Content", + "text": ") => void | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpsFunction", + "canonicalReference": "firebase-functions!HttpsFunction:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "name": "onRequest" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!https.Request:interface", + "docComment": "/**\n * @hidden\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Request extends " + }, + { + "kind": "Reference", + "text": "express.Request", + "canonicalReference": "@types/express!~e.Request:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Request", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!https.Request#rawBody:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "rawBody: " + }, + { + "kind": "Reference", + "text": "Buffer", + "canonicalReference": "!Buffer:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "rawBody", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + } + ] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!logger:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "logger", + "members": [ + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.debug:function(1)", + "docComment": "/**\n * Writes a `DEBUG` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function debug(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "debug" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.error:function(1)", + "docComment": "/**\n * Writes an `ERROR` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function error(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "error" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.info:function(1)", + "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function info(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "info" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.log:function(1)", + "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function log(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "log" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!logger.LogEntry:interface", + "docComment": "/**\n * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging) entry. All keys aside from `severity` and `message` are included in the `jsonPayload` of the logged entry.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogEntry " + } + ], + "releaseTag": "Public", + "name": "LogEntry", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "firebase-functions!logger.LogEntry:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!logger.LogEntry#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "message?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!logger.LogEntry#severity:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "severity: " + }, + { + "kind": "Reference", + "text": "LogSeverity", + "canonicalReference": "firebase-functions!LogSeverity:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "severity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!logger.LogSeverity:type", + "docComment": "/**\n * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type LogSeverity = " + }, + { + "kind": "Content", + "text": "'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LogSeverity", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.warn:function(1)", + "docComment": "/**\n * Writes a `WARNING` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function warn(...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "warn" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!logger.write:function(1)", + "docComment": "/**\n * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).\n *\n * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function write(entry: " + }, + { + "kind": "Reference", + "text": "LogEntry", + "canonicalReference": "firebase-functions!LogEntry:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "entry", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "write" + } + ] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!params:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "params", + "members": [ + { + "kind": "Variable", + "canonicalReference": "firebase-functions!params.declaredParams:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declaredParams: " + }, + { + "kind": "Reference", + "text": "Param", + "canonicalReference": "firebase-functions!Param:class" + }, + { + "kind": "Content", + "text": "[]" + } + ], + "releaseTag": "Public", + "name": "declaredParams", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineBoolean:function(1)", + "docComment": "/**\n * Declare a boolean param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `boolean` return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineBoolean(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "BooleanParam", + "canonicalReference": "firebase-functions!BooleanParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "defineBoolean" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineFloat:function(1)", + "docComment": "/**\n * Declare a float param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `number` return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineFloat(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "FloatParam", + "canonicalReference": "firebase-functions!FloatParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "defineFloat" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineInt:function(1)", + "docComment": "/**\n * Declare an integer param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `number` return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineInt(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IntParam", + "canonicalReference": "firebase-functions!IntParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "defineInt" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineJSON:function(1)", + "docComment": "/**\n * Declare a JSON param. The associated environment variable will be treated as a JSON string when loading its value.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a specifiable return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineJSON(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "JSONParam", + "canonicalReference": "firebase-functions!JSONParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "defineJSON" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineList:function(1)", + "docComment": "/**\n * Declare a list param (array of strings).\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `string[]` return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineList(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ListParam", + "canonicalReference": "firebase-functions!ListParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "defineList" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!params.defineString:function(1)", + "docComment": "/**\n * Declare a string param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `string` return type for `.value`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function defineString(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ParamOptions", + "canonicalReference": "firebase-functions!ParamOptions:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "StringParam", + "canonicalReference": "firebase-functions!StringParam:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "defineString" + }, + { + "kind": "TypeAlias", + "canonicalReference": "firebase-functions!params.ParamOptions:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type ParamOptions = " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ParamSpec", + "canonicalReference": "firebase-functions!ParamSpec:interface" + }, + { + "kind": "Content", + "text": ", 'valueType'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ParamOptions", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ] + }, + { + "kind": "Namespace", + "canonicalReference": "firebase-functions!pubsub:namespace", + "docComment": "", + "excerptTokens": [], + "releaseTag": "None", + "name": "pubsub", + "members": [ + { + "kind": "Class", + "canonicalReference": "firebase-functions!pubsub.Message:class", + "docComment": "/**\n * Interface representing a Google Cloud Pub/Sub message.\n *\n * @param data - Payload of a Pub/Sub message.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Message " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "Message", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "firebase-functions!pubsub.Message:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(data: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#attributes:member", + "docComment": "/**\n * User-defined attributes published with the message, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly attributes: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "attributes", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#data:member", + "docComment": "/**\n * The data payload of this message object as a base64-encoded string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly data: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#json:member", + "docComment": "/**\n * The JSON data payload of this message object, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "get json(): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "json", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#messageId:member", + "docComment": "/**\n * Autogenerated ID that uniquely identifies this message.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly messageId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "messageId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#orderingKey:member", + "docComment": "/**\n * User-defined key used to ensure ordering amongst messages with the same key.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly orderingKey: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "orderingKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "firebase-functions!pubsub.Message#publishTime:member", + "docComment": "/**\n * Time the message was published\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly publishTime: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "publishTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "firebase-functions!pubsub.Message#toJSON:member(1)", + "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toJSON(): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toJSON" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!pubsub.MessagePublishedData:interface", + "docComment": "/**\n * The interface published in a Pub/Sub publish subscription.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface MessagePublishedData " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "MessagePublishedData", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!pubsub.MessagePublishedData#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly message: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "firebase-functions!Message:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!pubsub.MessagePublishedData#subscription:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly subscription: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "subscription", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub.onMessagePublished:function(1)", + "docComment": "/**\n * Handle a message being published to a Pub/Sub topic.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onMessagePublished(topic: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", handler: " + }, + { + "kind": "Content", + "text": "(event: " + }, + { + "kind": "Reference", + "text": "CloudEvent", + "canonicalReference": "firebase-functions!CloudEvent:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MessagePublishedData", + "canonicalReference": "firebase-functions!MessagePublishedData:interface" + }, + { + "kind": "Content", + "text": ">) => any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MessagePublishedData", + "canonicalReference": "firebase-functions!MessagePublishedData:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "topic", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 12 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onMessagePublished" + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!pubsub.onMessagePublished:function(2)", + "docComment": "/**\n * Handle a message being published to a Pub/Sub topic.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function onMessagePublished(options: " + }, + { + "kind": "Reference", + "text": "PubSubOptions", + "canonicalReference": "firebase-functions!PubSubOptions:interface" + }, + { + "kind": "Content", + "text": ", handler: " + }, + { + "kind": "Content", + "text": "(event: " + }, + { + "kind": "Reference", + "text": "CloudEvent", + "canonicalReference": "firebase-functions!CloudEvent:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MessagePublishedData", + "canonicalReference": "firebase-functions!MessagePublishedData:interface" + }, + { + "kind": "Content", + "text": ">) => any | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CloudFunction", + "canonicalReference": "firebase-functions!CloudFunction:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MessagePublishedData", + "canonicalReference": "firebase-functions!MessagePublishedData:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 12 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onMessagePublished" + }, + { + "kind": "Interface", + "canonicalReference": "firebase-functions!pubsub.PubSubOptions:interface", + "docComment": "/**\n * PubSubOptions extend EventHandlerOptions but must include a topic.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface PubSubOptions extends " + }, + { + "kind": "Content", + "text": "options." + }, + { + "kind": "Reference", + "text": "EventHandlerOptions", + "canonicalReference": "firebase-functions!EventHandlerOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "PubSubOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "firebase-functions!pubsub.PubSubOptions#topic:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "topic: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "topic", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + } + ] + }, + { + "kind": "Function", + "canonicalReference": "firebase-functions!setGlobalOptions:function(1)", + "docComment": "/**\n * Sets default options for all functions written using the v2 SDK.\n *\n * @param options - Options to set as default\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function setGlobalOptions(options: " + }, + { + "kind": "Reference", + "text": "GlobalOptions", + "canonicalReference": "firebase-functions!GlobalOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setGlobalOptions" + } + ] + } + ] +} diff --git a/docgen/v2/firebase-functions.api.md b/docgen/v2/firebase-functions.api.md new file mode 100644 index 000000000..879591ab0 --- /dev/null +++ b/docgen/v2/firebase-functions.api.md @@ -0,0 +1,329 @@ +## API Report File for "firebase-functions" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +/// + +import * as express from 'express'; +import * as firebase from 'firebase-admin'; + +// @public (undocumented) +function __getSpec(): { + globalOptions: GlobalOptions; + params: ParamSpec[]; +}; + +// @public (undocumented) +interface CallableFunction_2 extends HttpsFunction { + // (undocumented) + run(data: CallableRequest): Return; +} + +// @public +interface CallableRequest { + // Warning: (ae-forgotten-export) The symbol "AppCheckData" needs to be exported by the entry point index.d.ts + app?: AppCheckData; + // Warning: (ae-forgotten-export) The symbol "AuthData" needs to be exported by the entry point index.d.ts + auth?: AuthData; + data: T; + instanceIdToken?: string; + rawRequest: Request; +} + +// @public +export interface CloudEvent { + data: T; + id: string; + params?: Record; + source: string; + readonly specversion: '1.0'; + subject?: string; + time: string; + type: string; +} + +// @public +export interface CloudFunction { + // (undocumented) + (raw: CloudEvent): any | Promise; + // (undocumented) + __trigger: unknown; + // (undocumented) + run(event: CloudEvent): any | Promise; +} + +// @public +function debug(...args: any[]): void; + +// Warning: (ae-forgotten-export) The symbol "Param" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +const declaredParams: Param[]; + +// Warning: (ae-forgotten-export) The symbol "BooleanParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineBoolean(name: string, options?: ParamOptions): BooleanParam; + +// Warning: (ae-forgotten-export) The symbol "FloatParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineFloat(name: string, options?: ParamOptions): FloatParam; + +// Warning: (ae-forgotten-export) The symbol "IntParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineInt(name: string, options?: ParamOptions): IntParam; + +// Warning: (ae-forgotten-export) The symbol "JSONParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineJSON(name: string, options?: ParamOptions): JSONParam; + +// Warning: (ae-forgotten-export) The symbol "ListParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineList(name: string, options?: ParamOptions): ListParam; + +// Warning: (ae-forgotten-export) The symbol "StringParam" needs to be exported by the entry point index.d.ts +// +// @public +function defineString(name: string, options?: ParamOptions): StringParam; + +// @public +function error(...args: any[]): void; + +// @public +interface EventHandlerOptions extends GlobalOptions { + // (undocumented) + retry?: boolean; +} + +// @public +type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'; + +// @public +export interface GlobalOptions { + concurrency?: number | null; + ingressSettings?: IngressSetting | null; + invoker?: 'public' | 'private' | string | string[]; + labels?: Record; + maxInstances?: number | null; + memory?: MemoryOption | null; + minInstances?: number | null; + region?: SupportedRegion | string; + serviceAccount?: string | null; + timeoutSeconds?: number | null; + vpcConnector?: string | null; + vpcConnectorEgressSettings?: VpcEgressSetting | null; +} + +declare namespace https { + export { + onRequest, + onCall, + Request, + CallableRequest, + FunctionsErrorCode, + HttpsError, + HttpsOptions, + HttpsFunction, + CallableFunction_2 as CallableFunction + } +} +export { https } + +// @public +class HttpsError extends Error { + constructor(code: FunctionsErrorCode, message: string, details?: unknown); + readonly code: FunctionsErrorCode; + readonly details: unknown; + // Warning: (ae-forgotten-export) The symbol "HttpErrorCode" needs to be exported by the entry point index.d.ts + readonly httpErrorCode: HttpErrorCode; + // Warning: (ae-forgotten-export) The symbol "HttpErrorWireFormat" needs to be exported by the entry point index.d.ts + // + // (undocumented) + toJSON(): HttpErrorWireFormat; +} + +// @public (undocumented) +type HttpsFunction = ((req: Request, res: express.Response) => void | Promise) & { + __trigger: unknown; +}; + +// Warning: (ae-forgotten-export) The symbol "options" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +interface HttpsOptions extends Omit { + // (undocumented) + cors?: string | boolean; + // (undocumented) + region?: options.SupportedRegion | string | Array; +} + +// @public +function info(...args: any[]): void; + +// @public (undocumented) +type IngressSetting = typeof SUPPORTED_INGRESS_SETTINGS[number]; + +// @public +function log(...args: any[]): void; + +// @public +interface LogEntry { + // (undocumented) + [key: string]: any; + // (undocumented) + message?: string; + // (undocumented) + severity: LogSeverity; +} + +declare namespace logger { + export { + write, + debug, + log, + info, + warn, + error, + LogSeverity, + LogEntry + } +} +export { logger } + +// @public +type LogSeverity = 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'; + +// @public +const MAX_CONCURRENCY = 1000; + +// @public +const MAX_EVENT_TIMEOUT_SECONDS = 540; + +// @public +const MAX_HTTPS_TIMEOUT_SECONDS = 36000; + +// @public +type MemoryOption = typeof SUPPORTED_MEMORY_OPTIONS[number]; + +// @public +class Message { + constructor(data: any); + readonly attributes: { + [key: string]: string; + }; + readonly data: string; + get json(): T; + readonly messageId: string; + readonly orderingKey: string; + readonly publishTime: string; + toJSON(): any; +} + +// @public +interface MessagePublishedData { + // (undocumented) + readonly message: Message; + // (undocumented) + readonly subscription: string; +} + +// @public +const MIN_TIMEOUT_SECONDS = 1; + +// @public (undocumented) +function onCall>(opts: HttpsOptions, handler: (request: CallableRequest) => Return): CallableFunction_2; + +// @public (undocumented) +function onCall>(handler: (request: CallableRequest) => Return): CallableFunction_2; + +// @public +function onMessagePublished(topic: string, handler: (event: CloudEvent>) => any | Promise): CloudFunction>; + +// @public +function onMessagePublished(options: PubSubOptions, handler: (event: CloudEvent>) => any | Promise): CloudFunction>; + +// @public (undocumented) +function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise): HttpsFunction; + +// @public (undocumented) +function onRequest(handler: (request: Request, response: express.Response) => void | Promise): HttpsFunction; + +// @public (undocumented) +type ParamOptions = Omit, 'valueType'>; + +declare namespace params { + export { + defineString, + defineBoolean, + defineInt, + defineFloat, + defineList, + defineJSON, + ParamOptions, + declaredParams + } +} +export { params } + +declare namespace pubsub { + export { + onMessagePublished, + Message, + MessagePublishedData, + PubSubOptions + } +} +export { pubsub } + +// @public +interface PubSubOptions extends options.EventHandlerOptions { + // (undocumented) + topic: string; +} + +// @public (undocumented) +interface Request extends express.Request { + // (undocumented) + rawBody: Buffer; +} + +// @public +export function setGlobalOptions(options: GlobalOptions): void; + +// @public +const SUPPORTED_INGRESS_SETTINGS: readonly ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]; + +// @public +const SUPPORTED_MEMORY_OPTIONS: readonly ["256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]; + +// @public +const SUPPORTED_REGIONS: readonly ["us-west1"]; + +// @public +const SUPPORTED_VPC_EGRESS_SETTINGS: readonly ["PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]; + +// @public +type SupportedRegion = typeof SUPPORTED_REGIONS[number]; + +// @public +type VpcEgressSetting = typeof SUPPORTED_VPC_EGRESS_SETTINGS[number]; + +// @public +function warn(...args: any[]): void; + +// @public +function write(entry: LogEntry): void; + +// Warnings were encountered during analysis: +// +// lib/v2/options.d.ts:131:5 - (ae-forgotten-export) The symbol "ParamSpec" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/package-lock.json b/package-lock.json index 57b0ebe0e..e8a9df6ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,6 +30,112 @@ "js-tokens": "^4.0.0" } }, + "@firebase/api-documenter": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.1.2.tgz", + "integrity": "sha512-aDofRZebqbMzrbo5WAi9f21qUTzhIub7yOszirik3AwujqOzcUr1F7lIFrI41686JD1Zw56lLL/B5EWZTwvVjA==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0", + "@rushstack/ts-command-line": "4.7.8", + "api-extractor-model-me": "0.1.1", + "colors": "~1.2.1", + "js-yaml": "4.0.0", + "resolve": "~1.17.0", + "tslib": "^2.1.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.12.24", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.24.tgz", + "integrity": "sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.36.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.36.0.tgz", + "integrity": "sha512-bID2vzXpg8zweXdXgQkKToEdZwVrVCN9vE9viTRk58gqzYaTlz4fMId6V3ZfpXN6H0d319uGi2KDlm+lUEeqCg==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + } + }, + "@rushstack/ts-command-line": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.7.8.tgz", + "integrity": "sha512-8ghIWhkph7NnLCMDJtthpsb7TMOsVGXVDvmxjE/CeklTqjbbUFBjGXizJfpbEkRQTELuZQ2+vGn7sGwIWKN2uA==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "js-yaml": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.0.0.tgz", + "integrity": "sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==", + "dev": true, + "requires": { + "argparse": "^2.0.1" + }, + "dependencies": { + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + } + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "tslib": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", + "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", + "dev": true + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, "@firebase/app-types": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.6.2.tgz", @@ -372,6 +478,132 @@ } } }, + "@microsoft/api-documenter": { + "version": "7.13.45", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.13.45.tgz", + "integrity": "sha512-ovI7Bu/WVWbX/JyxFxnVQe9eyNaxPxfIUv/t5KcNK0WDRz+xlleiE5SgrpdO8dN8YBVOsvGndv+HpGP2ceVyAA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.13.5", + "@microsoft/tsdoc": "0.13.2", + "@rushstack/node-core-library": "3.40.0", + "@rushstack/ts-command-line": "4.9.0", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.18.7", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.18.7.tgz", + "integrity": "sha512-JhtV8LoyLuIecbgCPyZQg08G1kngIRWpai2UzwNil9mGVGYiDZVeeKx8c2phmlPcogmMDm4oQROxyuiYt5sJiw==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.13.5", + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.40.0", + "@rushstack/rig-package": "0.3.0", + "@rushstack/ts-command-line": "4.9.0", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.3.5" + }, + "dependencies": { + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.13.5", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.13.5.tgz", + "integrity": "sha512-il6AebNltYo5hEtqXZw4DMvrwBPn6+F58TxwqmsLY+U+sSJNxaYn2jYksArrjErXVPR3gUgRMqD6zsdIkg+WEQ==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.40.0" + } + }, + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.15.2.tgz", + "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.13.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, "@panva/asn1.js": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@panva/asn1.js/-/asn1.js-1.0.0.tgz", @@ -452,6 +684,85 @@ "dev": true, "optional": true }, + "@rushstack/node-core-library": { + "version": "3.40.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.40.0.tgz", + "integrity": "sha512-P6uMPI7cqTdawLSPAG5BQrBu1MHlGRPqecp7ruIRgyukIEzkmh0QAnje4jAL/l1r3hw0qe4e+Dz5ZSnukT/Egg==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, + "@rushstack/rig-package": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.0.tgz", + "integrity": "sha512-Lj6noF7Q4BBm1hKiBDw94e6uZvq1xlBwM/d2cBFaPqXeGdV+G6r3qaCWfRiSXK0pcHpGGpV5Tb2MdfhVcO6G/g==", + "dev": true, + "requires": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.9.0.tgz", + "integrity": "sha512-kmT8t+JfnvphISF1C5WwY56RefjwgajhSjs9J4ckvAFXZDXR6F5cvF5/RTh7fGCzIomg8esy2PHO/b52zFoZvA==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, "@sinonjs/commons": { "version": "1.8.1", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.1.tgz", @@ -495,6 +806,12 @@ "dev": true, "optional": true }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "@types/body-parser": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", @@ -537,7 +854,6 @@ "version": "2.8.5", "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.5.tgz", "integrity": "sha512-GmK8AKu8i+s+EChK/uZ5IbrXPcPaQKWaNSGevDT/7o3gFObwSUQwqb1jMqxuo+YPvj0ckGzINI+EO7EHcmJjKg==", - "dev": true, "requires": { "@types/express": "*" } @@ -777,6 +1093,71 @@ "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", "dev": true }, + "api-extractor-model-me": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/api-extractor-model-me/-/api-extractor-model-me-0.1.1.tgz", + "integrity": "sha512-Ez801ZMADfkseOWNRFquvyQYDm3D9McpxfkKMWL6JFCGcpub0miJ+TFNphIR1nSZbrsxz3kIeOovNMY4VlL6Bw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.12.24", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.24.tgz", + "integrity": "sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.36.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.36.0.tgz", + "integrity": "sha512-bID2vzXpg8zweXdXgQkKToEdZwVrVCN9vE9viTRk58gqzYaTlz4fMId6V3ZfpXN6H0d319uGi2KDlm+lUEeqCg==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + } + }, + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, "arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -1108,6 +1489,12 @@ "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", "dev": true }, + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -1516,6 +1903,12 @@ "jest-docblock": "^21.0.0" } }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true + }, "estraverse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", @@ -1721,6 +2114,17 @@ "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=" }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -1918,8 +2322,7 @@ "version": "4.2.4", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==", - "dev": true, - "optional": true + "dev": true }, "growl": { "version": "1.10.5", @@ -2149,6 +2552,12 @@ "safer-buffer": ">= 2.1.2 < 3" } }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true + }, "imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -2194,6 +2603,15 @@ "integrity": "sha512-wliAfSzx6V+6WfMOmus1xy0XvSgf/dlStkvTfq7F0g4bOIW0PSUbnyse3NhDwdyYS1ozfUtAAySqTws3z9Eqgg==", "dev": true }, + "is-core-module": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.6.0.tgz", + "integrity": "sha512-wShG8vs60jKfPWpF2KZRaAtvt3a20OAn7+IJ6hLPECpSABLcKtFKTTI4ZtH5QcBruBHlq+WsdHWyz0BCZW7svQ==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, "is-date-object": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.2.tgz", @@ -2281,6 +2699,12 @@ "integrity": "sha512-5IZ7sY9dBAYSV+YjQ0Ovb540Ku7AO9Z5o2Cg789xj167iQuZ2cG+z0f3Uct6WeYLbU6aQiM2pCs7sZ+4dotydw==", "dev": true }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true + }, "jose": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/jose/-/jose-2.0.5.tgz", @@ -2419,6 +2843,15 @@ "minimist": "^1.2.5" } }, + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, "jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -2575,6 +3008,12 @@ "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", "dev": true }, + "lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true + }, "lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", @@ -2587,6 +3026,12 @@ "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=", "dev": true }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true + }, "lodash.isinteger": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", @@ -3615,6 +4060,15 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, "retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", @@ -3863,6 +4317,12 @@ "integrity": "sha1-gIudDlb8Jz2Am6VzOOkpkZoanxo=", "dev": true }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, "string-width": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", @@ -3972,6 +4432,12 @@ "thenify": ">= 3.1.0 < 4" } }, + "timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=", + "dev": true + }, "toidentifier": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", @@ -4218,6 +4684,12 @@ "crypto-random-string": "^2.0.0" } }, + "universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true + }, "unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -4251,6 +4723,12 @@ "dev": true, "optional": true }, + "validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "dev": true + }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -4707,6 +5185,18 @@ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "optional": true + }, + "z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + } } } } diff --git a/package.json b/package.json index dedee3974..6a44d5287 100644 --- a/package.json +++ b/package.json @@ -118,6 +118,15 @@ }, "scripts": { "apidocs": "node docgen/generate-docs.js", + + "docgen:v1:extract": "api-extractor run -c docgen/api-extractor.v1.json --local", + "docgen:v1:gen": "api-documenter-fire markdown -i docgen/v1 -o docgen/v1/markdown && api-documenter-fire toc -i docgen/v1 -o docgen/v1/markdown/toc -p /docs/reference/functions", + "docgen:v1": "npm run docgen:v1:extract && npm run docgen:v1:gen", + + "docgen:v2:extract": "api-extractor run -c docgen/api-extractor.v2.json --local", + "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown && api-documenter-fire toc -i docgen/v2 -o docgen/v2/markdown/toc -p /docs/reference/functions/v2", + "docgen:v2": "npm run docgen:v2:extract && npm run docgen:v2:gen", + "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack", "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json", "build": "tsc -p tsconfig.release.json", @@ -136,6 +145,9 @@ "lodash": "^4.17.14" }, "devDependencies": { + "@firebase/api-documenter": "^0.1.2", + "@microsoft/api-documenter": "^7.13.45", + "@microsoft/api-extractor": "^7.18.7", "@types/chai": "^4.1.7", "@types/chai-as-promised": "^7.1.0", "@types/jsonwebtoken": "^8.3.2", From 952ad2acef1128300c2f636341db56d218f2093f Mon Sep 17 00:00:00 2001 From: Daniel Young Lee Date: Fri, 1 Apr 2022 16:41:11 -0700 Subject: [PATCH 2/5] Update deps, remove generated files. --- .gitignore | 4 +- docgen/api-extractor.base.json | 2 +- docgen/v1/firebase-functions.api.json | 13215 ------------------------ docgen/v1/firebase-functions.api.md | 1080 -- docgen/v2/firebase-functions.api.json | 3668 ------- docgen/v2/firebase-functions.api.md | 329 - package-lock.json | 1101 +- package.json | 3 - 8 files changed, 1101 insertions(+), 18301 deletions(-) delete mode 100644 docgen/v1/firebase-functions.api.json delete mode 100644 docgen/v1/firebase-functions.api.md delete mode 100644 docgen/v2/firebase-functions.api.json delete mode 100644 docgen/v2/firebase-functions.api.md diff --git a/.gitignore b/.gitignore index a413de2d6..ee22dbd83 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,8 @@ coverage docgen/html docgen/*/temp docgen/*/markdown +docgen/*/*.json +docgen/*/*.md firebase-functions-*.tgz integration_test/.firebaserc integration_test/*.log @@ -16,4 +18,4 @@ node_modules npm-debug.log typings yarn.lock -.DS_Store \ No newline at end of file +.DS_Store diff --git a/docgen/api-extractor.base.json b/docgen/api-extractor.base.json index 007e0b60f..7fa698140 100644 --- a/docgen/api-extractor.base.json +++ b/docgen/api-extractor.base.json @@ -77,7 +77,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/tsconfig.json" */ - // "tsconfigFilePath": "/tsconfig.json", + "tsconfigFilePath": "/tsconfig.release.json" /** * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. * The object must conform to the TypeScript tsconfig schema: diff --git a/docgen/v1/firebase-functions.api.json b/docgen/v1/firebase-functions.api.json deleted file mode 100644 index f719b75e1..000000000 --- a/docgen/v1/firebase-functions.api.json +++ /dev/null @@ -1,13215 +0,0 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.18.7", - "schemaVersion": 1004, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - } - } - }, - "kind": "Package", - "canonicalReference": "firebase-functions!", - "docComment": "", - "name": "firebase-functions", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "firebase-functions!", - "name": "", - "members": [ - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!analytics:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "analytics", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!analytics._eventWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _eventWithOptions(analyticsEventType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "AnalyticsEventBuilder", - "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "analyticsEventType", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_eventWithOptions" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent:class", - "docComment": "/**\n * Interface representing a Firebase Analytics event that was logged for a specific user.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class AnalyticsEvent " - } - ], - "releaseTag": "Public", - "name": "AnalyticsEvent", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `AnalyticsEvent` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(wireFormat: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "wireFormat", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#logTime:member", - "docComment": "/**\n * UTC client time when the event happened.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "logTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "logTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#name:member", - "docComment": "/**\n * The name of the event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#params:member", - "docComment": "/**\n * A map of parameters and their values associated with the event.\n *\n * Note: Values in this map are cast to the most appropriate type. Due to the nature of JavaScript's number handling, this might entail a loss of precision in cases of very large integers.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "params: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: any;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "params", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#previousLogTime:member", - "docComment": "/**\n * UTC client time when the previous event happened.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "previousLogTime?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "previousLogTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#reportingDate:member", - "docComment": "/**\n * The date on which the event.was logged. (`YYYYMMDD` format in the registered timezone of your app).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "reportingDate: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "reportingDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#user:member", - "docComment": "/**\n * User-related dimensions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "user?: " - }, - { - "kind": "Reference", - "text": "UserDimensions", - "canonicalReference": "firebase-functions!UserDimensions:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "user", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.AnalyticsEvent#valueInUSD:member", - "docComment": "/**\n * Value parameter in USD.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "valueInUSD?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "valueInUSD", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder:class", - "docComment": "/**\n * The Firebase Analytics event builder interface.\n *\n * Access via [`functions.analytics.event()`](functions.analytics#.event).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class AnalyticsEventBuilder " - } - ], - "releaseTag": "Public", - "name": "AnalyticsEventBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `AnalyticsEventBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!analytics.AnalyticsEventBuilder#onLog:member(1)", - "docComment": "/**\n * Event handler that fires every time a Firebase Analytics event occurs.\n *\n * @param handler - Event handler that fires every time a Firebase Analytics event occurs.\n *\n * @return A function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onLog(handler: " - }, - { - "kind": "Content", - "text": "(event: " - }, - { - "kind": "Reference", - "text": "AnalyticsEvent", - "canonicalReference": "firebase-functions!AnalyticsEvent:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "AnalyticsEvent", - "canonicalReference": "firebase-functions!AnalyticsEvent:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onLog" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!analytics.AppInfo:interface", - "docComment": "/**\n * Interface representing the application that triggered these events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface AppInfo " - } - ], - "releaseTag": "Public", - "name": "AppInfo", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.AppInfo#appId:member", - "docComment": "/**\n * Unique application identifier within an app store.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "appId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.AppInfo#appInstanceId:member", - "docComment": "/**\n * Unique ID for this instance of the app.\n *\n * Example: \"71683BF9FA3B4B0D9535A1F05188BAF3\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appInstanceId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "appInstanceId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.AppInfo#appPlatform:member", - "docComment": "/**\n * The app platform.\n *\n * Examples: \"ANDROID\", \"IOS\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appPlatform: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "appPlatform", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.AppInfo#appStore:member", - "docComment": "/**\n * The identifier of the store that installed the app.\n *\n * Examples: \"com.sec.android.app.samsungapps\", \"com.amazon.venezia\", \"com.nokia.nstore\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appStore?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "appStore", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.AppInfo#appVersion:member", - "docComment": "/**\n * The app's version name.\n *\n * Examples: \"1.0\", \"4.3.1.1.213361\", \"2.3 (1824253)\", \"v1.8b22p6\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appVersion?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "appVersion", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!analytics.DeviceInfo:interface", - "docComment": "/**\n * Interface representing the device that triggered these Firebase Analytics events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface DeviceInfo " - } - ], - "releaseTag": "Public", - "name": "DeviceInfo", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceCategory:member", - "docComment": "/**\n * Device category.\n *\n * Examples: \"tablet\" or \"mobile\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deviceCategory?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "deviceCategory", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceId:member", - "docComment": "/**\n * Vendor specific device identifier. This is IDFV on iOS. Not used for Android.\n *\n * Example: '599F9C00-92DC-4B5C-9464-7971F01F8370'\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deviceId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "deviceId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceModel:member", - "docComment": "/**\n * Device model, as read from the OS.\n *\n * Example: \"iPhone9,1\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deviceModel?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "deviceModel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#deviceTimeZoneOffsetSeconds:member", - "docComment": "/**\n * 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 [`EventContext.timestamp`](cloud_functions_eventcontext.html#timestamp).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deviceTimeZoneOffsetSeconds: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "deviceTimeZoneOffsetSeconds", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#limitedAdTracking:member", - "docComment": "/**\n * The device's Limit Ad Tracking setting. When `true`, you cannot use `resettableDeviceId` for remarketing, demographics or influencing ads serving behaviour. However, you can use `resettableDeviceId` for conversion tracking and campaign attribution.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "limitedAdTracking: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "limitedAdTracking", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileBrandName:member", - "docComment": "/**\n * Device brand name.\n *\n * Examples: \"Samsung\", \"HTC\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mobileBrandName?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "mobileBrandName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileMarketingName:member", - "docComment": "/**\n * Device marketing name.\n *\n * Example: \"Galaxy S4 Mini\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mobileMarketingName?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "mobileMarketingName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#mobileModelName:member", - "docComment": "/**\n * Device model name in human-readable format.\n *\n * Example: \"iPhone 7\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mobileModelName?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "mobileModelName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#platformVersion:member", - "docComment": "/**\n * Device OS version when data capture ended.\n *\n * Example: \"4.4.2\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "platformVersion?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "platformVersion", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#resettableDeviceId:member", - "docComment": "/**\n * The type of the [`resettable_device_id`](https://support.google.com/dfp_premium/answer/6238701?hl=en) is IDFA on iOS (when available) and AdId on Android.\n *\n * Example: \"71683BF9-FA3B-4B0D-9535-A1F05188BAF3\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "resettableDeviceId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "resettableDeviceId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.DeviceInfo#userDefaultLanguage:member", - "docComment": "/**\n * The user language in language-country format, where language is an ISO 639 value and country is an ISO 3166 value.\n *\n * Examples: \"en-us\", \"en-za\", \"zh-tw\", \"jp\"\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "userDefaultLanguage: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "userDefaultLanguage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!analytics.event:function(1)", - "docComment": "/**\n * Registers a function to handle analytics events.\n *\n * @param analyticsEventType - Name of the analytics event type to which this Cloud Function is scoped.\n *\n * @return Analytics event builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function event(analyticsEventType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "AnalyticsEventBuilder", - "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "analyticsEventType", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "event" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!analytics.ExportBundleInfo:class", - "docComment": "/**\n * Interface representing the bundle these events were uploaded to.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ExportBundleInfo " - } - ], - "releaseTag": "Public", - "name": "ExportBundleInfo", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!analytics.ExportBundleInfo:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `ExportBundleInfo` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(wireFormat: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "wireFormat", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.ExportBundleInfo#bundleSequenceId:member", - "docComment": "/**\n * Monotonically increasing index for each bundle set by the Analytics SDK.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "bundleSequenceId: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "bundleSequenceId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.ExportBundleInfo#serverTimestampOffset:member", - "docComment": "/**\n * Timestamp offset (in milliseconds) between collection time and upload time.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "serverTimestampOffset: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "serverTimestampOffset", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!analytics.GeoInfo:interface", - "docComment": "/**\n * Interface representing the geographic origin of the events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface GeoInfo " - } - ], - "releaseTag": "Public", - "name": "GeoInfo", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.GeoInfo#city:member", - "docComment": "/**\n * The geographic city.\n *\n * Example: \"Sao Paulo\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "city?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "city", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.GeoInfo#continent:member", - "docComment": "/**\n * The geographic continent.\n *\n * Example: \"South America\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "continent?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "continent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.GeoInfo#country:member", - "docComment": "/**\n * The geographic country.\n *\n * Example: \"Brazil\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "country?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "country", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!analytics.GeoInfo#region:member", - "docComment": "/**\n * The geographic region.\n *\n * Example: \"State of Sao Paulo\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "region?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "region", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!analytics.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.analytics\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!analytics.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"app-measurement.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!analytics.UserDimensions:class", - "docComment": "/**\n * Interface representing the user who triggered the events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class UserDimensions " - } - ], - "releaseTag": "Public", - "name": "UserDimensions", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!analytics.UserDimensions:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `UserDimensions` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(wireFormat: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "wireFormat", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#appInfo:member", - "docComment": "/**\n * App information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "appInfo?: " - }, - { - "kind": "Reference", - "text": "AppInfo", - "canonicalReference": "firebase-functions!AppInfo:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "appInfo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#bundleInfo:member", - "docComment": "/**\n * Information regarding the bundle in which these events were uploaded.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "bundleInfo: " - }, - { - "kind": "Reference", - "text": "ExportBundleInfo", - "canonicalReference": "firebase-functions!ExportBundleInfo:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "bundleInfo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#deviceInfo:member", - "docComment": "/**\n * Device information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deviceInfo: " - }, - { - "kind": "Reference", - "text": "DeviceInfo", - "canonicalReference": "firebase-functions!DeviceInfo:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "deviceInfo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#firstOpenTime:member", - "docComment": "/**\n * The time (in UTC) at which the user first opened the app.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "firstOpenTime?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "firstOpenTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#geoInfo:member", - "docComment": "/**\n * User's geographic information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "geoInfo: " - }, - { - "kind": "Reference", - "text": "GeoInfo", - "canonicalReference": "firebase-functions!GeoInfo:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "geoInfo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#userId:member", - "docComment": "/**\n * The user ID set via the `setUserId` API. [Android](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#setUserId(java.lang.String)) [iOS](https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#/c:objc(cs)FIRAnalytics(cm)setUserID)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "userId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "userId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserDimensions#userProperties:member", - "docComment": "/**\n * A map of user properties set with the [`setUserProperty`](https://firebase.google.com/docs/analytics/android/properties) API.\n *\n * All values are [`UserPropertyValue`](providers_analytics_.userpropertyvalue) objects.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "userProperties: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: " - }, - { - "kind": "Reference", - "text": "UserPropertyValue", - "canonicalReference": "firebase-functions!UserPropertyValue:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "userProperties", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!analytics.UserPropertyValue:class", - "docComment": "/**\n * Predefined or custom properties stored on the client side.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class UserPropertyValue " - } - ], - "releaseTag": "Public", - "name": "UserPropertyValue", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!analytics.UserPropertyValue:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `UserPropertyValue` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(wireFormat: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "wireFormat", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserPropertyValue#setTime:member", - "docComment": "/**\n * UTC client time when the user property was last set.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "setTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!analytics.UserPropertyValue#value:member", - "docComment": "/**\n * The last set value of a user property.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "value: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "value", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!app:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "app: " - }, - { - "kind": "Content", - "text": "apps." - }, - { - "kind": "Reference", - "text": "apps.Apps", - "canonicalReference": "firebase-functions!apps.Apps:class" - } - ], - "releaseTag": "Public", - "name": "app", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!auth:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "auth", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!auth._userWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _userWithOptions(options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "UserBuilder", - "canonicalReference": "firebase-functions!UserBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "_userWithOptions" - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!auth.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.firebase.auth\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!auth.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"firebaseauth.googleapis.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!auth.user:function(1)", - "docComment": "/**\n * Handle events related to Firebase authentication users.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function user(): " - }, - { - "kind": "Reference", - "text": "UserBuilder", - "canonicalReference": "firebase-functions!UserBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "user" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!auth.UserBuilder:class", - "docComment": "/**\n * Builder used to create Cloud Functions for Firebase Auth user lifecycle events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class UserBuilder " - } - ], - "releaseTag": "Public", - "name": "UserBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!auth.UserBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `UserBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!auth.UserBuilder#onCreate:member(1)", - "docComment": "/**\n * Respond to the creation of a Firebase Auth user.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onCreate(handler: " - }, - { - "kind": "Content", - "text": "(user: " - }, - { - "kind": "Reference", - "text": "UserRecord", - "canonicalReference": "firebase-functions!UserRecord:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UserRecord", - "canonicalReference": "firebase-functions!UserRecord:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onCreate" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!auth.UserBuilder#onDelete:member(1)", - "docComment": "/**\n * Respond to the deletion of a Firebase Auth user.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onDelete(handler: " - }, - { - "kind": "Content", - "text": "(user: " - }, - { - "kind": "Reference", - "text": "UserRecord", - "canonicalReference": "firebase-functions!UserRecord:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UserRecord", - "canonicalReference": "firebase-functions!UserRecord:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onDelete" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!auth.UserInfo:type", - "docComment": "/**\n * UserInfo that is part of the UserRecord\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserInfo = " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "auth.UserInfo", - "canonicalReference": "firebase-admin!auth.UserInfo:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "UserInfo", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!auth.UserRecord:type", - "docComment": "/**\n * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin SDK.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserRecord = " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "auth.UserRecord", - "canonicalReference": "firebase-admin!auth.UserRecord:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "UserRecord", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!auth.userRecordConstructor:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function userRecordConstructor(wireData: " - }, - { - "kind": "Reference", - "text": "Object", - "canonicalReference": "!Object:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "auth.UserRecord", - "canonicalReference": "firebase-admin!auth.UserRecord:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "wireData", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "userRecordConstructor" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!auth.UserRecordMetadata:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class UserRecordMetadata implements " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "auth.UserMetadata", - "canonicalReference": "firebase-admin!auth.UserMetadata:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "UserRecordMetadata", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!auth.UserRecordMetadata:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `UserRecordMetadata` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(creationTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", lastSignInTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "creationTime", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "lastSignInTime", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!auth.UserRecordMetadata#creationTime:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "creationTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "creationTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!auth.UserRecordMetadata#lastSignInTime:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "lastSignInTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "lastSignInTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!auth.UserRecordMetadata#toJSON:member(1)", - "docComment": "/**\n * Returns a plain JavaScript object with the properties of UserRecordMetadata.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Content", - "text": "{\n creationTime: string;\n lastSignInTime: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 4 - } - ] - } - ] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!Change:class", - "docComment": "/**\n * The Functions interface for events that change state, such as Realtime Database or Cloud Firestore `onWrite` and `onUpdate`.\n *\n * For more information about the format used to construct `Change` objects, see [`cloud-functions.ChangeJson`](/docs/reference/functions/cloud_functions_.changejson).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Change " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "Change", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!Change:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Change` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(before: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ", after: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "before", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "after", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!Change#after:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "after: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "after", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!Change#before:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "before: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "before", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!Change:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare namespace Change " - } - ], - "releaseTag": "Public", - "name": "Change", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!Change.applyFieldMask:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "function applyFieldMask(sparseBefore: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ", after: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ", fieldMask: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "sparseBefore", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "after", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "fieldMask", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ], - "name": "applyFieldMask" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!Change.fromJSON:function(1)", - "docComment": "/**\n * @hidden Factory method for creating a Change from a JSON and an optional customizer function to be applied to both the `before` and the `after` fields.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "function fromJSON(json: " - }, - { - "kind": "Reference", - "text": "ChangeJson", - "canonicalReference": "firebase-functions!ChangeJson:interface" - }, - { - "kind": "Content", - "text": ", customizer?: " - }, - { - "kind": "Content", - "text": "(x: any) => T" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "json", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "customizer", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "fromJSON" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!Change.fromObjects:function(1)", - "docComment": "/**\n * @hidden Factory method for creating a Change from a `before` object and an `after` object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "function fromObjects(before: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ", after: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "before", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "after", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "fromObjects" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!ChangeJson:interface", - "docComment": "/**\n * `ChangeJson` is the JSON format used to construct a Change object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ChangeJson " - } - ], - "releaseTag": "Public", - "name": "ChangeJson", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ChangeJson#after:member", - "docComment": "/**\n * Key-value pairs representing state of data after the change.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "after?: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "after", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ChangeJson#before:member", - "docComment": "/**\n * Key-value pairs representing state of data before the change. If `fieldMask` is set, then only fields that changed are present in `before`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "before?: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "before", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ChangeJson#fieldMask:member", - "docComment": "/**\n * @hidden Comma-separated string that represents names of fields that changed.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "fieldMask?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "fieldMask", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!CloudFunction:type", - "docComment": "/**\n * The Cloud Function type for all non-HTTPS triggers. This should be exported from your JavaScript file to define a Cloud Function.\n *\n * This type is a special JavaScript function which takes a templated `Event` object as its only argument.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type CloudFunction = " - }, - { - "kind": "Reference", - "text": "Runnable", - "canonicalReference": "firebase-functions!Runnable:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "TriggerAnnotated", - "canonicalReference": "firebase-functions!TriggerAnnotated:interface" - }, - { - "kind": "Content", - "text": " & ((input: any, context?: any) => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any)" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "CloudFunction", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!config:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function config(): " - }, - { - "kind": "Reference", - "text": "config.Config", - "canonicalReference": "firebase-functions!config.Config:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "config" - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!config:namespace", - "docComment": "/**\n * 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).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare namespace config " - } - ], - "releaseTag": "Public", - "name": "config", - "members": [ - { - "kind": "Interface", - "canonicalReference": "firebase-functions!config.Config:interface", - "docComment": "/**\n * The Functions configuration interface.\n *\n * Access via `functions.config()`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Config " - } - ], - "releaseTag": "Public", - "name": "Config", - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "firebase-functions!config.Config:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!config.singleton:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "singleton: " - }, - { - "kind": "Reference", - "text": "config.Config", - "canonicalReference": "firebase-functions!config.Config:interface" - } - ], - "releaseTag": "Public", - "name": "singleton", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!database:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "database", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!database._instanceWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _instanceWithOptions(instance: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "InstanceBuilder", - "canonicalReference": "firebase-functions!InstanceBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "instance", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_instanceWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!database._refWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _refWithOptions(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "RefBuilder", - "canonicalReference": "firebase-functions!RefBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_refWithOptions" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!database.DataSnapshot:class", - "docComment": "/**\n * Interface representing a Firebase Realtime Database data snapshot.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class DataSnapshot " - } - ], - "releaseTag": "Public", - "name": "DataSnapshot", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!database.DataSnapshot:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `DataSnapshot` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(data: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ", path?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", // path will be undefined for the database root\n app?: " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "app.App", - "canonicalReference": "firebase-admin!app.App:interface" - }, - { - "kind": "Content", - "text": ", instance?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "app", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - } - }, - { - "parameterName": "instance", - "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#child:member(1)", - "docComment": "/**\n * Gets a `DataSnapshot` for the location at the specified relative path.\n *\n * The relative path can either be a simple child name (for example, \"ada\") or a deeper slash-separated path (for example, \"ada/name/first\").\n *\n * @param path - A relative path from this location to the desired child location. @return The specified child location.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "child(childPath: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "childPath", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "child" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#exists:member(1)", - "docComment": "/**\n * Returns `true` if this `DataSnapshot` contains any data. It is slightly more efficient than using `snapshot.val() !== null`.\n *\n * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "exists(): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "exists" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#exportVal:member(1)", - "docComment": "/**\n * Exports the entire contents of the `DataSnapshot` as a JavaScript object.\n *\n * The `exportVal()` method is similar to `val()`, except priority information is included (if available), making it suitable for backing up your data.\n *\n * @return The contents of the `DataSnapshot` as a JavaScript value (Object, Array, string, number, boolean, or `null`).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "exportVal(): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "exportVal" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#forEach:member(1)", - "docComment": "/**\n * Enumerates the `DataSnapshot`s of the children items.\n *\n * Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by `val()` is not guaranteed to match the ordering on the server nor the ordering of `child_added` events. That is where `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` will be iterated in their query order.\n *\n * If no explicit `orderBy*()` method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority).\n *\n * @param action - A function that will be called for each child `DataSnapshot`. The callback can return `true` to cancel further enumeration.\n *\n * @return `true` if enumeration was canceled due to your callback returning `true`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forEach(action: " - }, - { - "kind": "Content", - "text": "(a: " - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ") => boolean | void" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "action", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - } - ], - "name": "forEach" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#getPriority:member(1)", - "docComment": "/**\n * Gets the priority value of the data in this `DataSnapshot`.\n *\n * As an alternative to using priority, applications can order collections by ordinary properties. See [Sorting and filtering data](/docs/database/web/lists-of-data#sorting_and_filtering_data).\n *\n * @return The priority value of the data.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getPriority(): " - }, - { - "kind": "Content", - "text": "string | number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getPriority" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#hasChild:member(1)", - "docComment": "/**\n * Returns `true` if the specified child path has (non-`null`) data.\n *\n * @param path - A relative path to the location of a potential child. @return `true` if data exists at the specified child path; otherwise, `false`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hasChild(childPath: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "childPath", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "hasChild" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#hasChildren:member(1)", - "docComment": "/**\n * Returns whether or not the `DataSnapshot` has any non-`null` child properties.\n *\n * You can use `hasChildren()` to determine if a `DataSnapshot` has any children. If it does, you can enumerate them using `forEach()`. If it doesn't, then either this snapshot contains a primitive value (which can be retrieved with `val()`) or it is empty (in which case, `val()` will return `null`).\n *\n * @return `true` if this snapshot has any children; else `false`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hasChildren(): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "hasChildren" - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!database.DataSnapshot#instance:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "instance: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "instance", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!database.DataSnapshot#key:member", - "docComment": "/**\n * The key (last part of the path) of the location of this `DataSnapshot`.\n *\n * The last token in a Database location is considered its key. For example, \"ada\" is the key for the `/users/ada/` node. Accessing the key on any `DataSnapshot` will return the key for the location that generated it. However, accessing the key on the root URL of a Database will return `null`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "get key(): " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "key", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#numChildren:member(1)", - "docComment": "/**\n * Returns the number of child properties of this `DataSnapshot`.\n *\n * @return Number of child properties of this `DataSnapshot`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "numChildren(): " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "numChildren" - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!database.DataSnapshot#ref:member", - "docComment": "/**\n * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference) to the Database location where the triggering write occurred. Has full read and write access.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "get ref(): " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "database.Reference", - "canonicalReference": "@firebase/database-types!Reference:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "ref", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#toJSON:member(1)", - "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Reference", - "text": "Object", - "canonicalReference": "!Object:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.DataSnapshot#val:member(1)", - "docComment": "/**\n * Extracts a JavaScript value from a `DataSnapshot`.\n *\n * Depending on the data in a `DataSnapshot`, the `val()` method may return a scalar type (string, number, or boolean), an array, or an object. It may also return `null`, indicating that the `DataSnapshot` is empty (contains no data).\n *\n * @return The DataSnapshot's contents as a JavaScript value (Object, Array, string, number, boolean, or `null`).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "val(): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "val" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!database.extractInstanceAndPath:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function extractInstanceAndPath(resource: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", domain?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "resource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "domain", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "extractInstanceAndPath" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!database.instance:function(1)", - "docComment": "/**\n * Registers a function that triggers on events from a specific Firebase Realtime Database instance.\n *\n * Use this method together with `ref` to specify the instance on which to watch for database events. For example: `firebase.database.instance('my-app-db-2').ref('/foo/bar')`\n *\n * Note that `functions.database.ref` used without `instance` watches the *default* instance for events.\n *\n * @param instance - The instance name of the database instance to watch for write events. @return Firebase Realtime Database instance builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function instance(instance: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "InstanceBuilder", - "canonicalReference": "firebase-functions!InstanceBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "instance", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "instance" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!database.InstanceBuilder:class", - "docComment": "/**\n * The Firebase Realtime Database instance builder interface.\n *\n * Access via [`database.instance()`](providers_database_.html#instance).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class InstanceBuilder " - } - ], - "releaseTag": "Public", - "name": "InstanceBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!database.InstanceBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `InstanceBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(instance: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "instance", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.InstanceBuilder#ref:member(1)", - "docComment": "/**\n * @return Firebase Realtime Database reference builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ref(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "RefBuilder", - "canonicalReference": "firebase-functions!RefBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "ref" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!database.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.firebase.database\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!database.ref:function(1)", - "docComment": "/**\n * Registers a function that triggers on Firebase Realtime Database write events.\n *\n * This method behaves very similarly to the method of the same name in the client and Admin Firebase SDKs. Any change to the Database that affects the data at or below the provided `path` will fire an event in Cloud Functions.\n *\n * There are three important differences between listening to a Realtime Database event in Cloud Functions and using the Realtime Database in the client and Admin SDKs: 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 [`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\"`, respectively. 2. Cloud Functions do not fire an event for data that already existed before the Cloud Function was deployed. 3. Cloud Function events have access to more information, including a snapshot of the previous event data and information about the user who triggered the Cloud Function.\n *\n * @param path - The path within the Database to watch for write events. @return Firebase Realtime Database builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function ref(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "RefBuilder", - "canonicalReference": "firebase-functions!RefBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "ref" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!database.RefBuilder:class", - "docComment": "/**\n * The Firebase Realtime Database reference builder interface.\n *\n * Access via [`functions.database.ref()`](functions.database#.ref).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class RefBuilder " - } - ], - "releaseTag": "Public", - "name": "RefBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!database.RefBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `RefBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(apps: " - }, - { - "kind": "Reference", - "text": "apps.Apps", - "canonicalReference": "firebase-functions!apps.Apps:class" - }, - { - "kind": "Content", - "text": ", triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "apps", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.RefBuilder#onCreate:member(1)", - "docComment": "/**\n * Event handler that fires every time new data is created in Firebase Realtime Database.\n *\n * @param handler - Event handler that runs every time new data is created in Firebase Realtime Database. @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onCreate(handler: " - }, - { - "kind": "Content", - "text": "(snapshot: " - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onCreate" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.RefBuilder#onDelete:member(1)", - "docComment": "/**\n * Event handler that fires every time data is deleted from Firebase Realtime Database.\n *\n * @param handler - Event handler that runs every time data is deleted from Firebase Realtime Database. @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onDelete(handler: " - }, - { - "kind": "Content", - "text": "(snapshot: " - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onDelete" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.RefBuilder#onUpdate:member(1)", - "docComment": "/**\n * Event handler that fires every time data is updated in Firebase Realtime Database.\n *\n * @param handler - Event handler which is run every time a Firebase Realtime Database write occurs. @return A Cloud Function which you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onUpdate(handler: " - }, - { - "kind": "Content", - "text": "(change: " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">, context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - } - ], - "name": "onUpdate" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!database.RefBuilder#onWrite:member(1)", - "docComment": "/**\n * Event handler that fires every time a Firebase Realtime Database write of any kind (creation, update, or delete) occurs.\n *\n * @param handler - Event handler that runs every time a Firebase Realtime Database write occurs. @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onWrite(handler: " - }, - { - "kind": "Content", - "text": "(change: " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">, context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DataSnapshot", - "canonicalReference": "firebase-functions!DataSnapshot:class" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - } - ], - "name": "onWrite" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!database.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"firebaseio.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!DEFAULT_FAILURE_POLICY:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DEFAULT_FAILURE_POLICY: " - }, - { - "kind": "Reference", - "text": "FailurePolicy", - "canonicalReference": "firebase-functions!FailurePolicy:interface" - } - ], - "releaseTag": "Public", - "name": "DEFAULT_FAILURE_POLICY", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!DeploymentOptions:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface DeploymentOptions extends " - }, - { - "kind": "Reference", - "text": "RuntimeOptions", - "canonicalReference": "firebase-functions!RuntimeOptions:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "DeploymentOptions", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!DeploymentOptions#regions:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "regions?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "regions", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!DeploymentOptions#schedule:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "schedule?: " - }, - { - "kind": "Reference", - "text": "Schedule", - "canonicalReference": "firebase-functions!Schedule:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "schedule", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!Event:interface", - "docComment": "/**\n * @hidden\n *\n * Wire format for an event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Event " - } - ], - "releaseTag": "Public", - "name": "Event", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Event#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context: " - }, - { - "kind": "Content", - "text": "{\n eventId: string;\n timestamp: string;\n eventType: string;\n resource: " - }, - { - "kind": "Reference", - "text": "Resource", - "canonicalReference": "firebase-functions!Resource:interface" - }, - { - "kind": "Content", - "text": ";\n domain?: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Event#data:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "data: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!EventContext:interface", - "docComment": "/**\n * The context in which an event occurred.\n *\n * An EventContext describes: - The time an event occurred. - A unique identifier of the event. - The resource on which the event occurred, if applicable. - Authorization of the request that triggered the event, if applicable and available.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface EventContext " - } - ], - "releaseTag": "Public", - "name": "EventContext", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#auth:member", - "docComment": "/**\n * Authentication information for the user that triggered the function. This object contains `uid` and `token` properties for authenticated users. For more detail including token keys, see the [security rules reference](/docs/firestore/reference/security/#properties).\n *\n * This field is only populated for Realtime Database triggers and Callable functions. For an unauthenticated user, this field is null. For Firebase admin users and event types that do not provide user information, this field does not exist.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "auth?: " - }, - { - "kind": "Content", - "text": "{\n token: object;\n uid: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "auth", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#authType:member", - "docComment": "/**\n * The level of permissions for a user. Valid values are:\n *\n * * `ADMIN` Developer user or user authenticated via a service account. * `USER` Known user. * `UNAUTHENTICATED` Unauthenticated action * `null` For event types that do not provide user information (all except Realtime Database).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "authType?: " - }, - { - "kind": "Content", - "text": "'ADMIN' | 'USER' | 'UNAUTHENTICATED'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "authType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#eventId:member", - "docComment": "/**\n * The event’s unique identifier.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "eventId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "eventId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#eventType:member", - "docComment": "/**\n * Type of event. Possible values are:\n *\n * * `google.analytics.event.log` * `google.firebase.auth.user.create` * `google.firebase.auth.user.delete` * `google.firebase.database.ref.write` * `google.firebase.database.ref.create` * `google.firebase.database.ref.update` * `google.firebase.database.ref.delete` * `google.firestore.document.write` * `google.firestore.document.create` * `google.firestore.document.update` * `google.firestore.document.delete` * `google.pubsub.topic.publish` * `google.firebase.remoteconfig.update` * `google.storage.object.finalize` * `google.storage.object.archive` * `google.storage.object.delete` * `google.storage.object.metadataUpdate` * `google.testing.testMatrix.complete`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "eventType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "eventType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#params:member", - "docComment": "/**\n * An object containing the values of the wildcards in the `path` parameter provided to the [`ref()`](providers_database_.html#ref) method for a Realtime Database trigger. Cannot be accessed while inside the handler namespace.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "params: " - }, - { - "kind": "Content", - "text": "{\n [option: string]: any;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "params", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#resource:member", - "docComment": "/**\n * The resource that emitted the event. Valid values are:\n *\n * * Analytics — `projects//events/` * Realtime Database — `projects/_/instances//refs/` * Storage — `projects/_/buckets//objects/#` * Authentication — `projects/` * Pub/Sub — `projects//topics/`\n *\n * Because Realtime Database instances and Cloud Storage buckets are globally unique and not tied to the project, their resources start with `projects/_`. Underscore is not a valid project name.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "resource: " - }, - { - "kind": "Reference", - "text": "Resource", - "canonicalReference": "firebase-functions!Resource:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "resource", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!EventContext#timestamp:member", - "docComment": "/**\n * Timestamp for the event as an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) string.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timestamp: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "timestamp", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!FailurePolicy:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface FailurePolicy " - } - ], - "releaseTag": "Public", - "name": "FailurePolicy", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!FailurePolicy#retry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "retry: " - }, - { - "kind": "Content", - "text": "{}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "retry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firebaseConfig:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function firebaseConfig(): " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "AppOptions", - "canonicalReference": "firebase-admin!AppOptions:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "firebaseConfig" - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!firebaseConfigCache:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "firebaseConfigCache: " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "AppOptions", - "canonicalReference": "firebase-admin!AppOptions:interface" - }, - { - "kind": "Content", - "text": " | null" - } - ], - "releaseTag": "Public", - "name": "firebaseConfigCache", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!firestore:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "firestore", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore._databaseWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _databaseWithOptions(database: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DatabaseBuilder", - "canonicalReference": "firebase-functions!DatabaseBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "database", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_databaseWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore._documentWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _documentWithOptions(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentBuilder", - "canonicalReference": "firebase-functions!DocumentBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_documentWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore._namespaceWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _namespaceWithOptions(namespace: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NamespaceBuilder", - "canonicalReference": "firebase-functions!NamespaceBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "namespace", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_namespaceWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore.beforeSnapshotConstructor:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function beforeSnapshotConstructor(event: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "firebase-functions!Event:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentSnapshot", - "canonicalReference": "firebase-functions!DocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "event", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "beforeSnapshotConstructor" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore.database:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function database(database: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DatabaseBuilder", - "canonicalReference": "firebase-functions!DatabaseBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "database", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "database" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!firestore.DatabaseBuilder:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class DatabaseBuilder " - } - ], - "releaseTag": "Public", - "name": "DatabaseBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!firestore.DatabaseBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `DatabaseBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(database: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "database", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DatabaseBuilder#document:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "document(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentBuilder", - "canonicalReference": "firebase-functions!DocumentBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "document" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DatabaseBuilder#namespace:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "namespace(namespace: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NamespaceBuilder", - "canonicalReference": "firebase-functions!NamespaceBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "namespace", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "namespace" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!firestore.defaultDatabase:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "defaultDatabase = \"(default)\"" - } - ], - "releaseTag": "Public", - "name": "defaultDatabase", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore.document:function(1)", - "docComment": "/**\n * Select the Firestore document to listen to for events.\n *\n * @param path - Full database path to listen to. This includes the name of the collection that the document is a part of. For example, if the collection is named \"users\" and the document is named \"Ada\", then the path is \"/users/Ada\".\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function document(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentBuilder", - "canonicalReference": "firebase-functions!DocumentBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "document" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class DocumentBuilder " - } - ], - "releaseTag": "Public", - "name": "DocumentBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `DocumentBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onCreate:member(1)", - "docComment": "/**\n * Respond only to document creations.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onCreate(handler: " - }, - { - "kind": "Content", - "text": "(snapshot: " - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onCreate" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onDelete:member(1)", - "docComment": "/**\n * Respond only to document deletions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onDelete(handler: " - }, - { - "kind": "Content", - "text": "(snapshot: " - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onDelete" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onUpdate:member(1)", - "docComment": "/**\n * Respond only to document updates.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onUpdate(handler: " - }, - { - "kind": "Content", - "text": "(change: " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">, context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "QueryDocumentSnapshot", - "canonicalReference": "firebase-functions!QueryDocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - } - ], - "name": "onUpdate" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.DocumentBuilder#onWrite:member(1)", - "docComment": "/**\n * Respond to all document writes (creates, updates, or deletes).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onWrite(handler: " - }, - { - "kind": "Content", - "text": "(change: " - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DocumentSnapshot", - "canonicalReference": "firebase-functions!DocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">, context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Change", - "canonicalReference": "firebase-functions!Change:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DocumentSnapshot", - "canonicalReference": "firebase-functions!DocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - } - ], - "name": "onWrite" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!firestore.DocumentSnapshot:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type DocumentSnapshot = " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "firestore.DocumentSnapshot", - "canonicalReference": "!FirebaseFirestore.DocumentSnapshot:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "DocumentSnapshot", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore.namespace:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function namespace(namespace: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NamespaceBuilder", - "canonicalReference": "firebase-functions!NamespaceBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "namespace", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "namespace" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!firestore.NamespaceBuilder:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class NamespaceBuilder " - } - ], - "releaseTag": "Public", - "name": "NamespaceBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!firestore.NamespaceBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `NamespaceBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(database: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ", namespace?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "database", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "namespace", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!firestore.NamespaceBuilder#document:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "document(path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentBuilder", - "canonicalReference": "firebase-functions!DocumentBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "document" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!firestore.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.firestore\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!firestore.QueryDocumentSnapshot:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type QueryDocumentSnapshot = " - }, - { - "kind": "Content", - "text": "firebase." - }, - { - "kind": "Reference", - "text": "firestore.QueryDocumentSnapshot", - "canonicalReference": "!FirebaseFirestore.QueryDocumentSnapshot:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "QueryDocumentSnapshot", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!firestore.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"firestore.googleapis.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!firestore.snapshotConstructor:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function snapshotConstructor(event: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "firebase-functions!Event:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "DocumentSnapshot", - "canonicalReference": "firebase-functions!DocumentSnapshot:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "event", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "snapshotConstructor" - } - ] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!FunctionBuilder:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class FunctionBuilder " - } - ], - "releaseTag": "Public", - "name": "FunctionBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!FunctionBuilder:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `FunctionBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#analytics:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get analytics(): " - }, - { - "kind": "Content", - "text": "{\n event: (analyticsEventType: string) => analytics." - }, - { - "kind": "Reference", - "text": "AnalyticsEventBuilder", - "canonicalReference": "firebase-functions!AnalyticsEventBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "analytics", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#auth:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get auth(): " - }, - { - "kind": "Content", - "text": "{\n user: () => auth." - }, - { - "kind": "Reference", - "text": "UserBuilder", - "canonicalReference": "firebase-functions!UserBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "auth", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#database:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get database(): " - }, - { - "kind": "Content", - "text": "{\n instance: (instance: string) => database." - }, - { - "kind": "Reference", - "text": "InstanceBuilder", - "canonicalReference": "firebase-functions!InstanceBuilder:class" - }, - { - "kind": "Content", - "text": ";\n ref: (path: string) => database." - }, - { - "kind": "Reference", - "text": "RefBuilder", - "canonicalReference": "firebase-functions!RefBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "database", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#firestore:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get firestore(): " - }, - { - "kind": "Content", - "text": "{\n document: (path: string) => firestore." - }, - { - "kind": "Reference", - "text": "DocumentBuilder", - "canonicalReference": "firebase-functions!DocumentBuilder:class" - }, - { - "kind": "Content", - "text": ";\n namespace: (namespace: string) => firestore." - }, - { - "kind": "Reference", - "text": "NamespaceBuilder", - "canonicalReference": "firebase-functions!NamespaceBuilder:class" - }, - { - "kind": "Content", - "text": ";\n database: (database: string) => firestore." - }, - { - "kind": "Reference", - "text": "DatabaseBuilder", - "canonicalReference": "firebase-functions!DatabaseBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "firestore", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#https:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get https(): " - }, - { - "kind": "Content", - "text": "{\n onRequest: (handler: (req: https." - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", resp: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ") => import(\"./cloud-functions\")." - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": ";\n onCall: (handler: (data: any, context: https." - }, - { - "kind": "Reference", - "text": "CallableContext", - "canonicalReference": "firebase-functions!CallableContext:interface" - }, - { - "kind": "Content", - "text": ") => any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ") => import(\"./cloud-functions\")." - }, - { - "kind": "Reference", - "text": "TriggerAnnotated", - "canonicalReference": "firebase-functions!TriggerAnnotated:interface" - }, - { - "kind": "Content", - "text": " & ((req: " - }, - { - "kind": "Reference", - "text": "express.Request", - "canonicalReference": "@types/express!~e.Request:interface" - }, - { - "kind": "Content", - "text": ", resp: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ") & import(\"./cloud-functions\")." - }, - { - "kind": "Reference", - "text": "Runnable", - "canonicalReference": "firebase-functions!Runnable:interface" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "https", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 26 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#pubsub:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get pubsub(): " - }, - { - "kind": "Content", - "text": "{\n topic: (topic: string) => pubsub." - }, - { - "kind": "Reference", - "text": "TopicBuilder", - "canonicalReference": "firebase-functions!TopicBuilder:class" - }, - { - "kind": "Content", - "text": ";\n schedule: (schedule: string) => pubsub." - }, - { - "kind": "Reference", - "text": "ScheduleBuilder", - "canonicalReference": "firebase-functions!ScheduleBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "pubsub", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!FunctionBuilder#region:member(1)", - "docComment": "/**\n * Configure the regions that the function is deployed to.\n *\n * @param regions - One or more region strings.\n *\n * @example\n *\n * functions.region('us-east1')\n *\n * @example\n *\n * functions.region('us-east1', 'us-central1')\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "region(...regions: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "FunctionBuilder", - "canonicalReference": "firebase-functions!FunctionBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "regions", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "name": "region" - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#remoteConfig:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get remoteConfig(): " - }, - { - "kind": "Content", - "text": "{\n onUpdate: (handler: (version: remoteConfig." - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any) => " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "remoteConfig", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 12 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!FunctionBuilder#runWith:member(1)", - "docComment": "/**\n * Configure runtime options for the function.\n *\n * @param runtimeOptions - Object with optional fields: 1. `memory`: amount of memory to allocate to the function, possible values are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'. 2. `timeoutSeconds`: timeout for the function in seconds, possible values are 0 to 540. 3. `failurePolicy`: failure policy of the function, with boolean `true` being equivalent to providing an empty retry object. 4. `vpcConnector`: id of a VPC connector in the same project and region 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which egress traffic is sent through the `vpcConnector`.\n *\n * Value must not be null.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "runWith(runtimeOptions: " - }, - { - "kind": "Reference", - "text": "RuntimeOptions", - "canonicalReference": "firebase-functions!RuntimeOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "FunctionBuilder", - "canonicalReference": "firebase-functions!FunctionBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "runtimeOptions", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "runWith" - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#storage:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get storage(): " - }, - { - "kind": "Content", - "text": "{\n bucket: (bucket?: string) => storage." - }, - { - "kind": "Reference", - "text": "BucketBuilder", - "canonicalReference": "firebase-functions!BucketBuilder:class" - }, - { - "kind": "Content", - "text": ";\n object: () => storage." - }, - { - "kind": "Reference", - "text": "ObjectBuilder", - "canonicalReference": "firebase-functions!ObjectBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "storage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!FunctionBuilder#testLab:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get testLab(): " - }, - { - "kind": "Content", - "text": "{\n testMatrix: () => testLab." - }, - { - "kind": "Reference", - "text": "TestMatrixBuilder", - "canonicalReference": "firebase-functions!TestMatrixBuilder:class" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "testLab", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!handler:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handler: " - }, - { - "kind": "Reference", - "text": "HandlerBuilder", - "canonicalReference": "firebase-functions!HandlerBuilder:class" - } - ], - "releaseTag": "Public", - "name": "handler", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!https:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "https", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!https._onCallWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _onCallWithOptions(handler: " - }, - { - "kind": "Content", - "text": "(data: any, context: " - }, - { - "kind": "Reference", - "text": "CallableContext", - "canonicalReference": "firebase-functions!CallableContext:interface" - }, - { - "kind": "Content", - "text": ") => any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "Runnable", - "canonicalReference": "firebase-functions!Runnable:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - } - } - ], - "name": "_onCallWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https._onRequestWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _onRequestWithOptions(handler: " - }, - { - "kind": "Content", - "text": "(req: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", resp: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - } - } - ], - "name": "_onRequestWithOptions" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.CallableContext:interface", - "docComment": "/**\n * The interface for metadata for the API as passed to the handler.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CallableContext " - } - ], - "releaseTag": "Public", - "name": "CallableContext", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableContext#app:member", - "docComment": "/**\n * The result of decoding and verifying a Firebase AppCheck token.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "app?: " - }, - { - "kind": "Reference", - "text": "AppCheckData", - "canonicalReference": "firebase-functions!AppCheckData:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "app", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableContext#auth:member", - "docComment": "/**\n * The result of decoding and verifying a Firebase Auth ID token.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "auth?: " - }, - { - "kind": "Reference", - "text": "AuthData", - "canonicalReference": "firebase-functions!AuthData:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "auth", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableContext#instanceIdToken:member", - "docComment": "/**\n * An unverified token for a Firebase Instance ID.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "instanceIdToken?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "instanceIdToken", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableContext#rawRequest:member", - "docComment": "/**\n * The raw request handled by the callable.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "rawRequest: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "rawRequest", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!https.FunctionsErrorCode:type", - "docComment": "/**\n * The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md\n *\n * Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FunctionsErrorCode = " - }, - { - "kind": "Content", - "text": "'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FunctionsErrorCode", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!https.HttpsError:class", - "docComment": "/**\n * An explicit error that can be thrown from a handler to send an error to the client that called the function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class HttpsError extends " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "HttpsError", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!https.HttpsError:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `HttpsError` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(code: " - }, - { - "kind": "Reference", - "text": "FunctionsErrorCode", - "canonicalReference": "firebase-functions!FunctionsErrorCode:type" - }, - { - "kind": "Content", - "text": ", message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", details?: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "code", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "details", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#code:member", - "docComment": "/**\n * A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly code: " - }, - { - "kind": "Reference", - "text": "FunctionsErrorCode", - "canonicalReference": "firebase-functions!FunctionsErrorCode:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "code", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#details:member", - "docComment": "/**\n * Extra data to be converted to JSON and included in the error response.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly details: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "details", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#httpErrorCode:member", - "docComment": "/**\n * A wire format representation of a provided error code.\n *\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly httpErrorCode: " - }, - { - "kind": "Reference", - "text": "HttpErrorCode", - "canonicalReference": "firebase-functions!~HttpErrorCode:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "httpErrorCode", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!https.HttpsError#toJSON:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Reference", - "text": "HttpErrorWireFormat", - "canonicalReference": "firebase-functions!~HttpErrorWireFormat:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onCall:function(1)", - "docComment": "/**\n * Declares a callable method for clients to call using a Firebase SDK.\n *\n * @param handler - A method that takes a data and context and returns a value.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onCall(handler: " - }, - { - "kind": "Content", - "text": "(data: any, context: " - }, - { - "kind": "Reference", - "text": "CallableContext", - "canonicalReference": "firebase-functions!CallableContext:interface" - }, - { - "kind": "Content", - "text": ") => any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "Runnable", - "canonicalReference": "firebase-functions!Runnable:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - } - ], - "name": "onCall" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onRequest:function(1)", - "docComment": "/**\n * Handle HTTP requests.\n *\n * @param handler - A function that takes a request and response object, same signature as an Express app.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onRequest(handler: " - }, - { - "kind": "Content", - "text": "(req: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", resp: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onRequest" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.Request:interface", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Request extends " - }, - { - "kind": "Reference", - "text": "express.Request", - "canonicalReference": "@types/express!~e.Request:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Request", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.Request#rawBody:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "rawBody: " - }, - { - "kind": "Reference", - "text": "Buffer", - "canonicalReference": "!Buffer:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "rawBody", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!HttpsFunction:type", - "docComment": "/**\n * The Cloud Function type for HTTPS triggers. This should be exported from your JavaScript file to define a Cloud Function.\n *\n * This type is a special JavaScript function which takes Express [`Request`](https://expressjs.com/en/api.html#req) and [`Response`](https://expressjs.com/en/api.html#res) objects as its only arguments.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type HttpsFunction = " - }, - { - "kind": "Reference", - "text": "TriggerAnnotated", - "canonicalReference": "firebase-functions!TriggerAnnotated:interface" - }, - { - "kind": "Content", - "text": " & ((req: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "@types/express!~e.Request:interface" - }, - { - "kind": "Content", - "text": ", resp: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ")" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "HttpsFunction", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 9 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!INGRESS_SETTINGS_OPTIONS:var", - "docComment": "/**\n * List of available options for IngressSettings.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "INGRESS_SETTINGS_OPTIONS: " - }, - { - "kind": "Content", - "text": "readonly [\"INGRESS_SETTINGS_UNSPECIFIED\", \"ALLOW_ALL\", \"ALLOW_INTERNAL_ONLY\", \"ALLOW_INTERNAL_AND_GCLB\"]" - } - ], - "releaseTag": "Public", - "name": "INGRESS_SETTINGS_OPTIONS", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!logger:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "logger", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.debug:function(1)", - "docComment": "/**\n * Writes a `DEBUG` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function debug(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "debug" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.error:function(1)", - "docComment": "/**\n * Writes an `ERROR` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function error(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "error" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.info:function(1)", - "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function info(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "info" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.log:function(1)", - "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function log(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "log" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!logger.LogEntry:interface", - "docComment": "/**\n * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging) entry. All keys aside from `severity` and `message` are included in the `jsonPayload` of the logged entry.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogEntry " - } - ], - "releaseTag": "Public", - "name": "LogEntry", - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "firebase-functions!logger.LogEntry:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!logger.LogEntry#message:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "message?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!logger.LogEntry#severity:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "severity: " - }, - { - "kind": "Reference", - "text": "LogSeverity", - "canonicalReference": "firebase-functions!LogSeverity:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "severity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!logger.LogSeverity:type", - "docComment": "/**\n * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type LogSeverity = " - }, - { - "kind": "Content", - "text": "'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "LogSeverity", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.warn:function(1)", - "docComment": "/**\n * Writes a `WARNING` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function warn(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "warn" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.write:function(1)", - "docComment": "/**\n * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).\n *\n * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function write(entry: " - }, - { - "kind": "Reference", - "text": "LogEntry", - "canonicalReference": "firebase-functions!LogEntry:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "entry", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "write" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!makeCloudFunction:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function makeCloudFunction({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: " - }, - { - "kind": "Reference", - "text": "MakeCloudFunctionArgs", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "{ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "EventData", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "makeCloudFunction" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs:interface", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface MakeCloudFunctionArgs " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "EventData", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "MakeCloudFunctionArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#after:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "after?: " - }, - { - "kind": "Content", - "text": "(raw: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "firebase-functions!Event:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "after", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#before:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "before?: " - }, - { - "kind": "Content", - "text": "(raw: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "firebase-functions!Event:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "before", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#contextOnlyHandler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "contextOnlyHandler?: " - }, - { - "kind": "Content", - "text": "(context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "contextOnlyHandler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#dataConstructor:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataConstructor?: " - }, - { - "kind": "Content", - "text": "(raw: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "firebase-functions!Event:interface" - }, - { - "kind": "Content", - "text": ") => EventData" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "dataConstructor", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#eventType:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "eventType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "eventType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#handler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handler?: " - }, - { - "kind": "Content", - "text": "(data: EventData, context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "handler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#labels:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "labels?: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: any;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "labels", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#legacyEventType:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "legacyEventType?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "legacyEventType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#options:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "options?: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: any;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "options", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#provider:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "provider", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#service:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "service: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!MakeCloudFunctionArgs#triggerResource:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "triggerResource", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!MAX_NUMBER_USER_LABELS:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "MAX_NUMBER_USER_LABELS = 58" - } - ], - "releaseTag": "Public", - "name": "MAX_NUMBER_USER_LABELS", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!MAX_TIMEOUT_SECONDS:var", - "docComment": "/**\n * Cloud Functions max timeout value.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "MAX_TIMEOUT_SECONDS = 540" - } - ], - "releaseTag": "Public", - "name": "MAX_TIMEOUT_SECONDS", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!MIN_TIMEOUT_SECONDS:var", - "docComment": "/**\n * Cloud Functions min timeout value.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "MIN_TIMEOUT_SECONDS = 0" - } - ], - "releaseTag": "Public", - "name": "MIN_TIMEOUT_SECONDS", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!optionsToTrigger:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function optionsToTrigger(options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "optionsToTrigger" - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!pubsub:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "pubsub", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub._scheduleWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _scheduleWithOptions(schedule: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ScheduleBuilder", - "canonicalReference": "firebase-functions!ScheduleBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "schedule", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_scheduleWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub._topicWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _topicWithOptions(topic: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "TopicBuilder", - "canonicalReference": "firebase-functions!TopicBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "topic", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_topicWithOptions" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!pubsub.Message:class", - "docComment": "/**\n * Interface representing a Google Cloud Pub/Sub message.\n *\n * @param data - Payload of a Pub/Sub message.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Message " - } - ], - "releaseTag": "Public", - "name": "Message", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!pubsub.Message:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(data: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#attributes:member", - "docComment": "/**\n * User-defined attributes published with the message, if any.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly attributes: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "attributes", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#data:member", - "docComment": "/**\n * The data payload of this message object as a base64-encoded string.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly data: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#json:member", - "docComment": "/**\n * The JSON data payload of this message object, if any.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "get json(): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "json", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.Message#toJSON:member(1)", - "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!pubsub.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.pubsub\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub.schedule:function(1)", - "docComment": "/**\n * Registers a Cloud Function to run at specified times.\n *\n * @param schedule - The schedule, in Unix Crontab or AppEngine syntax. @return ScheduleBuilder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function schedule(schedule: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ScheduleBuilder", - "canonicalReference": "firebase-functions!ScheduleBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "schedule", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "schedule" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder:class", - "docComment": "/**\n * The builder for scheduled functions, which are powered by Google Pub/Sub and Cloud Scheduler. Describes the Cloud Scheduler job that is deployed to trigger a scheduled function at the provided frequency. For more information, see [Schedule functions](/docs/functions/schedule-functions).\n *\n * Access via [`functions.pubsub.schedule()`](providers_pubsub_.html#schedule).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ScheduleBuilder " - } - ], - "releaseTag": "Public", - "name": "ScheduleBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `ScheduleBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#onRun:member(1)", - "docComment": "/**\n * Event handler for scheduled functions. Triggered whenever the associated scheduler job sends a Pub/Sub message.\n *\n * @param handler - Handler that fires whenever the associated scheduler job sends a Pub/Sub message. @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onRun(handler: " - }, - { - "kind": "Content", - "text": "(context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - } - ], - "name": "onRun" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#retryConfig:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "retryConfig(config: " - }, - { - "kind": "Reference", - "text": "ScheduleRetryConfig", - "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ScheduleBuilder", - "canonicalReference": "firebase-functions!ScheduleBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "config", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "retryConfig" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.ScheduleBuilder#timeZone:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeZone(timeZone: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ScheduleBuilder", - "canonicalReference": "firebase-functions!ScheduleBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "timeZone", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "timeZone" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!pubsub.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"pubsub.googleapis.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub.topic:function(1)", - "docComment": "/**\n * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message is sent to a specified topic.\n *\n * @param topic - The Pub/Sub topic to watch for message events. @return Pub/Sub topic builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function topic(topic: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "TopicBuilder", - "canonicalReference": "firebase-functions!TopicBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "topic", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "topic" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!pubsub.TopicBuilder:class", - "docComment": "/**\n * The Google Cloud Pub/Sub topic builder.\n *\n * Access via [`functions.pubsub.topic()`](providers_pubsub_.html#topic).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class TopicBuilder " - } - ], - "releaseTag": "Public", - "name": "TopicBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!pubsub.TopicBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `TopicBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.TopicBuilder#onPublish:member(1)", - "docComment": "/**\n * Event handler that fires every time a Cloud Pub/Sub message is published.\n *\n * @param handler - Event handler that runs every time a Cloud Pub/Sub message is published. @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onPublish(handler: " - }, - { - "kind": "Content", - "text": "(message: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "firebase-functions!Message:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "firebase-functions!Message:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onPublish" - } - ], - "implementsTokenRanges": [] - } - ] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!region:function(1)", - "docComment": "/**\n * Configure the regions that the function is deployed to.\n *\n * @param regions - One of more region strings.\n *\n * @example\n *\n * functions.region('us-east1')\n *\n * @example\n *\n * functions.region('us-east1', 'us-central1')\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function region(...regions: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "FunctionBuilder", - "canonicalReference": "firebase-functions!FunctionBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "regions", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "name": "region" - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!remoteConfig:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "remoteConfig", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!remoteConfig._onUpdateWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _onUpdateWithOptions(handler: " - }, - { - "kind": "Content", - "text": "(version: " - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - } - } - ], - "name": "_onUpdateWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!remoteConfig.onUpdate:function(1)", - "docComment": "/**\n * Registers a function that triggers on Firebase Remote Config template update events.\n *\n * @param handler - A function that takes the updated Remote Config template version metadata as an argument.\n *\n * @return A Cloud Function that you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onUpdate(handler: " - }, - { - "kind": "Content", - "text": "(version: " - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onUpdate" - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!remoteConfig.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.firebase.remoteconfig\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser:interface", - "docComment": "/**\n * An interface representing metadata for a Remote Config account that performed the update. Contains the same fields as [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RemoteConfigUser " - } - ], - "releaseTag": "Public", - "name": "RemoteConfigUser", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#email:member", - "docComment": "/**\n * Email address of the Remote Config account that performed the update.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "email: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "email", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#imageUrl:member", - "docComment": "/**\n * Image URL of the Remote Config account that performed the update.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "imageUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "imageUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.RemoteConfigUser#name:member", - "docComment": "/**\n * Name of the Remote Config account that performed the update.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!remoteConfig.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"firebaseremoteconfig.googleapis.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion:interface", - "docComment": "/**\n * An interface representing a Remote Config template version metadata object emitted when a project is updated.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface TemplateVersion " - } - ], - "releaseTag": "Public", - "name": "TemplateVersion", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#description:member", - "docComment": "/**\n * A description associated with this Remote Config template version.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "description: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "description", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#rollbackSource:member", - "docComment": "/**\n * The version number of the Remote Config template that this update rolled back to. Only applies if this update was a rollback.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "rollbackSource?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "rollbackSource", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateOrigin:member", - "docComment": "/**\n * The origin of the caller - either the Firebase console or the Remote Config REST API. See [`RemoteConfigUpdateOrigin`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdateorigin) for valid values.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateOrigin: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "updateOrigin", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateTime:member", - "docComment": "/**\n * When the template was updated in format (ISO8601 timestamp).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "updateTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateType:member", - "docComment": "/**\n * The type of update action that was performed, whether forced, incremental, or a rollback operation. See [`RemoteConfigUpdateType`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdatetype) for valid values.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "updateType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#updateUser:member", - "docComment": "/**\n * Metadata about the account that performed the update, of type [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateUser: " - }, - { - "kind": "Reference", - "text": "RemoteConfigUser", - "canonicalReference": "firebase-functions!RemoteConfigUser:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "updateUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!remoteConfig.TemplateVersion#versionNumber:member", - "docComment": "/**\n * The version number of the updated Remote Config template.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "versionNumber: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "versionNumber", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder:class", - "docComment": "/**\n * Builder used to create Cloud Functions for Remote Config.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class UpdateBuilder " - } - ], - "releaseTag": "Public", - "name": "UpdateBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `UpdateBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!remoteConfig.UpdateBuilder#onUpdate:member(1)", - "docComment": "/**\n * Handle all updates (including rollbacks) that affect a Remote Config project.\n *\n * @param handler - A function that takes the updated Remote Config template version metadata as an argument.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onUpdate(handler: " - }, - { - "kind": "Content", - "text": "(version: " - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TemplateVersion", - "canonicalReference": "firebase-functions!TemplateVersion:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onUpdate" - } - ], - "implementsTokenRanges": [] - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!Resource:interface", - "docComment": "/**\n * Resource is a standard format for defining a resource (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the resource that triggered the function - such as a storage bucket.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Resource " - } - ], - "releaseTag": "Public", - "name": "Resource", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Resource#labels:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "labels?: " - }, - { - "kind": "Content", - "text": "{\n [tag: string]: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "labels", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Resource#name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Resource#service:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "service: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Resource#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!Runnable:interface", - "docComment": "/**\n * A Runnable has a `run` method which directly invokes the user-defined function - useful for unit testing.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Runnable " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "Runnable", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Runnable#run:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "run: " - }, - { - "kind": "Content", - "text": "(data: T, context: any) => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "run", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!RuntimeOptions:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RuntimeOptions " - } - ], - "releaseTag": "Public", - "name": "RuntimeOptions", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#failurePolicy:member", - "docComment": "/**\n * Failure policy of the function, with boolean `true` being equivalent to providing an empty retry object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "failurePolicy?: " - }, - { - "kind": "Reference", - "text": "FailurePolicy", - "canonicalReference": "firebase-functions!FailurePolicy:interface" - }, - { - "kind": "Content", - "text": " | boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "failurePolicy", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#ingressSettings:member", - "docComment": "/**\n * Ingress settings which control where this function can be called from.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ingressSettings?: " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "INGRESS_SETTINGS_OPTIONS", - "canonicalReference": "firebase-functions!INGRESS_SETTINGS_OPTIONS:var" - }, - { - "kind": "Content", - "text": "[number]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "ingressSettings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#invoker:member", - "docComment": "/**\n * Invoker to set access control on https functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "invoker?: " - }, - { - "kind": "Content", - "text": "'public' | 'private' | string | string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "invoker", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#labels:member", - "docComment": "/**\n * User labels to set on the function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "labels?: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "labels", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#maxInstances:member", - "docComment": "/**\n * Max number of actual instances allowed to be running in parallel.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "maxInstances?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "maxInstances", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#memory:member", - "docComment": "/**\n * Amount of memory to allocate to the function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "memory?: " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "VALID_MEMORY_OPTIONS", - "canonicalReference": "firebase-functions!VALID_MEMORY_OPTIONS:var" - }, - { - "kind": "Content", - "text": "[number]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "memory", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#minInstances:member", - "docComment": "/**\n * Min number of actual instances to be running at a given time. Instances will be billed for memory allocation and 10% of CPU allocation while idle.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "minInstances?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "minInstances", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#platform:member", - "docComment": "/**\n * Which platform should host the backend. Valid options are \"gcfv1\" @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "platform?: " - }, - { - "kind": "Content", - "text": "'gcfv1'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "platform", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#serviceAccount:member", - "docComment": "/**\n * Specific service account for the function to run as.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "serviceAccount?: " - }, - { - "kind": "Content", - "text": "'default' | string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "serviceAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#timeoutSeconds:member", - "docComment": "/**\n * Timeout for the function in seconds, possible values are 0 to 540.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeoutSeconds?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "timeoutSeconds", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#vpcConnector:member", - "docComment": "/**\n * Connect cloud function to specified VPC connector.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vpcConnector?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "vpcConnector", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!RuntimeOptions#vpcConnectorEgressSettings:member", - "docComment": "/**\n * Egress settings for VPC connector.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vpcConnectorEgressSettings?: " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "VPC_EGRESS_SETTINGS_OPTIONS", - "canonicalReference": "firebase-functions!VPC_EGRESS_SETTINGS_OPTIONS:var" - }, - { - "kind": "Content", - "text": "[number]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "vpcConnectorEgressSettings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!runWith:function(1)", - "docComment": "/**\n * Configure runtime options for the function.\n *\n * @param runtimeOptions - Object with optional fields: 1. `memory`: amount of memory to allocate to the function, possible values are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'. 2. `timeoutSeconds`: timeout for the function in seconds, possible values are 0 to 540. 3. `failurePolicy`: failure policy of the function, with boolean `true` being equivalent to providing an empty retry object. 4. `vpcConnector`: id of a VPC connector in same project and region. 5. `vpcConnectorEgressSettings`: when a vpcConnector is set, control which egress traffic is sent through the vpcConnector. 6. `serviceAccount`: Specific service account for the function. 7. `ingressSettings`: ingress settings for the function, which control where a HTTPS function can be called from.\n *\n * Value must not be null.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function runWith(runtimeOptions: " - }, - { - "kind": "Reference", - "text": "RuntimeOptions", - "canonicalReference": "firebase-functions!RuntimeOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "FunctionBuilder", - "canonicalReference": "firebase-functions!FunctionBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "runtimeOptions", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "runWith" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!Schedule:interface", - "docComment": "/**\n * Configuration options for scheduled functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Schedule " - } - ], - "releaseTag": "Public", - "name": "Schedule", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Schedule#retryConfig:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "retryConfig?: " - }, - { - "kind": "Reference", - "text": "ScheduleRetryConfig", - "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "retryConfig", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Schedule#schedule:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "schedule: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "schedule", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!Schedule#timeZone:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeZone?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "timeZone", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!ScheduleRetryConfig:interface", - "docComment": "/**\n * Scheduler retry options. Applies only to scheduled functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ScheduleRetryConfig " - } - ], - "releaseTag": "Public", - "name": "ScheduleRetryConfig", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxBackoffDuration:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "maxBackoffDuration?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "maxBackoffDuration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxDoublings:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "maxDoublings?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "maxDoublings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ScheduleRetryConfig#maxRetryDuration:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "maxRetryDuration?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "maxRetryDuration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ScheduleRetryConfig#minBackoffDuration:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "minBackoffDuration?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "minBackoffDuration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!ScheduleRetryConfig#retryCount:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "retryCount?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "retryCount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!storage:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "storage", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!storage._bucketWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _bucketWithOptions(options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ", bucket?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "BucketBuilder", - "canonicalReference": "firebase-functions!BucketBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "bucket", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "_bucketWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!storage._objectWithOptions:function(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function _objectWithOptions(options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ObjectBuilder", - "canonicalReference": "firebase-functions!ObjectBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "_objectWithOptions" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!storage.bucket:function(1)", - "docComment": "/**\n * Registers a Cloud Function scoped to a specific storage bucket.\n *\n * @param bucket - Name of the bucket to which this Cloud Function is scoped.\n *\n * @return Storage bucket builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function bucket(bucket?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "BucketBuilder", - "canonicalReference": "firebase-functions!BucketBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "bucket", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "bucket" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!storage.BucketBuilder:class", - "docComment": "/**\n * The Google Cloud Storage bucket builder interface.\n *\n * Access via [`functions.storage.bucket()`](providers_storage_.html#bucket).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class BucketBuilder " - } - ], - "releaseTag": "Public", - "name": "BucketBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!storage.BucketBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `BucketBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.BucketBuilder#object:member(1)", - "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage change occurs.\n *\n * @return Storage object builder interface scoped to the specified storage bucket.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "object(): " - }, - { - "kind": "Reference", - "text": "ObjectBuilder", - "canonicalReference": "firebase-functions!ObjectBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "object" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!storage.object:function(1)", - "docComment": "/**\n * Registers a Cloud Function scoped to the default storage bucket for the project.\n *\n * @return Storage object builder interface.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function object(): " - }, - { - "kind": "Reference", - "text": "ObjectBuilder", - "canonicalReference": "firebase-functions!ObjectBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "object" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!storage.ObjectBuilder:class", - "docComment": "/**\n * The Google Cloud Storage object builder interface.\n *\n * Access via [`functions.storage.object()`](providers_storage_.html#object).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ObjectBuilder " - } - ], - "releaseTag": "Public", - "name": "ObjectBuilder", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!storage.ObjectBuilder:constructor(1)", - "docComment": "/**\n * @hidden Constructs a new instance of the `ObjectBuilder` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(triggerResource: " - }, - { - "kind": "Content", - "text": "() => string" - }, - { - "kind": "Content", - "text": ", options: " - }, - { - "kind": "Reference", - "text": "DeploymentOptions", - "canonicalReference": "firebase-functions!DeploymentOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "triggerResource", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.ObjectBuilder#onArchive:member(1)", - "docComment": "/**\n * Event handler sent only when a bucket has enabled object versioning. This event indicates that the live version of an object has become an archived version, either because it was archived or because it was overwritten by the upload of an object of the same name.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onArchive(handler: " - }, - { - "kind": "Content", - "text": "(object: " - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onArchive" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.ObjectBuilder#onChange:member(1)", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onChange(handler: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "onChange" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.ObjectBuilder#onDelete:member(1)", - "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage deletion occurs.\n *\n * Sent when an object has been permanently deleted. This includes objects that are overwritten or are deleted as part of the bucket's lifecycle configuration. For buckets with object versioning enabled, this is not sent when an object is archived, even if archival occurs via the `storage.objects.delete` method.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage deletion occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onDelete(handler: " - }, - { - "kind": "Content", - "text": "(object: " - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onDelete" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.ObjectBuilder#onFinalize:member(1)", - "docComment": "/**\n * Event handler which fires every time a Google Cloud Storage object creation occurs.\n *\n * Sent when a new object (or a new generation of an existing object) is successfully created in the bucket. This includes copying or rewriting an existing object. A failed upload does not trigger this event.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onFinalize(handler: " - }, - { - "kind": "Content", - "text": "(object: " - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onFinalize" - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!storage.ObjectBuilder#onMetadataUpdate:member(1)", - "docComment": "/**\n * Event handler which fires every time the metadata of an existing object changes.\n *\n * @param handler - Event handler which is run every time a Google Cloud Storage metadata update occurs.\n *\n * @return A Cloud Function which you can export and deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onMetadataUpdate(handler: " - }, - { - "kind": "Content", - "text": "(object: " - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ObjectMetadata", - "canonicalReference": "firebase-functions!ObjectMetadata:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onMetadataUpdate" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!storage.ObjectMetadata:interface", - "docComment": "/**\n * Interface representing a Google Google Cloud Storage object metadata object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ObjectMetadata " - } - ], - "releaseTag": "Public", - "name": "ObjectMetadata", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#acl:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "acl?: " - }, - { - "kind": "Content", - "text": "[\n {\n kind?: string;\n id?: string;\n selfLink?: string;\n bucket?: string;\n object?: string;\n generation?: string;\n entity?: string;\n role?: string;\n email?: string;\n entityId?: string;\n domain?: string;\n projectTeam?: {\n projectNumber?: string;\n team?: string;\n };\n etag?: string;\n }\n ]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "acl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#bucket:member", - "docComment": "/**\n * Storage bucket that contains the object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "bucket: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "bucket", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#cacheControl:member", - "docComment": "/**\n * The value of the `Cache-Control` header, used to determine whether Internet caches are allowed to cache public data for an object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "cacheControl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "cacheControl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#componentCount:member", - "docComment": "/**\n * Specifies the number of originally uploaded objects from which a composite object was created.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "componentCount?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "componentCount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentDisposition:member", - "docComment": "/**\n * The value of the `Content-Disposition` header, used to specify presentation information about the data being transmitted.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "contentDisposition?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "contentDisposition", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentEncoding:member", - "docComment": "/**\n * Content-Encoding to indicate that an object is compressed (for example, with gzip compression) while maintaining its Content-Type.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "contentEncoding?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "contentEncoding", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentLanguage:member", - "docComment": "/**\n * ISO 639-1 language code of the content.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "contentLanguage?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "contentLanguage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#contentType:member", - "docComment": "/**\n * The object's content type, also known as the MIME type.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "contentType?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "contentType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#crc32c:member", - "docComment": "/**\n * The object's CRC32C hash. All Google Cloud Storage objects have a CRC32C hash or MD5 hash.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "crc32c?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "crc32c", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#customerEncryption:member", - "docComment": "/**\n * Customer-supplied encryption key.\n *\n * This object contains the following properties: * `encryptionAlgorithm` (`string|undefined`): The encryption algorithm that was used. Always contains the value `AES256`. * `keySha256` (`string|undefined`): An RFC 4648 base64-encoded string of the SHA256 hash of your encryption key. You can use this SHA256 hash to uniquely identify the AES-256 encryption key required to decrypt the object, which you must store securely.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "customerEncryption?: " - }, - { - "kind": "Content", - "text": "{\n encryptionAlgorithm?: string;\n keySha256?: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "customerEncryption", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#etag:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "etag?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "etag", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#generation:member", - "docComment": "/**\n * Generation version number that changes each time the object is overwritten.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "generation?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "generation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#id:member", - "docComment": "/**\n * The ID of the object, including the bucket name, object name, and generation number.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#kind:member", - "docComment": "/**\n * The kind of the object, which is always `storage#object`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "kind: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "kind", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#md5Hash:member", - "docComment": "/**\n * MD5 hash for the object. All Google Cloud Storage objects have a CRC32C hash or MD5 hash.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "md5Hash?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "md5Hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#mediaLink:member", - "docComment": "/**\n * Media download link.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mediaLink?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "mediaLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#metadata:member", - "docComment": "/**\n * User-provided metadata.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metadata?: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "metadata", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#metageneration:member", - "docComment": "/**\n * Meta-generation version number that changes each time the object's metadata is updated.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metageneration?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "metageneration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#name:member", - "docComment": "/**\n * The object's name.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#owner:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "owner?: " - }, - { - "kind": "Content", - "text": "{\n entity?: string;\n entityId?: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "owner", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#selfLink:member", - "docComment": "/**\n * Link to access the object, assuming you have sufficient permissions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "selfLink?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "selfLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#size:member", - "docComment": "/**\n * The value of the `Content-Length` header, used to determine the length of the object data in bytes.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "size: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "size", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#storageClass:member", - "docComment": "/**\n * Storage class of the object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "storageClass: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "storageClass", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeCreated:member", - "docComment": "/**\n * The creation time of the object in RFC 3339 format.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeCreated: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "timeCreated", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeDeleted:member", - "docComment": "/**\n * The deletion time of the object in RFC 3339 format. Returned only if this version of the object has been deleted.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeDeleted?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "timeDeleted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#timeStorageClassUpdated:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeStorageClassUpdated?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "timeStorageClassUpdated", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!storage.ObjectMetadata#updated:member", - "docComment": "/**\n * The modification time of the object metadata in RFC 3339 format.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "updated: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "updated", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!storage.provider:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider = \"google.storage\"" - } - ], - "releaseTag": "Public", - "name": "provider", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!storage.service:var", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service = \"storage.googleapis.com\"" - } - ], - "releaseTag": "Public", - "name": "service", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!SUPPORTED_REGIONS:var", - "docComment": "/**\n * List of all regions supported by Cloud Functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "SUPPORTED_REGIONS: " - }, - { - "kind": "Content", - "text": "readonly [\"us-central1\", \"us-east1\", \"us-east4\", \"us-west2\", \"us-west3\", \"us-west4\", \"europe-central2\", \"europe-west1\", \"europe-west2\", \"europe-west3\", \"europe-west6\", \"asia-east1\", \"asia-east2\", \"asia-northeast1\", \"asia-northeast2\", \"asia-northeast3\", \"asia-south1\", \"asia-southeast1\", \"asia-southeast2\", \"northamerica-northeast1\", \"southamerica-east1\", \"australia-southeast1\"]" - } - ], - "releaseTag": "Public", - "name": "SUPPORTED_REGIONS", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!testLab:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "testLab", - "members": [ - { - "kind": "Class", - "canonicalReference": "firebase-functions!testLab.ClientInfo:class", - "docComment": "/**\n * Information about the client which invoked the test.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ClientInfo " - } - ], - "releaseTag": "Public", - "name": "ClientInfo", - "members": [ - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ClientInfo#details:member", - "docComment": "/**\n * Map of detailed information about the client which invoked the test.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "details: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "details", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ClientInfo#name:member", - "docComment": "/**\n * Client name, e.g. 'gcloud'.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!testLab.InvalidMatrixDetails:type", - "docComment": "/**\n * The detailed reason that a Matrix was deemed INVALID.\n *\n * Possible values: - 'DETAILS_UNAVAILABLE': The matrix is INVALID, but there are no further details available. - 'MALFORMED_APK': The input app APK could not be parsed. - 'MALFORMED_TEST_APK': The input test APK could not be parsed. - 'NO_MANIFEST': The AndroidManifest.xml could not be found. - 'NO_PACKAGE_NAME': The APK manifest does not declare a package name. - 'INVALID_PACKAGE_NAME': The APK application ID is invalid. - 'TEST_SAME_AS_APP': The test package and app package are the same. - 'NO_INSTRUMENTATION': The test apk does not declare an instrumentation. - 'NO_SIGNATURE': The input app apk does not have a signature. - 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE': The test runner class specified by user or in the test APK's manifest file is not compatible with Android Test Orchestrator. - 'NO_TEST_RUNNER_CLASS': The test APK does not contain the test runner class specified by user or in the manifest file. - 'NO_LAUNCHER_ACTIVITY': A main launcher activity could not be found. - 'FORBIDDEN_PERMISSIONS': The app declares one or more permissions that are not allowed. - 'INVALID_ROBO_DIRECTIVES': There is a conflict in the provided robo_directives. - 'INVALID_RESOURCE_NAME': There is at least one invalid resource name in the provided robo directives. - 'INVALID_DIRECTIVE_ACTION': Invalid definition of action in the robo directives, e.g. a click or ignore action includes an input text field. - 'TEST_LOOP_INTENT_FILTER_NOT_FOUND': There is no test loop intent filter, or the one that is given is not formatted correctly. - 'SCENARIO_LABEL_NOT_DECLARED': The request contains a scenario label that was not declared in the manifest. - 'SCENARIO_LABEL_MALFORMED': There was an error when parsing a label value. - 'SCENARIO_NOT_DECLARED': The request contains a scenario number that was not declared in the manifest. - 'DEVICE_ADMIN_RECEIVER': Device administrator applications are not allowed. - 'MALFORMED_XC_TEST_ZIP': The zipped XCTest was malformed. The zip did not ] contain a single .xctestrun file and the contents of the DerivedData/Build/Products directory. - 'BUILT_FOR_IOS_SIMULATOR': The zipped XCTest was built for the iOS simulator rather than for a physical device. - 'NO_TESTS_IN_XC_TEST_ZIP': The .xctestrun file did not specify any test targets. - 'USE_DESTINATION_ARTIFACTS': One or more of the test targets defined in the .xctestrun file specifies \"UseDestinationArtifacts\", which is disallowed. - 'TEST_NON_APP_HOSTED': XC tests which run on physical devices must have \"IsAppHostedTestBundle\" == \"true\" in the xctestrun file. - 'PLIST_CANNOT_BE_PARSED': An Info.plist file in the XCTest zip could not be parsed. - 'NO_CODE_APK': APK contains no code. - 'INVALID_INPUT_APK': Either the provided input APK path was malformed, the APK file does not exist, or the user does not have permission to access the APK file. - 'INVALID_APK_PREVIEW_SDK': APK is built for a preview SDK which is unsupported.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type InvalidMatrixDetails = " - }, - { - "kind": "Content", - "text": "'DETAILS_UNAVAILABLE' | 'MALFORMED_APK' | 'MALFORMED_TEST_APK' | 'NO_MANIFEST' | 'NO_PACKAGE_NAME' | 'INVALID_PACKAGE_NAME' | 'TEST_SAME_AS_APP' | 'NO_INSTRUMENTATION' | 'NO_SIGNATURE' | 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE' | 'NO_TEST_RUNNER_CLASS' | 'NO_LAUNCHER_ACTIVITY' | 'FORBIDDEN_PERMISSIONS' | 'INVALID_ROBO_DIRECTIVES' | 'INVALID_RESOURCE_NAME' | 'INVALID_DIRECTIVE_ACTION' | 'TEST_LOOP_INTENT_FILTER_NOT_FOUND' | 'SCENARIO_LABEL_NOT_DECLARED' | 'SCENARIO_LABEL_MALFORMED' | 'SCENARIO_NOT_DECLARED' | 'DEVICE_ADMIN_RECEIVER' | 'MALFORMED_XC_TEST_ZIP' | 'BUILT_FOR_IOS_SIMULATOR' | 'NO_TESTS_IN_XC_TEST_ZIP' | 'USE_DESTINATION_ARTIFACTS' | 'TEST_NOT_APP_HOSTED' | 'PLIST_CANNOT_BE_PARSED' | 'NO_CODE_APK' | 'INVALID_INPUT_APK' | 'INVALID_APK_PREVIEW_SDK'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "InvalidMatrixDetails", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!testLab.OutcomeSummary:type", - "docComment": "/**\n * Outcome summary for a finished TestMatrix.\n *\n * Possible values: - 'SUCCESS': The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test. - 'FAILURE': The test run failed, for instance: - One or more test cases failed. - A test timed out. - The application under test crashed. - 'INCONCLUSIVE': Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful. - 'SKIPPED': All tests were skipped, for instance: - All device configurations were incompatible.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type OutcomeSummary = " - }, - { - "kind": "Content", - "text": "'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "OutcomeSummary", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!testLab.ResultStorage:class", - "docComment": "/**\n * Locations where the test results are stored.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ResultStorage " - } - ], - "releaseTag": "Public", - "name": "ResultStorage", - "members": [ - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ResultStorage#gcsPath:member", - "docComment": "/**\n * A storage location within Google Cloud Storage (GCS) for the test artifacts.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "gcsPath?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "gcsPath", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ResultStorage#resultsUrl:member", - "docComment": "/**\n * URL to test results in Firebase Console.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "resultsUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "resultsUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ResultStorage#toolResultsExecutionId:member", - "docComment": "/**\n * Id of the ToolResults execution that the detailed TestMatrix results are written to.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toolResultsExecutionId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "toolResultsExecutionId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.ResultStorage#toolResultsHistoryId:member", - "docComment": "/**\n * Id of the ToolResults History containing these results.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toolResultsHistoryId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "toolResultsHistoryId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!testLab.TestMatrix:class", - "docComment": "/**\n * TestMatrix captures details about a test run.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class TestMatrix " - } - ], - "releaseTag": "Public", - "name": "TestMatrix", - "members": [ - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#clientInfo:member", - "docComment": "/**\n * Information about the client which invoked the test.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clientInfo: " - }, - { - "kind": "Reference", - "text": "ClientInfo", - "canonicalReference": "firebase-functions!ClientInfo:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "clientInfo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#createTime:member", - "docComment": "/**\n * When this test matrix was initially created (ISO8601 timestamp).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "createTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "createTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#invalidMatrixDetails:member", - "docComment": "/**\n * For 'INVALID' matrices only, describes why the matrix is invalid.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "invalidMatrixDetails?: " - }, - { - "kind": "Reference", - "text": "InvalidMatrixDetails", - "canonicalReference": "firebase-functions!InvalidMatrixDetails:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "invalidMatrixDetails", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#outcomeSummary:member", - "docComment": "/**\n * The overall outcome of the test matrix run. Only set when the test matrix state is FINISHED.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "outcomeSummary?: " - }, - { - "kind": "Reference", - "text": "OutcomeSummary", - "canonicalReference": "firebase-functions!OutcomeSummary:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "outcomeSummary", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#resultStorage:member", - "docComment": "/**\n * Where the results for the matrix are located.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "resultStorage: " - }, - { - "kind": "Reference", - "text": "ResultStorage", - "canonicalReference": "firebase-functions!ResultStorage:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "resultStorage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#state:member", - "docComment": "/**\n * Indicates the current progress of the test matrix\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "TestState", - "canonicalReference": "firebase-functions!TestState:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!testLab.TestMatrix#testMatrixId:member", - "docComment": "/**\n * Unique id set by the service.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "testMatrixId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "testMatrixId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!testLab.testMatrix:function(1)", - "docComment": "/**\n * Handle events related to Test Lab test matrices.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function testMatrix(): " - }, - { - "kind": "Reference", - "text": "TestMatrixBuilder", - "canonicalReference": "firebase-functions!TestMatrixBuilder:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "testMatrix" - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!testLab.TestMatrixBuilder:class", - "docComment": "/**\n * Builder used to create Cloud Functions for Test Lab test matrices events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class TestMatrixBuilder " - } - ], - "releaseTag": "Public", - "name": "TestMatrixBuilder", - "members": [ - { - "kind": "Method", - "canonicalReference": "firebase-functions!testLab.TestMatrixBuilder#onComplete:member(1)", - "docComment": "/**\n * Handle a TestMatrix that reached a final test state.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "onComplete(handler: " - }, - { - "kind": "Content", - "text": "(testMatrix: " - }, - { - "kind": "Reference", - "text": "TestMatrix", - "canonicalReference": "firebase-functions!TestMatrix:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "EventContext", - "canonicalReference": "firebase-functions!EventContext:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "PromiseLike", - "canonicalReference": "!PromiseLike:interface" - }, - { - "kind": "Content", - "text": " | any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TestMatrix", - "canonicalReference": "firebase-functions!TestMatrix:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onComplete" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!testLab.TestState:type", - "docComment": "/**\n * The state (i.e. progress) of a TestMatrix.\n *\n * Possible values: - 'VALIDATING': The matrix is being validated. - 'PENDING': The matrix is waiting for resources to become available. - 'FINISHED': The matrix has terminated normally. This means that the matrix level processing completed normally, but individual executions may be in an ERROR state. - 'ERROR': The matrix has stopped because it encountered an infrastructure failure. - 'INVALID': The matrix was not run because the provided inputs are not valid. E.g. the input file is not of the expected type, or is malformed/corrupt.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TestState = " - }, - { - "kind": "Content", - "text": "'VALIDATING' | 'PENDING' | 'FINISHED' | 'ERROR' | 'INVALID'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TestState", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!TriggerAnnotated:interface", - "docComment": "/**\n * @hidden TriggerAnnotated is used internally by the firebase CLI to understand what type of Cloud Function to deploy.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface TriggerAnnotated " - } - ], - "releaseTag": "Public", - "name": "TriggerAnnotated", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!TriggerAnnotated#__trigger:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "__trigger: " - }, - { - "kind": "Content", - "text": "{\n availableMemoryMb?: number;\n eventTrigger?: {\n eventType: string;\n resource: string;\n service: string;\n };\n failurePolicy?: " - }, - { - "kind": "Reference", - "text": "FailurePolicy", - "canonicalReference": "firebase-functions!FailurePolicy:interface" - }, - { - "kind": "Content", - "text": ";\n httpsTrigger?: {\n invoker?: string[];\n };\n labels?: {\n [key: string]: string;\n };\n regions?: string[];\n schedule?: " - }, - { - "kind": "Reference", - "text": "Schedule", - "canonicalReference": "firebase-functions!Schedule:interface" - }, - { - "kind": "Content", - "text": ";\n timeout?: " - }, - { - "kind": "Reference", - "text": "Duration", - "canonicalReference": "firebase-functions!Duration:type" - }, - { - "kind": "Content", - "text": ";\n vpcConnector?: string;\n vpcConnectorEgressSettings?: string;\n serviceAccountEmail?: string;\n ingressSettings?: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "__trigger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!VALID_MEMORY_OPTIONS:var", - "docComment": "/**\n * List of available memory options supported by Cloud Functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "VALID_MEMORY_OPTIONS: " - }, - { - "kind": "Content", - "text": "readonly [\"128MB\", \"256MB\", \"512MB\", \"1GB\", \"2GB\", \"4GB\", \"8GB\"]" - } - ], - "releaseTag": "Public", - "name": "VALID_MEMORY_OPTIONS", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "firebase-functions!VPC_EGRESS_SETTINGS_OPTIONS:var", - "docComment": "/**\n * List of available options for VpcConnectorEgressSettings.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "VPC_EGRESS_SETTINGS_OPTIONS: " - }, - { - "kind": "Content", - "text": "readonly [\"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED\", \"PRIVATE_RANGES_ONLY\", \"ALL_TRAFFIC\"]" - } - ], - "releaseTag": "Public", - "name": "VPC_EGRESS_SETTINGS_OPTIONS", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ] -} diff --git a/docgen/v1/firebase-functions.api.md b/docgen/v1/firebase-functions.api.md deleted file mode 100644 index 495dca09e..000000000 --- a/docgen/v1/firebase-functions.api.md +++ /dev/null @@ -1,1080 +0,0 @@ -## API Report File for "firebase-functions" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -/// - -import * as express from 'express'; -import * as firebase from 'firebase-admin'; -import { ParamsDictionary } from 'express-serve-static-core'; -import { Request } from 'express'; -import { Response } from 'express'; - -declare namespace analytics { - export { - event, - _eventWithOptions, - provider, - service, - AnalyticsEventBuilder, - AnalyticsEvent, - UserDimensions, - UserPropertyValue, - DeviceInfo, - GeoInfo, - AppInfo, - ExportBundleInfo - } -} -export { analytics } - -// @public -class AnalyticsEvent { - constructor(wireFormat: any); - logTime: string; - name: string; - params: { - [key: string]: any; - }; - previousLogTime?: string; - reportingDate: string; - user?: UserDimensions; - valueInUSD?: number; -} - -// @public -class AnalyticsEventBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onLog(handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// Warning: (ae-forgotten-export) The symbol "apps" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -export const app: apps.apps.Apps; - -// @public -interface AppInfo { - appId?: string; - appInstanceId: string; - appPlatform: string; - appStore?: string; - appVersion?: string; -} - -// @public (undocumented) -function apps_2(): apps_2.Apps; - -// @public (undocumented) -namespace apps_2 { - const // (undocumented) - garbageCollectionInterval: number; - // (undocumented) - class Apps { - constructor(); - // (undocumented) - get admin(): firebase.app.App; - // (undocumented) - _appAlive(appName: string): boolean; - // (undocumented) - _destroyApp(appName: string): void; - // (undocumented) - release(): Promise; - // (undocumented) - retain(): void; - setEmulatedAdminApp(app: firebase.app.App): void; - } - let // (undocumented) - singleton: apps_2.Apps; - let // (undocumented) - init: () => Apps; - // (undocumented) - interface AuthMode { - // (undocumented) - admin: boolean; - // (undocumented) - variable?: any; - } - // (undocumented) - function delay(delay: number): Promise; - // (undocumented) - interface RefCounter { - // (undocumented) - [appName: string]: number; - } -} - -declare namespace auth { - export { - user, - _userWithOptions, - userRecordConstructor, - provider_2 as provider, - service_2 as service, - UserRecordMetadata, - UserBuilder, - UserRecord, - UserInfo - } -} -export { auth } - -// @public (undocumented) -function beforeSnapshotConstructor(event: Event): DocumentSnapshot; - -// @public -function bucket(bucket?: string): BucketBuilder; - -// @public -class BucketBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - object(): ObjectBuilder; -} - -// @public (undocumented) -function _bucketWithOptions(options: DeploymentOptions, bucket?: string): BucketBuilder; - -// @public -interface CallableContext { - // Warning: (ae-forgotten-export) The symbol "AppCheckData" needs to be exported by the entry point index.d.ts - app?: AppCheckData; - // Warning: (ae-forgotten-export) The symbol "AuthData" needs to be exported by the entry point index.d.ts - auth?: AuthData; - instanceIdToken?: string; - rawRequest: Request_2; -} - -// @public -export class Change { - constructor(before: T, after: T); - // (undocumented) - after: T; - // (undocumented) - before: T; -} - -// @public (undocumented) -export namespace Change { - // (undocumented) - export function applyFieldMask(sparseBefore: any, after: any, fieldMask: string): any; - export function fromJSON(json: ChangeJson, customizer?: (x: any) => T): Change; - export function fromObjects(before: T, after: T): Change; -} - -// @public -export interface ChangeJson { - after?: any; - before?: any; - fieldMask?: string; -} - -// @public -class ClientInfo { - details: { - [key: string]: string; - }; - name: string; -} - -// @public -export type CloudFunction = Runnable & TriggerAnnotated & ((input: any, context?: any) => PromiseLike | any); - -// @public (undocumented) -export function config(): config.Config; - -// @public -export namespace config { - export interface Config { - // (undocumented) - [key: string]: any; - } - let // (undocumented) - singleton: config.Config; -} - -declare namespace database { - export { - instance, - ref, - _instanceWithOptions, - _refWithOptions, - extractInstanceAndPath, - provider_3 as provider, - service_3 as service, - InstanceBuilder, - RefBuilder, - DataSnapshot - } -} -export { database } - -// @public (undocumented) -function database_2(database: string): DatabaseBuilder; - -// @public (undocumented) -class DatabaseBuilder { - constructor(database: string, options: DeploymentOptions); - // (undocumented) - document(path: string): DocumentBuilder; - // (undocumented) - namespace(namespace: string): NamespaceBuilder; -} - -// @public (undocumented) -function _databaseWithOptions(database: string, options: DeploymentOptions): DatabaseBuilder; - -// @public -class DataSnapshot { - constructor(data: any, path?: string, // path will be undefined for the database root - app?: firebase.app.App, instance?: string); - child(childPath: string): DataSnapshot; - exists(): boolean; - exportVal(): any; - forEach(action: (a: DataSnapshot) => boolean | void): boolean; - getPriority(): string | number | null; - hasChild(childPath: string): boolean; - hasChildren(): boolean; - // (undocumented) - instance: string; - get key(): string; - numChildren(): number; - get ref(): firebase.database.Reference; - toJSON(): Object; - val(): any; -} - -// @public -function debug(...args: any[]): void; - -// @public (undocumented) -export const DEFAULT_FAILURE_POLICY: FailurePolicy; - -// @public (undocumented) -const defaultDatabase = "(default)"; - -// @public (undocumented) -export interface DeploymentOptions extends RuntimeOptions { - // (undocumented) - regions?: Array; - // (undocumented) - schedule?: Schedule; -} - -// @public -interface DeviceInfo { - deviceCategory?: string; - deviceId?: string; - deviceModel?: string; - deviceTimeZoneOffsetSeconds: number; - limitedAdTracking: boolean; - mobileBrandName?: string; - mobileMarketingName?: string; - mobileModelName?: string; - platformVersion?: string; - resettableDeviceId?: string; - userDefaultLanguage: string; -} - -// @public -function document(path: string): DocumentBuilder; - -// @public (undocumented) -class DocumentBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; - onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; - onUpdate(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; - onWrite(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; -} - -// @public (undocumented) -type DocumentSnapshot = firebase.firestore.DocumentSnapshot; - -// @public (undocumented) -function _documentWithOptions(path: string, options: DeploymentOptions): DocumentBuilder; - -// @public -function error(...args: any[]): void; - -// @public -export interface Event { - // (undocumented) - context: { - eventId: string; - timestamp: string; - eventType: string; - resource: Resource; - domain?: string; - }; - // (undocumented) - data: any; -} - -// @public -function event(analyticsEventType: string): AnalyticsEventBuilder; - -// @public -export interface EventContext { - auth?: { - token: object; - uid: string; - }; - authType?: 'ADMIN' | 'USER' | 'UNAUTHENTICATED'; - eventId: string; - eventType: string; - params: { - [option: string]: any; - }; - resource: Resource; - timestamp: string; -} - -// @public (undocumented) -function _eventWithOptions(analyticsEventType: string, options: DeploymentOptions): AnalyticsEventBuilder; - -// @public -class ExportBundleInfo { - constructor(wireFormat: any); - bundleSequenceId: number; - serverTimestampOffset: number; -} - -// @public (undocumented) -function extractInstanceAndPath(resource: string, domain?: string): string[]; - -// @public (undocumented) -export interface FailurePolicy { - // (undocumented) - retry: {}; -} - -// @public (undocumented) -export function firebaseConfig(): firebase.AppOptions | null; - -// @public (undocumented) -export let firebaseConfigCache: firebase.AppOptions | null; - -declare namespace firestore { - export { - document, - namespace, - database_2 as database, - _databaseWithOptions, - _namespaceWithOptions, - _documentWithOptions, - snapshotConstructor, - beforeSnapshotConstructor, - provider_4 as provider, - service_4 as service, - defaultDatabase, - DocumentSnapshot, - QueryDocumentSnapshot, - DatabaseBuilder, - NamespaceBuilder, - DocumentBuilder - } -} -export { firestore } - -// @public (undocumented) -export class FunctionBuilder { - constructor(options: DeploymentOptions); - // (undocumented) - get analytics(): { - event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; - }; - // (undocumented) - get auth(): { - user: () => auth.UserBuilder; - }; - // (undocumented) - get database(): { - instance: (instance: string) => database.InstanceBuilder; - ref: (path: string) => database.RefBuilder; - }; - // (undocumented) - get firestore(): { - document: (path: string) => firestore.DocumentBuilder; - namespace: (namespace: string) => firestore.NamespaceBuilder; - database: (database: string) => firestore.DatabaseBuilder; - }; - // (undocumented) - get https(): { - onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise) => HttpsFunction; - onCall: (handler: (data: any, context: https.CallableContext) => any | Promise) => TriggerAnnotated & ((req: express.Request, resp: express.Response) => void | Promise) & Runnable; - }; - // (undocumented) - get pubsub(): { - topic: (topic: string) => pubsub.TopicBuilder; - schedule: (schedule: string) => pubsub.ScheduleBuilder; - }; - region(...regions: Array): FunctionBuilder; - // (undocumented) - get remoteConfig(): { - onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike | any) => CloudFunction; - }; - runWith(runtimeOptions: RuntimeOptions): FunctionBuilder; - // (undocumented) - get storage(): { - bucket: (bucket?: string) => storage.BucketBuilder; - object: () => storage.ObjectBuilder; - }; - // (undocumented) - get testLab(): { - testMatrix: () => testLab.TestMatrixBuilder; - }; -} - -// @public -type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'; - -// @public -interface GeoInfo { - city?: string; - continent?: string; - country?: string; - region?: string; -} - -// Warning: (ae-forgotten-export) The symbol "HandlerBuilder" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -export let handler: HandlerBuilder; - -declare namespace https { - export { - onRequest, - onCall, - _onRequestWithOptions, - _onCallWithOptions, - Request_2 as Request, - CallableContext, - FunctionsErrorCode, - HttpsError - } -} -export { https } - -// @public -class HttpsError extends Error { - constructor(code: FunctionsErrorCode, message: string, details?: unknown); - readonly code: FunctionsErrorCode; - readonly details: unknown; - // Warning: (ae-forgotten-export) The symbol "HttpErrorCode" needs to be exported by the entry point index.d.ts - readonly httpErrorCode: HttpErrorCode; - // Warning: (ae-forgotten-export) The symbol "HttpErrorWireFormat" needs to be exported by the entry point index.d.ts - // - // (undocumented) - toJSON(): HttpErrorWireFormat; -} - -// @public -export type HttpsFunction = TriggerAnnotated & ((req: Request, resp: Response) => void | Promise); - -// @public -function info(...args: any[]): void; - -// @public -export const INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]; - -// @public -function instance(instance: string): InstanceBuilder; - -// @public -class InstanceBuilder { - constructor(instance: string, options: DeploymentOptions); - ref(path: string): RefBuilder; -} - -// @public (undocumented) -function _instanceWithOptions(instance: string, options: DeploymentOptions): InstanceBuilder; - -// @public -type InvalidMatrixDetails = 'DETAILS_UNAVAILABLE' | 'MALFORMED_APK' | 'MALFORMED_TEST_APK' | 'NO_MANIFEST' | 'NO_PACKAGE_NAME' | 'INVALID_PACKAGE_NAME' | 'TEST_SAME_AS_APP' | 'NO_INSTRUMENTATION' | 'NO_SIGNATURE' | 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE' | 'NO_TEST_RUNNER_CLASS' | 'NO_LAUNCHER_ACTIVITY' | 'FORBIDDEN_PERMISSIONS' | 'INVALID_ROBO_DIRECTIVES' | 'INVALID_RESOURCE_NAME' | 'INVALID_DIRECTIVE_ACTION' | 'TEST_LOOP_INTENT_FILTER_NOT_FOUND' | 'SCENARIO_LABEL_NOT_DECLARED' | 'SCENARIO_LABEL_MALFORMED' | 'SCENARIO_NOT_DECLARED' | 'DEVICE_ADMIN_RECEIVER' | 'MALFORMED_XC_TEST_ZIP' | 'BUILT_FOR_IOS_SIMULATOR' | 'NO_TESTS_IN_XC_TEST_ZIP' | 'USE_DESTINATION_ARTIFACTS' | 'TEST_NOT_APP_HOSTED' | 'PLIST_CANNOT_BE_PARSED' | 'NO_CODE_APK' | 'INVALID_INPUT_APK' | 'INVALID_APK_PREVIEW_SDK'; - -// @public -function log(...args: any[]): void; - -// @public -interface LogEntry { - // (undocumented) - [key: string]: any; - // (undocumented) - message?: string; - // (undocumented) - severity: LogSeverity; -} - -declare namespace logger { - export { - write, - debug, - log, - info, - warn, - error, - LogSeverity, - LogEntry - } -} -export { logger } - -// @public -type LogSeverity = 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'; - -// @public (undocumented) -export function makeCloudFunction({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: MakeCloudFunctionArgs): CloudFunction; - -// @public (undocumented) -export interface MakeCloudFunctionArgs { - // (undocumented) - after?: (raw: Event) => void; - // (undocumented) - before?: (raw: Event) => void; - // (undocumented) - contextOnlyHandler?: (context: EventContext) => PromiseLike | any; - // (undocumented) - dataConstructor?: (raw: Event) => EventData; - // (undocumented) - eventType: string; - // (undocumented) - handler?: (data: EventData, context: EventContext) => PromiseLike | any; - // (undocumented) - labels?: { - [key: string]: any; - }; - // (undocumented) - legacyEventType?: string; - // (undocumented) - options?: { - [key: string]: any; - }; - // (undocumented) - provider: string; - // (undocumented) - service: string; - // (undocumented) - triggerResource: () => string; -} - -// @public (undocumented) -export const MAX_NUMBER_USER_LABELS = 58; - -// @public -export const MAX_TIMEOUT_SECONDS = 540; - -// @public -class Message { - constructor(data: any); - readonly attributes: { - [key: string]: string; - }; - readonly data: string; - get json(): any; - toJSON(): any; -} - -// @public -export const MIN_TIMEOUT_SECONDS = 0; - -// @public (undocumented) -function namespace(namespace: string): NamespaceBuilder; - -// @public (undocumented) -class NamespaceBuilder { - constructor(database: string, options: DeploymentOptions, namespace?: string); - // (undocumented) - document(path: string): DocumentBuilder; -} - -// @public (undocumented) -function _namespaceWithOptions(namespace: string, options: DeploymentOptions): NamespaceBuilder; - -// @public -function object(): ObjectBuilder; - -// @public -class ObjectBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onArchive(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; - // (undocumented) - onChange(handler: any): Error; - onDelete(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; - onFinalize(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; - onMetadataUpdate(handler: (object: ObjectMetadata, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// @public -interface ObjectMetadata { - // (undocumented) - acl?: [ - { - kind?: string; - id?: string; - selfLink?: string; - bucket?: string; - object?: string; - generation?: string; - entity?: string; - role?: string; - email?: string; - entityId?: string; - domain?: string; - projectTeam?: { - projectNumber?: string; - team?: string; - }; - etag?: string; - } - ]; - bucket: string; - cacheControl?: string; - componentCount?: string; - contentDisposition?: string; - contentEncoding?: string; - contentLanguage?: string; - contentType?: string; - crc32c?: string; - customerEncryption?: { - encryptionAlgorithm?: string; - keySha256?: string; - }; - // (undocumented) - etag?: string; - generation?: string; - id: string; - kind: string; - md5Hash?: string; - mediaLink?: string; - metadata?: { - [key: string]: string; - }; - metageneration?: string; - name?: string; - // (undocumented) - owner?: { - entity?: string; - entityId?: string; - }; - selfLink?: string; - size: string; - storageClass: string; - timeCreated: string; - timeDeleted?: string; - // (undocumented) - timeStorageClassUpdated?: string; - updated: string; -} - -// @public (undocumented) -function _objectWithOptions(options: DeploymentOptions): ObjectBuilder; - -// @public -function onCall(handler: (data: any, context: CallableContext) => any | Promise): HttpsFunction & Runnable; - -// @public (undocumented) -function _onCallWithOptions(handler: (data: any, context: CallableContext) => any | Promise, options: DeploymentOptions): HttpsFunction & Runnable; - -// @public -function onRequest(handler: (req: Request_2, resp: express.Response) => void | Promise): HttpsFunction; - -// @public (undocumented) -function _onRequestWithOptions(handler: (req: Request_2, resp: express.Response) => void | Promise, options: DeploymentOptions): HttpsFunction; - -// @public -function onUpdate(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any): CloudFunction; - -// @public (undocumented) -function _onUpdateWithOptions(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any, options: DeploymentOptions): CloudFunction; - -// @public (undocumented) -export function optionsToTrigger(options: DeploymentOptions): any; - -// @public -type OutcomeSummary = 'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED'; - -// @public (undocumented) -const provider = "google.analytics"; - -// @public (undocumented) -const provider_2 = "google.firebase.auth"; - -// @public (undocumented) -const provider_3 = "google.firebase.database"; - -// @public (undocumented) -const provider_4 = "google.firestore"; - -// @public (undocumented) -const provider_5 = "google.firebase.remoteconfig"; - -// @public (undocumented) -const provider_6 = "google.storage"; - -// @public (undocumented) -const provider_7 = "google.pubsub"; - -declare namespace pubsub { - export { - topic, - _topicWithOptions, - schedule, - _scheduleWithOptions, - provider_7 as provider, - service_7 as service, - TopicBuilder, - ScheduleBuilder, - Message - } -} -export { pubsub } - -// @public (undocumented) -type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnapshot; - -// @public -function ref(path: string): RefBuilder; - -// @public -class RefBuilder { - constructor(apps: apps_2.Apps, triggerResource: () => string, options: DeploymentOptions); - onCreate(handler: (snapshot: DataSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; - onDelete(handler: (snapshot: DataSnapshot, context: EventContext) => PromiseLike | any): CloudFunction; - onUpdate(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; - onWrite(handler: (change: Change, context: EventContext) => PromiseLike | any): CloudFunction>; -} - -// @public (undocumented) -function _refWithOptions(path: string, options: DeploymentOptions): RefBuilder; - -// @public -export function region(...regions: Array): FunctionBuilder; - -declare namespace remoteConfig { - export { - onUpdate, - _onUpdateWithOptions, - provider_5 as provider, - service_5 as service, - UpdateBuilder, - TemplateVersion, - RemoteConfigUser - } -} -export { remoteConfig } - -// @public -interface RemoteConfigUser { - email: string; - imageUrl?: string; - name?: string; -} - -export { Request } - -// @public (undocumented) -interface Request_2 extends express.Request { - // (undocumented) - rawBody: Buffer; -} - -// @public -export interface Resource { - // (undocumented) - labels?: { - [tag: string]: string; - }; - // (undocumented) - name: string; - // (undocumented) - service: string; - // (undocumented) - type?: string; -} - -export { Response } - -// @public -class ResultStorage { - gcsPath?: string; - resultsUrl?: string; - toolResultsExecutionId?: string; - toolResultsHistoryId?: string; -} - -// @public -export interface Runnable { - // (undocumented) - run: (data: T, context: any) => PromiseLike | any; -} - -// @public (undocumented) -export interface RuntimeOptions { - failurePolicy?: FailurePolicy | boolean; - ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number]; - invoker?: 'public' | 'private' | string | string[]; - labels?: Record; - maxInstances?: number; - memory?: typeof VALID_MEMORY_OPTIONS[number]; - minInstances?: number; - platform?: 'gcfv1'; - serviceAccount?: 'default' | string; - timeoutSeconds?: number; - vpcConnector?: string; - vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number]; -} - -// @public -export function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder; - -// @public -export interface Schedule { - // (undocumented) - retryConfig?: ScheduleRetryConfig; - // (undocumented) - schedule: string; - // (undocumented) - timeZone?: string; -} - -// @public -function schedule(schedule: string): ScheduleBuilder; - -// @public -class ScheduleBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onRun(handler: (context: EventContext) => PromiseLike | any): CloudFunction; - // (undocumented) - retryConfig(config: ScheduleRetryConfig): ScheduleBuilder; - // (undocumented) - timeZone(timeZone: string): ScheduleBuilder; -} - -// @public -export interface ScheduleRetryConfig { - // (undocumented) - maxBackoffDuration?: string; - // (undocumented) - maxDoublings?: number; - // (undocumented) - maxRetryDuration?: string; - // (undocumented) - minBackoffDuration?: string; - // (undocumented) - retryCount?: number; -} - -// @public (undocumented) -function _scheduleWithOptions(schedule: string, options: DeploymentOptions): ScheduleBuilder; - -// @public (undocumented) -const service = "app-measurement.com"; - -// @public (undocumented) -const service_2 = "firebaseauth.googleapis.com"; - -// @public (undocumented) -const service_3 = "firebaseio.com"; - -// @public (undocumented) -const service_4 = "firestore.googleapis.com"; - -// @public (undocumented) -const service_5 = "firebaseremoteconfig.googleapis.com"; - -// @public (undocumented) -const service_6 = "storage.googleapis.com"; - -// @public (undocumented) -const service_7 = "pubsub.googleapis.com"; - -// @public (undocumented) -function snapshotConstructor(event: Event): DocumentSnapshot; - -declare namespace storage { - export { - bucket, - object, - _bucketWithOptions, - _objectWithOptions, - provider_6 as provider, - service_6 as service, - BucketBuilder, - ObjectBuilder, - ObjectMetadata - } -} -export { storage } - -// @public -export const SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]; - -// @public -interface TemplateVersion { - description: string; - rollbackSource?: number; - updateOrigin: string; - updateTime: string; - updateType: string; - updateUser: RemoteConfigUser; - versionNumber: number; -} - -declare namespace testLab { - export { - testMatrix, - TestMatrixBuilder, - TestMatrix, - ClientInfo, - ResultStorage, - InvalidMatrixDetails, - TestState, - OutcomeSummary - } -} -export { testLab } - -// @public -class TestMatrix { - clientInfo: ClientInfo; - createTime: string; - invalidMatrixDetails?: InvalidMatrixDetails; - outcomeSummary?: OutcomeSummary; - resultStorage: ResultStorage; - state: TestState; - testMatrixId: string; -} - -// @public -function testMatrix(): TestMatrixBuilder; - -// @public -class TestMatrixBuilder { - onComplete(handler: (testMatrix: TestMatrix, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// @public -type TestState = 'VALIDATING' | 'PENDING' | 'FINISHED' | 'ERROR' | 'INVALID'; - -// @public -function topic(topic: string): TopicBuilder; - -// @public -class TopicBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onPublish(handler: (message: Message, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// @public (undocumented) -function _topicWithOptions(topic: string, options: DeploymentOptions): TopicBuilder; - -// @public -export interface TriggerAnnotated { - // (undocumented) - __trigger: { - availableMemoryMb?: number; - eventTrigger?: { - eventType: string; - resource: string; - service: string; - }; - failurePolicy?: FailurePolicy; - httpsTrigger?: { - invoker?: string[]; - }; - labels?: { - [key: string]: string; - }; - regions?: string[]; - schedule?: Schedule; - timeout?: Duration; - vpcConnector?: string; - vpcConnectorEgressSettings?: string; - serviceAccountEmail?: string; - ingressSettings?: string; - }; -} - -// @public -class UpdateBuilder { - constructor(triggerResource: () => string, options: DeploymentOptions); - onUpdate(handler: (version: TemplateVersion, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// @public -function user(): UserBuilder; - -// @public -class UserBuilder { - constructor(triggerResource: () => string, options?: DeploymentOptions); - onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike | any): CloudFunction; - onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike | any): CloudFunction; -} - -// @public -class UserDimensions { - constructor(wireFormat: any); - appInfo?: AppInfo; - bundleInfo: ExportBundleInfo; - deviceInfo: DeviceInfo; - firstOpenTime?: string; - geoInfo: GeoInfo; - userId?: string; - userProperties: { - [key: string]: UserPropertyValue; - }; -} - -// @public -type UserInfo = firebase.auth.UserInfo; - -// @public -class UserPropertyValue { - constructor(wireFormat: any); - setTime: string; - value: string; -} - -// @public -type UserRecord = firebase.auth.UserRecord; - -// @public (undocumented) -function userRecordConstructor(wireData: Object): firebase.auth.UserRecord; - -// @public (undocumented) -class UserRecordMetadata implements firebase.auth.UserMetadata { - constructor(creationTime: string, lastSignInTime: string); - // (undocumented) - creationTime: string; - // (undocumented) - lastSignInTime: string; - toJSON(): { - creationTime: string; - lastSignInTime: string; - }; -} - -// @public (undocumented) -function _userWithOptions(options: DeploymentOptions): UserBuilder; - -// @public -export const VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]; - -// @public -export const VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]; - -// @public -function warn(...args: any[]): void; - -// @public -function write(entry: LogEntry): void; - -// Warnings were encountered during analysis: -// -// lib/cloud-functions.d.ts:196:9 - (ae-forgotten-export) The symbol "Duration" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) - -``` diff --git a/docgen/v2/firebase-functions.api.json b/docgen/v2/firebase-functions.api.json deleted file mode 100644 index 999d49045..000000000 --- a/docgen/v2/firebase-functions.api.json +++ /dev/null @@ -1,3668 +0,0 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.18.7", - "schemaVersion": 1004, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - } - } - }, - "kind": "Package", - "canonicalReference": "firebase-functions!", - "docComment": "", - "name": "firebase-functions", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "firebase-functions!", - "name": "", - "members": [ - { - "kind": "Interface", - "canonicalReference": "firebase-functions!CloudEvent:interface", - "docComment": "/**\n * A CloudEvent is a cross-platform format for encoding a serverless event. More information can be found in https://github.com/cloudevents/spec\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CloudEvent " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "CloudEvent", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#data:member", - "docComment": "/**\n * Information about this specific event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "data: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#id:member", - "docComment": "/**\n * A globally unique ID for this event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#params:member", - "docComment": "/**\n * A map of template parameter name to value for subject strings.\n *\n * This map is only available on some event types that allow templates in the subject string, such as Firestore. When listening to a document template \"/users/{uid}\", an event with subject \"/documents/users/1234\" would have a params of {\"uid\": \"1234\"}.\n *\n * Params are generated inside the firebase-functions SDK and are not part of the CloudEvents spec nor the payload that a Cloud Function actually receives.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "params?: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "params", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#source:member", - "docComment": "/**\n * The resource which published this event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "source: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "source", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#specversion:member", - "docComment": "/**\n * Version of the CloudEvents spec for this event.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly specversion: " - }, - { - "kind": "Content", - "text": "'1.0'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "specversion", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#subject:member", - "docComment": "/**\n * The resource, provided by source, that this event relates to\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "subject?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "subject", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#time:member", - "docComment": "/**\n * When this event occurred.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "time: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "time", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudEvent#type:member", - "docComment": "/**\n * The type of event that this represents.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!CloudFunction:interface", - "docComment": "/**\n * A handler for CloudEvents.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CloudFunction " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "CloudFunction", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!CloudFunction#__trigger:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "__trigger: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "__trigger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "CallSignature", - "canonicalReference": "firebase-functions!CloudFunction:call(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "(raw: " - }, - { - "kind": "Reference", - "text": "CloudEvent", - "canonicalReference": "firebase-functions!CloudEvent:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "raw", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ] - }, - { - "kind": "MethodSignature", - "canonicalReference": "firebase-functions!CloudFunction#run:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "run(event: " - }, - { - "kind": "Reference", - "text": "CloudEvent", - "canonicalReference": "firebase-functions!CloudEvent:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "event", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "name": "run" - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!GlobalOptions:interface", - "docComment": "/**\n * GlobalOptions are options that can be set across an entire project. These options are common to HTTPS and Event handling functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface GlobalOptions " - } - ], - "releaseTag": "Public", - "name": "GlobalOptions", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#concurrency:member", - "docComment": "/**\n * Number of requests a function can serve at once. Can only be applied to functions running on Cloud Functions v2. A value of null restores the default concurrency.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "concurrency?: " - }, - { - "kind": "Content", - "text": "number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "concurrency", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#ingressSettings:member", - "docComment": "/**\n * Ingress settings which control where this function can be called from. A value of null turns off ingress settings.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ingressSettings?: " - }, - { - "kind": "Reference", - "text": "IngressSetting", - "canonicalReference": "firebase-functions!IngressSetting:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "ingressSettings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#invoker:member", - "docComment": "/**\n * Invoker to set access control on https functions.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "invoker?: " - }, - { - "kind": "Content", - "text": "'public' | 'private' | string | string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "invoker", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#labels:member", - "docComment": "/**\n * User labels to set on the function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "labels?: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "labels", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#maxInstances:member", - "docComment": "/**\n * Max number of instances to be running in parallel. A value of null restores the default max instances.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "maxInstances?: " - }, - { - "kind": "Content", - "text": "number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "maxInstances", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#memory:member", - "docComment": "/**\n * Amount of memory to allocate to a function. A value of null restores the defaults of 256MB.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "memory?: " - }, - { - "kind": "Reference", - "text": "MemoryOption", - "canonicalReference": "firebase-functions!MemoryOption:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "memory", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#minInstances:member", - "docComment": "/**\n * Min number of actual instances to be running at a given time. Instances will be billed for memory allocation and 10% of CPU allocation while idle. A value of null restores the default min instances.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "minInstances?: " - }, - { - "kind": "Content", - "text": "number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "minInstances", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#region:member", - "docComment": "/**\n * Region where functions should be deployed. HTTP functions can override and specify more than one region.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "region?: " - }, - { - "kind": "Reference", - "text": "SupportedRegion", - "canonicalReference": "firebase-functions!SupportedRegion:type" - }, - { - "kind": "Content", - "text": " | string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "region", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#serviceAccount:member", - "docComment": "/**\n * Specific service account for the function to run as. A value of null restores the default service account.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "serviceAccount?: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "serviceAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#timeoutSeconds:member", - "docComment": "/**\n * Timeout for the function in sections, possible values are 0 to 540. HTTPS functions can specify a higher timeout. A value of null restores the default of 60s\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timeoutSeconds?: " - }, - { - "kind": "Content", - "text": "number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "timeoutSeconds", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#vpcConnector:member", - "docComment": "/**\n * Connect cloud function to specified VPC connector. A value of null removes the VPC connector\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vpcConnector?: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "vpcConnector", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!GlobalOptions#vpcConnectorEgressSettings:member", - "docComment": "/**\n * Egress settings for VPC connector. A value of null turns off VPC connector egress settings\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vpcConnectorEgressSettings?: " - }, - { - "kind": "Reference", - "text": "VpcEgressSetting", - "canonicalReference": "firebase-functions!VpcEgressSetting:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "vpcConnectorEgressSettings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!https:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "https", - "members": [ - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.CallableFunction:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CallableFunction extends " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Return", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "CallableFunction", - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "firebase-functions!https.CallableFunction#run:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "run(data: " - }, - { - "kind": "Reference", - "text": "CallableRequest", - "canonicalReference": "firebase-functions!CallableRequest:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "Return" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "name": "run" - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.CallableRequest:interface", - "docComment": "/**\n * The request used to call a callable function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CallableRequest " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "CallableRequest", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableRequest#app:member", - "docComment": "/**\n * The result of decoding and verifying a Firebase AppCheck token.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "app?: " - }, - { - "kind": "Reference", - "text": "AppCheckData", - "canonicalReference": "firebase-functions!AppCheckData:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "app", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableRequest#auth:member", - "docComment": "/**\n * The result of decoding and verifying a Firebase Auth ID token.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "auth?: " - }, - { - "kind": "Reference", - "text": "AuthData", - "canonicalReference": "firebase-functions!AuthData:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "auth", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableRequest#data:member", - "docComment": "/**\n * The parameters used by a client when calling this function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "data: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableRequest#instanceIdToken:member", - "docComment": "/**\n * An unverified token for a Firebase Instance ID.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "instanceIdToken?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "instanceIdToken", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.CallableRequest#rawRequest:member", - "docComment": "/**\n * The raw request handled by the callable.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "rawRequest: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "rawRequest", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!https.FunctionsErrorCode:type", - "docComment": "/**\n * The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md\n *\n * Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FunctionsErrorCode = " - }, - { - "kind": "Content", - "text": "'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FunctionsErrorCode", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "firebase-functions!https.HttpsError:class", - "docComment": "/**\n * An explicit error that can be thrown from a handler to send an error to the client that called the function.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class HttpsError extends " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "HttpsError", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!https.HttpsError:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `HttpsError` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(code: " - }, - { - "kind": "Reference", - "text": "FunctionsErrorCode", - "canonicalReference": "firebase-functions!FunctionsErrorCode:type" - }, - { - "kind": "Content", - "text": ", message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", details?: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "code", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "details", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#code:member", - "docComment": "/**\n * A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly code: " - }, - { - "kind": "Reference", - "text": "FunctionsErrorCode", - "canonicalReference": "firebase-functions!FunctionsErrorCode:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "code", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#details:member", - "docComment": "/**\n * Extra data to be converted to JSON and included in the error response.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly details: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "details", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!https.HttpsError#httpErrorCode:member", - "docComment": "/**\n * A wire format representation of a provided error code.\n *\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly httpErrorCode: " - }, - { - "kind": "Reference", - "text": "HttpErrorCode", - "canonicalReference": "firebase-functions!~HttpErrorCode:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "httpErrorCode", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!https.HttpsError#toJSON:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Reference", - "text": "HttpErrorWireFormat", - "canonicalReference": "firebase-functions!~HttpErrorWireFormat:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!https.HttpsFunction:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type HttpsFunction = " - }, - { - "kind": "Content", - "text": "((req: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", res: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ") & {\n __trigger: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "HttpsFunction", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.HttpsOptions:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface HttpsOptions extends " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "HttpsOptions", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.HttpsOptions#cors:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "cors?: " - }, - { - "kind": "Content", - "text": "string | boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "cors", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.HttpsOptions#region:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "region?: " - }, - { - "kind": "Content", - "text": "options." - }, - { - "kind": "Reference", - "text": "SupportedRegion", - "canonicalReference": "firebase-functions!SupportedRegion:type" - }, - { - "kind": "Content", - "text": " | string | " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "region", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 5 - } - ] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onCall:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onCall" - }, - { - "kind": "Content", - "text": ">(opts: " - }, - { - "kind": "Reference", - "text": "HttpsOptions", - "canonicalReference": "firebase-functions!HttpsOptions:interface" - }, - { - "kind": "Content", - "text": ", handler: " - }, - { - "kind": "Content", - "text": "(request: " - }, - { - "kind": "Reference", - "text": "CallableRequest", - "canonicalReference": "firebase-functions!CallableRequest:interface" - }, - { - "kind": "Content", - "text": ") => Return" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CallableFunction", - "canonicalReference": "firebase-functions!CallableFunction:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "opts", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - } - }, - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 12 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "typeParameterName": "Return", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - } - } - ], - "name": "onCall" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onCall:function(2)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onCall" - }, - { - "kind": "Content", - "text": ">(handler: " - }, - { - "kind": "Content", - "text": "(request: " - }, - { - "kind": "Reference", - "text": "CallableRequest", - "canonicalReference": "firebase-functions!CallableRequest:interface" - }, - { - "kind": "Content", - "text": ") => Return" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CallableFunction", - "canonicalReference": "firebase-functions!CallableFunction:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 10 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "typeParameterName": "Return", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - } - } - ], - "name": "onCall" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onRequest:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onRequest(opts: " - }, - { - "kind": "Reference", - "text": "HttpsOptions", - "canonicalReference": "firebase-functions!HttpsOptions:interface" - }, - { - "kind": "Content", - "text": ", handler: " - }, - { - "kind": "Content", - "text": "(request: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", response: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "opts", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 10 - } - } - ], - "name": "onRequest" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!https.onRequest:function(2)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onRequest(handler: " - }, - { - "kind": "Content", - "text": "(request: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "firebase-functions!Request:interface" - }, - { - "kind": "Content", - "text": ", response: " - }, - { - "kind": "Reference", - "text": "express.Response", - "canonicalReference": "@types/express!~e.Response:interface" - }, - { - "kind": "Content", - "text": ") => void | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "HttpsFunction", - "canonicalReference": "firebase-functions!HttpsFunction:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - } - ], - "name": "onRequest" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!https.Request:interface", - "docComment": "/**\n * @hidden\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Request extends " - }, - { - "kind": "Reference", - "text": "express.Request", - "canonicalReference": "@types/express!~e.Request:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Request", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!https.Request#rawBody:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "rawBody: " - }, - { - "kind": "Reference", - "text": "Buffer", - "canonicalReference": "!Buffer:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "rawBody", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - } - ] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!logger:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "logger", - "members": [ - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.debug:function(1)", - "docComment": "/**\n * Writes a `DEBUG` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function debug(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "debug" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.error:function(1)", - "docComment": "/**\n * Writes an `ERROR` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function error(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "error" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.info:function(1)", - "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function info(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "info" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.log:function(1)", - "docComment": "/**\n * Writes an `INFO` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function log(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "log" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!logger.LogEntry:interface", - "docComment": "/**\n * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging) entry. All keys aside from `severity` and `message` are included in the `jsonPayload` of the logged entry.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogEntry " - } - ], - "releaseTag": "Public", - "name": "LogEntry", - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "firebase-functions!logger.LogEntry:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!logger.LogEntry#message:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "message?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!logger.LogEntry#severity:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "severity: " - }, - { - "kind": "Reference", - "text": "LogSeverity", - "canonicalReference": "firebase-functions!LogSeverity:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "severity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!logger.LogSeverity:type", - "docComment": "/**\n * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type LogSeverity = " - }, - { - "kind": "Content", - "text": "'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "LogSeverity", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.warn:function(1)", - "docComment": "/**\n * Writes a `WARNING` severity log. If the last argument provided is a plain object, it is added to the `jsonPayload` in the Cloud Logging entry.\n *\n * @param args - Arguments, concatenated into the log message with space separators.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function warn(...args: " - }, - { - "kind": "Content", - "text": "any[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "warn" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!logger.write:function(1)", - "docComment": "/**\n * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).\n *\n * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function write(entry: " - }, - { - "kind": "Reference", - "text": "LogEntry", - "canonicalReference": "firebase-functions!LogEntry:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "entry", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "write" - } - ] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!params:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "params", - "members": [ - { - "kind": "Variable", - "canonicalReference": "firebase-functions!params.declaredParams:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declaredParams: " - }, - { - "kind": "Reference", - "text": "Param", - "canonicalReference": "firebase-functions!Param:class" - }, - { - "kind": "Content", - "text": "[]" - } - ], - "releaseTag": "Public", - "name": "declaredParams", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineBoolean:function(1)", - "docComment": "/**\n * Declare a boolean param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `boolean` return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineBoolean(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "BooleanParam", - "canonicalReference": "firebase-functions!BooleanParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "defineBoolean" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineFloat:function(1)", - "docComment": "/**\n * Declare a float param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `number` return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineFloat(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "FloatParam", - "canonicalReference": "firebase-functions!FloatParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "defineFloat" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineInt:function(1)", - "docComment": "/**\n * Declare an integer param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `number` return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineInt(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "IntParam", - "canonicalReference": "firebase-functions!IntParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "defineInt" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineJSON:function(1)", - "docComment": "/**\n * Declare a JSON param. The associated environment variable will be treated as a JSON string when loading its value.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a specifiable return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineJSON(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "JSONParam", - "canonicalReference": "firebase-functions!JSONParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "defineJSON" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineList:function(1)", - "docComment": "/**\n * Declare a list param (array of strings).\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `string[]` return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineList(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ListParam", - "canonicalReference": "firebase-functions!ListParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "defineList" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!params.defineString:function(1)", - "docComment": "/**\n * Declare a string param.\n *\n * @param name - The name of the environment variable to use to load the param.\n *\n * @param options - Configuration options for the param.\n *\n * @returns A Param with a `string` return type for `.value`.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function defineString(name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "ParamOptions", - "canonicalReference": "firebase-functions!ParamOptions:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "StringParam", - "canonicalReference": "firebase-functions!StringParam:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "defineString" - }, - { - "kind": "TypeAlias", - "canonicalReference": "firebase-functions!params.ParamOptions:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type ParamOptions = " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ParamSpec", - "canonicalReference": "firebase-functions!ParamSpec:interface" - }, - { - "kind": "Content", - "text": ", 'valueType'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "ParamOptions", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - } - ] - }, - { - "kind": "Namespace", - "canonicalReference": "firebase-functions!pubsub:namespace", - "docComment": "", - "excerptTokens": [], - "releaseTag": "None", - "name": "pubsub", - "members": [ - { - "kind": "Class", - "canonicalReference": "firebase-functions!pubsub.Message:class", - "docComment": "/**\n * Interface representing a Google Cloud Pub/Sub message.\n *\n * @param data - Payload of a Pub/Sub message.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Message " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "Message", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firebase-functions!pubsub.Message:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(data: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#attributes:member", - "docComment": "/**\n * User-defined attributes published with the message, if any.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly attributes: " - }, - { - "kind": "Content", - "text": "{\n [key: string]: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "attributes", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#data:member", - "docComment": "/**\n * The data payload of this message object as a base64-encoded string.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly data: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#json:member", - "docComment": "/**\n * The JSON data payload of this message object, if any.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "get json(): " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "json", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#messageId:member", - "docComment": "/**\n * Autogenerated ID that uniquely identifies this message.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly messageId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "messageId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#orderingKey:member", - "docComment": "/**\n * User-defined key used to ensure ordering amongst messages with the same key.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly orderingKey: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "orderingKey", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "firebase-functions!pubsub.Message#publishTime:member", - "docComment": "/**\n * Time the message was published\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly publishTime: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "publishTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "firebase-functions!pubsub.Message#toJSON:member(1)", - "docComment": "/**\n * Returns a JSON-serializable representation of this object.\n *\n * @return A JSON-serializable representation of this object.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "toJSON(): " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "toJSON" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!pubsub.MessagePublishedData:interface", - "docComment": "/**\n * The interface published in a Pub/Sub publish subscription.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface MessagePublishedData " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "MessagePublishedData", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!pubsub.MessagePublishedData#message:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly message: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "firebase-functions!Message:class" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!pubsub.MessagePublishedData#subscription:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly subscription: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "subscription", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub.onMessagePublished:function(1)", - "docComment": "/**\n * Handle a message being published to a Pub/Sub topic.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onMessagePublished(topic: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", handler: " - }, - { - "kind": "Content", - "text": "(event: " - }, - { - "kind": "Reference", - "text": "CloudEvent", - "canonicalReference": "firebase-functions!CloudEvent:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MessagePublishedData", - "canonicalReference": "firebase-functions!MessagePublishedData:interface" - }, - { - "kind": "Content", - "text": ">) => any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MessagePublishedData", - "canonicalReference": "firebase-functions!MessagePublishedData:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "topic", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 12 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "onMessagePublished" - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!pubsub.onMessagePublished:function(2)", - "docComment": "/**\n * Handle a message being published to a Pub/Sub topic.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function onMessagePublished(options: " - }, - { - "kind": "Reference", - "text": "PubSubOptions", - "canonicalReference": "firebase-functions!PubSubOptions:interface" - }, - { - "kind": "Content", - "text": ", handler: " - }, - { - "kind": "Content", - "text": "(event: " - }, - { - "kind": "Reference", - "text": "CloudEvent", - "canonicalReference": "firebase-functions!CloudEvent:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MessagePublishedData", - "canonicalReference": "firebase-functions!MessagePublishedData:interface" - }, - { - "kind": "Content", - "text": ">) => any | " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "CloudFunction", - "canonicalReference": "firebase-functions!CloudFunction:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MessagePublishedData", - "canonicalReference": "firebase-functions!MessagePublishedData:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 17 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 12 - } - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "onMessagePublished" - }, - { - "kind": "Interface", - "canonicalReference": "firebase-functions!pubsub.PubSubOptions:interface", - "docComment": "/**\n * PubSubOptions extend EventHandlerOptions but must include a topic.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface PubSubOptions extends " - }, - { - "kind": "Content", - "text": "options." - }, - { - "kind": "Reference", - "text": "EventHandlerOptions", - "canonicalReference": "firebase-functions!EventHandlerOptions:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "PubSubOptions", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "firebase-functions!pubsub.PubSubOptions#topic:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "topic: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "topic", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 4 - } - ] - } - ] - }, - { - "kind": "Function", - "canonicalReference": "firebase-functions!setGlobalOptions:function(1)", - "docComment": "/**\n * Sets default options for all functions written using the v2 SDK.\n *\n * @param options - Options to set as default\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function setGlobalOptions(options: " - }, - { - "kind": "Reference", - "text": "GlobalOptions", - "canonicalReference": "firebase-functions!GlobalOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "setGlobalOptions" - } - ] - } - ] -} diff --git a/docgen/v2/firebase-functions.api.md b/docgen/v2/firebase-functions.api.md deleted file mode 100644 index 879591ab0..000000000 --- a/docgen/v2/firebase-functions.api.md +++ /dev/null @@ -1,329 +0,0 @@ -## API Report File for "firebase-functions" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -/// - -import * as express from 'express'; -import * as firebase from 'firebase-admin'; - -// @public (undocumented) -function __getSpec(): { - globalOptions: GlobalOptions; - params: ParamSpec[]; -}; - -// @public (undocumented) -interface CallableFunction_2 extends HttpsFunction { - // (undocumented) - run(data: CallableRequest): Return; -} - -// @public -interface CallableRequest { - // Warning: (ae-forgotten-export) The symbol "AppCheckData" needs to be exported by the entry point index.d.ts - app?: AppCheckData; - // Warning: (ae-forgotten-export) The symbol "AuthData" needs to be exported by the entry point index.d.ts - auth?: AuthData; - data: T; - instanceIdToken?: string; - rawRequest: Request; -} - -// @public -export interface CloudEvent { - data: T; - id: string; - params?: Record; - source: string; - readonly specversion: '1.0'; - subject?: string; - time: string; - type: string; -} - -// @public -export interface CloudFunction { - // (undocumented) - (raw: CloudEvent): any | Promise; - // (undocumented) - __trigger: unknown; - // (undocumented) - run(event: CloudEvent): any | Promise; -} - -// @public -function debug(...args: any[]): void; - -// Warning: (ae-forgotten-export) The symbol "Param" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -const declaredParams: Param[]; - -// Warning: (ae-forgotten-export) The symbol "BooleanParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineBoolean(name: string, options?: ParamOptions): BooleanParam; - -// Warning: (ae-forgotten-export) The symbol "FloatParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineFloat(name: string, options?: ParamOptions): FloatParam; - -// Warning: (ae-forgotten-export) The symbol "IntParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineInt(name: string, options?: ParamOptions): IntParam; - -// Warning: (ae-forgotten-export) The symbol "JSONParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineJSON(name: string, options?: ParamOptions): JSONParam; - -// Warning: (ae-forgotten-export) The symbol "ListParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineList(name: string, options?: ParamOptions): ListParam; - -// Warning: (ae-forgotten-export) The symbol "StringParam" needs to be exported by the entry point index.d.ts -// -// @public -function defineString(name: string, options?: ParamOptions): StringParam; - -// @public -function error(...args: any[]): void; - -// @public -interface EventHandlerOptions extends GlobalOptions { - // (undocumented) - retry?: boolean; -} - -// @public -type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated'; - -// @public -export interface GlobalOptions { - concurrency?: number | null; - ingressSettings?: IngressSetting | null; - invoker?: 'public' | 'private' | string | string[]; - labels?: Record; - maxInstances?: number | null; - memory?: MemoryOption | null; - minInstances?: number | null; - region?: SupportedRegion | string; - serviceAccount?: string | null; - timeoutSeconds?: number | null; - vpcConnector?: string | null; - vpcConnectorEgressSettings?: VpcEgressSetting | null; -} - -declare namespace https { - export { - onRequest, - onCall, - Request, - CallableRequest, - FunctionsErrorCode, - HttpsError, - HttpsOptions, - HttpsFunction, - CallableFunction_2 as CallableFunction - } -} -export { https } - -// @public -class HttpsError extends Error { - constructor(code: FunctionsErrorCode, message: string, details?: unknown); - readonly code: FunctionsErrorCode; - readonly details: unknown; - // Warning: (ae-forgotten-export) The symbol "HttpErrorCode" needs to be exported by the entry point index.d.ts - readonly httpErrorCode: HttpErrorCode; - // Warning: (ae-forgotten-export) The symbol "HttpErrorWireFormat" needs to be exported by the entry point index.d.ts - // - // (undocumented) - toJSON(): HttpErrorWireFormat; -} - -// @public (undocumented) -type HttpsFunction = ((req: Request, res: express.Response) => void | Promise) & { - __trigger: unknown; -}; - -// Warning: (ae-forgotten-export) The symbol "options" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -interface HttpsOptions extends Omit { - // (undocumented) - cors?: string | boolean; - // (undocumented) - region?: options.SupportedRegion | string | Array; -} - -// @public -function info(...args: any[]): void; - -// @public (undocumented) -type IngressSetting = typeof SUPPORTED_INGRESS_SETTINGS[number]; - -// @public -function log(...args: any[]): void; - -// @public -interface LogEntry { - // (undocumented) - [key: string]: any; - // (undocumented) - message?: string; - // (undocumented) - severity: LogSeverity; -} - -declare namespace logger { - export { - write, - debug, - log, - info, - warn, - error, - LogSeverity, - LogEntry - } -} -export { logger } - -// @public -type LogSeverity = 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY'; - -// @public -const MAX_CONCURRENCY = 1000; - -// @public -const MAX_EVENT_TIMEOUT_SECONDS = 540; - -// @public -const MAX_HTTPS_TIMEOUT_SECONDS = 36000; - -// @public -type MemoryOption = typeof SUPPORTED_MEMORY_OPTIONS[number]; - -// @public -class Message { - constructor(data: any); - readonly attributes: { - [key: string]: string; - }; - readonly data: string; - get json(): T; - readonly messageId: string; - readonly orderingKey: string; - readonly publishTime: string; - toJSON(): any; -} - -// @public -interface MessagePublishedData { - // (undocumented) - readonly message: Message; - // (undocumented) - readonly subscription: string; -} - -// @public -const MIN_TIMEOUT_SECONDS = 1; - -// @public (undocumented) -function onCall>(opts: HttpsOptions, handler: (request: CallableRequest) => Return): CallableFunction_2; - -// @public (undocumented) -function onCall>(handler: (request: CallableRequest) => Return): CallableFunction_2; - -// @public -function onMessagePublished(topic: string, handler: (event: CloudEvent>) => any | Promise): CloudFunction>; - -// @public -function onMessagePublished(options: PubSubOptions, handler: (event: CloudEvent>) => any | Promise): CloudFunction>; - -// @public (undocumented) -function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise): HttpsFunction; - -// @public (undocumented) -function onRequest(handler: (request: Request, response: express.Response) => void | Promise): HttpsFunction; - -// @public (undocumented) -type ParamOptions = Omit, 'valueType'>; - -declare namespace params { - export { - defineString, - defineBoolean, - defineInt, - defineFloat, - defineList, - defineJSON, - ParamOptions, - declaredParams - } -} -export { params } - -declare namespace pubsub { - export { - onMessagePublished, - Message, - MessagePublishedData, - PubSubOptions - } -} -export { pubsub } - -// @public -interface PubSubOptions extends options.EventHandlerOptions { - // (undocumented) - topic: string; -} - -// @public (undocumented) -interface Request extends express.Request { - // (undocumented) - rawBody: Buffer; -} - -// @public -export function setGlobalOptions(options: GlobalOptions): void; - -// @public -const SUPPORTED_INGRESS_SETTINGS: readonly ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]; - -// @public -const SUPPORTED_MEMORY_OPTIONS: readonly ["256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]; - -// @public -const SUPPORTED_REGIONS: readonly ["us-west1"]; - -// @public -const SUPPORTED_VPC_EGRESS_SETTINGS: readonly ["PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]; - -// @public -type SupportedRegion = typeof SUPPORTED_REGIONS[number]; - -// @public -type VpcEgressSetting = typeof SUPPORTED_VPC_EGRESS_SETTINGS[number]; - -// @public -function warn(...args: any[]): void; - -// @public -function write(entry: LogEntry): void; - -// Warnings were encountered during analysis: -// -// lib/v2/options.d.ts:131:5 - (ae-forgotten-export) The symbol "ParamSpec" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) - -``` diff --git a/package-lock.json b/package-lock.json index 16140eff4..56e8c1ebf 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,6 +20,9 @@ "firebase-functions": "lib/bin/firebase-functions.js" }, "devDependencies": { + "@firebase/api-documenter": "^0.1.2", + "@microsoft/api-documenter": "^7.13.45", + "@microsoft/api-extractor": "^7.18.7", "@types/chai": "^4.1.7", "@types/chai-as-promised": "^7.1.0", "@types/jsonwebtoken": "^8.3.2", @@ -110,6 +113,49 @@ "node": ">=12" } }, + "node_modules/@firebase/api-documenter": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.1.2.tgz", + "integrity": "sha512-aDofRZebqbMzrbo5WAi9f21qUTzhIub7yOszirik3AwujqOzcUr1F7lIFrI41686JD1Zw56lLL/B5EWZTwvVjA==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0", + "@rushstack/ts-command-line": "4.7.8", + "api-extractor-model-me": "0.1.1", + "colors": "~1.2.1", + "js-yaml": "4.0.0", + "resolve": "~1.17.0", + "tslib": "^2.1.0" + }, + "bin": { + "api-documenter-fire": "dist/start.js" + } + }, + "node_modules/@firebase/api-documenter/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/@firebase/api-documenter/node_modules/js-yaml": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.0.0.tgz", + "integrity": "sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@firebase/api-documenter/node_modules/tslib": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", + "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", + "dev": true + }, "node_modules/@firebase/app-types": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.7.0.tgz", @@ -563,6 +609,335 @@ "node": ">=10" } }, + "node_modules/@microsoft/api-documenter": { + "version": "7.17.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.17.0.tgz", + "integrity": "sha512-rIZcfDkBsWsflvN1n0tVgIUdivV7slBIsN0WyK8gUG1MjK7dv+rbAB5QPLhg3dPvbXLgPLanJCFwoO2yFdxs+A==", + "dev": true, + "dependencies": { + "@microsoft/api-extractor-model": "7.16.0", + "@microsoft/tsdoc": "0.13.2", + "@rushstack/node-core-library": "3.45.1", + "@rushstack/ts-command-line": "4.10.7", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "bin": { + "api-documenter": "bin/api-documenter" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "node_modules/@microsoft/api-documenter/node_modules/@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@rushstack/ts-command-line": { + "version": "4.10.7", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.7.tgz", + "integrity": "sha512-CjS+DfNXUSO5Ab2wD1GBGtUTnB02OglRWGqfaTcac9Jn45V5MeUOsq/wA8wEeS5Y/3TZ2P1k+IWdVDiuOFP9Og==", + "dev": true, + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "node_modules/@microsoft/api-documenter/node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } + }, + "node_modules/@microsoft/api-extractor": { + "version": "7.20.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.20.0.tgz", + "integrity": "sha512-WKAu5JpkRXWKL3AyxmFXuwNNPpBlsAefwZIDl8M5mhEqRji4w+gexb0pku3Waa0flm3vm0Cwpm+kGYYJ4/gzAA==", + "dev": true, + "dependencies": { + "@microsoft/api-extractor-model": "7.16.0", + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.45.1", + "@rushstack/rig-package": "0.3.8", + "@rushstack/ts-command-line": "4.10.7", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.5.2" + }, + "bin": { + "api-extractor": "bin/api-extractor" + } + }, + "node_modules/@microsoft/api-extractor-model": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.16.0.tgz", + "integrity": "sha512-0FOrbNIny8mzBrzQnSIkEjAXk0JMSnPmWYxt3ZDTPVg9S8xIPzB6lfgTg9+Mimu0RKCpGKBpd+v2WcR5vGzyUQ==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.45.1" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "node_modules/@microsoft/api-extractor-model/node_modules/validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "node_modules/@microsoft/api-extractor/node_modules/@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@rushstack/ts-command-line": { + "version": "4.10.7", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.7.tgz", + "integrity": "sha512-CjS+DfNXUSO5Ab2wD1GBGtUTnB02OglRWGqfaTcac9Jn45V5MeUOsq/wA8wEeS5Y/3TZ2P1k+IWdVDiuOFP9Og==", + "dev": true, + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "node_modules/@microsoft/api-extractor/node_modules/typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } + }, + "node_modules/@microsoft/tsdoc": { + "version": "0.12.24", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.24.tgz", + "integrity": "sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg==", + "dev": true + }, + "node_modules/@microsoft/tsdoc-config": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.15.2.tgz", + "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.13.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "node_modules/@microsoft/tsdoc-config/node_modules/@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "node_modules/@microsoft/tsdoc-config/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "dependencies": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/@panva/asn1.js": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@panva/asn1.js/-/asn1.js-1.0.0.tgz", @@ -646,6 +1021,63 @@ "dev": true, "optional": true }, + "node_modules/@rushstack/node-core-library": { + "version": "3.36.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.36.0.tgz", + "integrity": "sha512-bID2vzXpg8zweXdXgQkKToEdZwVrVCN9vE9viTRk58gqzYaTlz4fMId6V3ZfpXN6H0d319uGi2KDlm+lUEeqCg==", + "dev": true, + "dependencies": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "node_modules/@rushstack/rig-package": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.8.tgz", + "integrity": "sha512-MDWg1xovea99PWloSiYMjFcCLsrdjFtYt6aOyHNs5ojn5mxrzR6U9F83hvbQjTWnKPMvZtr0vcek+4n+OQOp3Q==", + "dev": true, + "dependencies": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + } + }, + "node_modules/@rushstack/rig-package/node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@rushstack/ts-command-line": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.7.8.tgz", + "integrity": "sha512-8ghIWhkph7NnLCMDJtthpsb7TMOsVGXVDvmxjE/CeklTqjbbUFBjGXizJfpbEkRQTELuZQ2+vGn7sGwIWKN2uA==", + "dev": true, + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, "node_modules/@sinonjs/commons": { "version": "1.8.1", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.1.tgz", @@ -716,6 +1148,12 @@ "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", "dev": true }, + "node_modules/@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "node_modules/@types/body-parser": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", @@ -1044,6 +1482,16 @@ "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", "dev": true }, + "node_modules/api-extractor-model-me": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/api-extractor-model-me/-/api-extractor-model-me-0.1.1.tgz", + "integrity": "sha512-Ez801ZMADfkseOWNRFquvyQYDm3D9McpxfkKMWL6JFCGcpub0miJ+TFNphIR1nSZbrsxz3kIeOovNMY4VlL6Bw==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + } + }, "node_modules/arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -1442,6 +1890,15 @@ "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", "dev": true }, + "node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -1941,6 +2398,19 @@ "prettier": ">= 0.11.0" } }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/estraverse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", @@ -2193,6 +2663,20 @@ "node": ">= 0.6" } }, + "node_modules/fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -2433,8 +2917,7 @@ "version": "4.2.4", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==", - "dev": true, - "optional": true + "dev": true }, "node_modules/growl": { "version": "1.10.5", @@ -2726,6 +3209,15 @@ "node": ">=0.10.0" } }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -2789,6 +3281,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-date-object": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.2.tgz", @@ -2906,6 +3410,12 @@ "integrity": "sha512-5IZ7sY9dBAYSV+YjQ0Ovb540Ku7AO9Z5o2Cg789xj167iQuZ2cG+z0f3Uct6WeYLbU6aQiM2pCs7sZ+4dotydw==", "dev": true }, + "node_modules/jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true + }, "node_modules/jose": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/jose/-/jose-2.0.5.tgz", @@ -3073,6 +3583,15 @@ "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", "dev": true }, + "node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -3258,6 +3777,12 @@ "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", "dev": true }, + "node_modules/lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true + }, "node_modules/lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", @@ -3270,6 +3795,12 @@ "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=", "dev": true }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true + }, "node_modules/lodash.isinteger": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", @@ -4595,6 +5126,18 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", @@ -4926,6 +5469,15 @@ ], "optional": true }, + "node_modules/string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true, + "engines": { + "node": ">=0.6.19" + } + }, "node_modules/string-width": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", @@ -5037,6 +5589,12 @@ "node": ">=0.8" } }, + "node_modules/timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=", + "dev": true + }, "node_modules/toidentifier": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", @@ -5437,6 +5995,15 @@ "node": ">=8" } }, + "node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, "node_modules/unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -5485,6 +6052,15 @@ "integrity": "sha512-mpSYqfsFvASnSn5qMiwrr4VKfumbPyONLCOPmsR3A6pTY/r0+tSaVbgPWSAIuzbk3lCTa+FForeTiO+wBQGkjA==", "dev": true }, + "node_modules/validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -6055,6 +6631,23 @@ "funding": { "url": "https://github.com/sponsors/sindresorhus" } + }, + "node_modules/z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dev": true, + "dependencies": { + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } } }, "dependencies": { @@ -6099,6 +6692,45 @@ "@cspotcode/source-map-consumer": "0.8.0" } }, + "@firebase/api-documenter": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.1.2.tgz", + "integrity": "sha512-aDofRZebqbMzrbo5WAi9f21qUTzhIub7yOszirik3AwujqOzcUr1F7lIFrI41686JD1Zw56lLL/B5EWZTwvVjA==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0", + "@rushstack/ts-command-line": "4.7.8", + "api-extractor-model-me": "0.1.1", + "colors": "~1.2.1", + "js-yaml": "4.0.0", + "resolve": "~1.17.0", + "tslib": "^2.1.0" + }, + "dependencies": { + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "js-yaml": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.0.0.tgz", + "integrity": "sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==", + "dev": true, + "requires": { + "argparse": "^2.0.1" + } + }, + "tslib": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", + "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", + "dev": true + } + } + }, "@firebase/app-types": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.7.0.tgz", @@ -6492,6 +7124,287 @@ } } }, + "@microsoft/api-documenter": { + "version": "7.17.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.17.0.tgz", + "integrity": "sha512-rIZcfDkBsWsflvN1n0tVgIUdivV7slBIsN0WyK8gUG1MjK7dv+rbAB5QPLhg3dPvbXLgPLanJCFwoO2yFdxs+A==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.16.0", + "@microsoft/tsdoc": "0.13.2", + "@rushstack/node-core-library": "3.45.1", + "@rushstack/ts-command-line": "4.10.7", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.7", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.7.tgz", + "integrity": "sha512-CjS+DfNXUSO5Ab2wD1GBGtUTnB02OglRWGqfaTcac9Jn45V5MeUOsq/wA8wEeS5Y/3TZ2P1k+IWdVDiuOFP9Og==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.20.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.20.0.tgz", + "integrity": "sha512-WKAu5JpkRXWKL3AyxmFXuwNNPpBlsAefwZIDl8M5mhEqRji4w+gexb0pku3Waa0flm3vm0Cwpm+kGYYJ4/gzAA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.16.0", + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.45.1", + "@rushstack/rig-package": "0.3.8", + "@rushstack/ts-command-line": "4.10.7", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.5.2" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.7", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.7.tgz", + "integrity": "sha512-CjS+DfNXUSO5Ab2wD1GBGtUTnB02OglRWGqfaTcac9Jn45V5MeUOsq/wA8wEeS5Y/3TZ2P1k+IWdVDiuOFP9Og==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "dev": true + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.16.0.tgz", + "integrity": "sha512-0FOrbNIny8mzBrzQnSIkEjAXk0JMSnPmWYxt3ZDTPVg9S8xIPzB6lfgTg9+Mimu0RKCpGKBpd+v2WcR5vGzyUQ==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.45.1" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.1.tgz", + "integrity": "sha512-BwdssTNe007DNjDBxJgInHg8ePytIPyT0La7ZZSQZF9+rSkT42AygXPGvbGsyFfEntjr4X37zZSJI7yGzL16cQ==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.2.tgz", + "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/tsdoc": { + "version": "0.12.24", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.24.tgz", + "integrity": "sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.15.2.tgz", + "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.13.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, "@panva/asn1.js": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@panva/asn1.js/-/asn1.js-1.0.0.tgz", @@ -6572,6 +7485,61 @@ "dev": true, "optional": true }, + "@rushstack/node-core-library": { + "version": "3.36.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.36.0.tgz", + "integrity": "sha512-bID2vzXpg8zweXdXgQkKToEdZwVrVCN9vE9viTRk58gqzYaTlz4fMId6V3ZfpXN6H0d319uGi2KDlm+lUEeqCg==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + } + } + }, + "@rushstack/rig-package": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.8.tgz", + "integrity": "sha512-MDWg1xovea99PWloSiYMjFcCLsrdjFtYt6aOyHNs5ojn5mxrzR6U9F83hvbQjTWnKPMvZtr0vcek+4n+OQOp3Q==", + "dev": true, + "requires": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.7.8.tgz", + "integrity": "sha512-8ghIWhkph7NnLCMDJtthpsb7TMOsVGXVDvmxjE/CeklTqjbbUFBjGXizJfpbEkRQTELuZQ2+vGn7sGwIWKN2uA==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, "@sinonjs/commons": { "version": "1.8.1", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.1.tgz", @@ -6639,6 +7607,12 @@ "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", "dev": true }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "@types/body-parser": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", @@ -6929,6 +7903,16 @@ "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", "dev": true }, + "api-extractor-model-me": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/api-extractor-model-me/-/api-extractor-model-me-0.1.1.tgz", + "integrity": "sha512-Ez801ZMADfkseOWNRFquvyQYDm3D9McpxfkKMWL6JFCGcpub0miJ+TFNphIR1nSZbrsxz3kIeOovNMY4VlL6Bw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + } + }, "arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -7263,6 +8247,12 @@ "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", "dev": true }, + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -7677,6 +8667,12 @@ "jest-docblock": "^21.0.0" } }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true + }, "estraverse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", @@ -7882,6 +8878,17 @@ "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=" }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -8079,8 +9086,7 @@ "version": "4.2.4", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==", - "dev": true, - "optional": true + "dev": true }, "growl": { "version": "1.10.5", @@ -8310,6 +9316,12 @@ "safer-buffer": ">= 2.1.2 < 3" } }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true + }, "imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -8355,6 +9367,15 @@ "integrity": "sha512-wliAfSzx6V+6WfMOmus1xy0XvSgf/dlStkvTfq7F0g4bOIW0PSUbnyse3NhDwdyYS1ozfUtAAySqTws3z9Eqgg==", "dev": true }, + "is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, "is-date-object": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.2.tgz", @@ -8442,6 +9463,12 @@ "integrity": "sha512-5IZ7sY9dBAYSV+YjQ0Ovb540Ku7AO9Z5o2Cg789xj167iQuZ2cG+z0f3Uct6WeYLbU6aQiM2pCs7sZ+4dotydw==", "dev": true }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true + }, "jose": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/jose/-/jose-2.0.5.tgz", @@ -8570,6 +9597,15 @@ "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", "dev": true }, + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, "jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -8732,6 +9768,12 @@ "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", "dev": true }, + "lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true + }, "lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", @@ -8744,6 +9786,12 @@ "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=", "dev": true }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true + }, "lodash.isinteger": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", @@ -9818,6 +10866,15 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, "retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", @@ -10087,6 +11144,12 @@ } } }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, "string-width": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", @@ -10177,6 +11240,12 @@ "thenify": ">= 3.1.0 < 4" } }, + "timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=", + "dev": true + }, "toidentifier": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", @@ -10450,6 +11519,12 @@ "crypto-random-string": "^2.0.0" } }, + "universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true + }, "unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -10489,6 +11564,12 @@ "integrity": "sha512-mpSYqfsFvASnSn5qMiwrr4VKfumbPyONLCOPmsR3A6pTY/r0+tSaVbgPWSAIuzbk3lCTa+FForeTiO+wBQGkjA==", "dev": true }, + "validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "dev": true + }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -10946,6 +12027,18 @@ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "optional": true + }, + "z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + } } } } diff --git a/package.json b/package.json index 6e95bf769..767b446c1 100644 --- a/package.json +++ b/package.json @@ -141,15 +141,12 @@ }, "scripts": { "apidocs": "node docgen/generate-docs.js", - "docgen:v1:extract": "api-extractor run -c docgen/api-extractor.v1.json --local", "docgen:v1:gen": "api-documenter-fire markdown -i docgen/v1 -o docgen/v1/markdown && api-documenter-fire toc -i docgen/v1 -o docgen/v1/markdown/toc -p /docs/reference/functions", "docgen:v1": "npm run docgen:v1:extract && npm run docgen:v1:gen", - "docgen:v2:extract": "api-extractor run -c docgen/api-extractor.v2.json --local", "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown && api-documenter-fire toc -i docgen/v2 -o docgen/v2/markdown/toc -p /docs/reference/functions/v2", "docgen:v2": "npm run docgen:v2:extract && npm run docgen:v2:gen", - "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack", "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json", "build": "tsc -p tsconfig.release.json", From 4a7fa243361b4ccceb5742bec49f51c2ec47284a Mon Sep 17 00:00:00 2001 From: Daniel Young Lee Date: Mon, 11 Apr 2022 12:42:23 -0700 Subject: [PATCH 3/5] Pretty --- docgen/api-extractor.base.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docgen/api-extractor.base.json b/docgen/api-extractor.base.json index 7fa698140..2938a396f 100644 --- a/docgen/api-extractor.base.json +++ b/docgen/api-extractor.base.json @@ -77,7 +77,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/tsconfig.json" */ - "tsconfigFilePath": "/tsconfig.release.json" + "tsconfigFilePath": "/tsconfig.release.json" /** * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. * The object must conform to the TypeScript tsconfig schema: From b5fc4ceb33da78c884e4da72742ffc64e1da6090 Mon Sep 17 00:00:00 2001 From: Daniel Young Lee Date: Mon, 2 May 2022 23:21:23 -0700 Subject: [PATCH 4/5] Update package-lock.json. --- package-lock.json | 210 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) diff --git a/package-lock.json b/package-lock.json index 8c1a85e25..4637ca27a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -156,12 +156,115 @@ "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", "dev": true }, + "node_modules/@firebase/app": { + "version": "0.7.22", + "resolved": "https://registry.npmjs.org/@firebase/app/-/app-0.7.22.tgz", + "integrity": "sha512-v3AXSCwAvZyIFzOGgPAYtzjltm1M9R4U4yqsIBPf5B4ryaT1EGK+3ETZUOckNl5y2YwdKRJVPDDore+B2xg0Ug==", + "dev": true, + "peer": true, + "dependencies": { + "@firebase/component": "0.5.13", + "@firebase/logger": "0.3.2", + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app-compat": { + "version": "0.1.23", + "resolved": "https://registry.npmjs.org/@firebase/app-compat/-/app-compat-0.1.23.tgz", + "integrity": "sha512-c0QOhU2UVxZ7N5++nLQgKZ899ZC8+/ESa8VCzsQDwBw1T3MFAD1cG40KhB+CGtp/uYk/w6Jtk8k0xyZu6O2LOg==", + "dev": true, + "peer": true, + "dependencies": { + "@firebase/app": "0.7.22", + "@firebase/component": "0.5.13", + "@firebase/logger": "0.3.2", + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app-compat/node_modules/@firebase/component": { + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/@firebase/component/-/component-0.5.13.tgz", + "integrity": "sha512-hxhJtpD8Ppf/VU2Rlos6KFCEV77TGIGD5bJlkPK1+B/WUe0mC6dTjW7KhZtXTc+qRBp9nFHWcsIORnT8liHP9w==", + "dev": true, + "peer": true, + "dependencies": { + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app-compat/node_modules/@firebase/logger": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/@firebase/logger/-/logger-0.3.2.tgz", + "integrity": "sha512-lzLrcJp9QBWpo40OcOM9B8QEtBw2Fk1zOZQdvv+rWS6gKmhQBCEMc4SMABQfWdjsylBcDfniD1Q+fUX1dcBTXA==", + "dev": true, + "peer": true, + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app-compat/node_modules/@firebase/util": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/@firebase/util/-/util-1.5.2.tgz", + "integrity": "sha512-YvBH2UxFcdWG2HdFnhxZptPl2eVFlpOyTH66iDo13JPEYraWzWToZ5AMTtkyRHVmu7sssUpQlU9igy1KET7TOw==", + "dev": true, + "peer": true, + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app-compat/node_modules/tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true, + "peer": true + }, "node_modules/@firebase/app-types": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.7.0.tgz", "integrity": "sha512-6fbHQwDv2jp/v6bXhBw2eSRbNBpxHcd1NBF864UksSMVIqIyri9qpJB1Mn6sGZE+bnDsSQBC5j2TbMxYsJQkQg==", "dev": true }, + "node_modules/@firebase/app/node_modules/@firebase/component": { + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/@firebase/component/-/component-0.5.13.tgz", + "integrity": "sha512-hxhJtpD8Ppf/VU2Rlos6KFCEV77TGIGD5bJlkPK1+B/WUe0mC6dTjW7KhZtXTc+qRBp9nFHWcsIORnT8liHP9w==", + "dev": true, + "peer": true, + "dependencies": { + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app/node_modules/@firebase/logger": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/@firebase/logger/-/logger-0.3.2.tgz", + "integrity": "sha512-lzLrcJp9QBWpo40OcOM9B8QEtBw2Fk1zOZQdvv+rWS6gKmhQBCEMc4SMABQfWdjsylBcDfniD1Q+fUX1dcBTXA==", + "dev": true, + "peer": true, + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app/node_modules/@firebase/util": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/@firebase/util/-/util-1.5.2.tgz", + "integrity": "sha512-YvBH2UxFcdWG2HdFnhxZptPl2eVFlpOyTH66iDo13JPEYraWzWToZ5AMTtkyRHVmu7sssUpQlU9igy1KET7TOw==", + "dev": true, + "peer": true, + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/app/node_modules/tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true, + "peer": true + }, "node_modules/@firebase/auth-interop-types": { "version": "0.1.6", "resolved": "https://registry.npmjs.org/@firebase/auth-interop-types/-/auth-interop-types-0.1.6.tgz", @@ -6731,6 +6834,113 @@ } } }, + "@firebase/app": { + "version": "0.7.22", + "resolved": "https://registry.npmjs.org/@firebase/app/-/app-0.7.22.tgz", + "integrity": "sha512-v3AXSCwAvZyIFzOGgPAYtzjltm1M9R4U4yqsIBPf5B4ryaT1EGK+3ETZUOckNl5y2YwdKRJVPDDore+B2xg0Ug==", + "dev": true, + "peer": true, + "requires": { + "@firebase/component": "0.5.13", + "@firebase/logger": "0.3.2", + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + }, + "dependencies": { + "@firebase/component": { + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/@firebase/component/-/component-0.5.13.tgz", + "integrity": "sha512-hxhJtpD8Ppf/VU2Rlos6KFCEV77TGIGD5bJlkPK1+B/WUe0mC6dTjW7KhZtXTc+qRBp9nFHWcsIORnT8liHP9w==", + "dev": true, + "peer": true, + "requires": { + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "@firebase/logger": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/@firebase/logger/-/logger-0.3.2.tgz", + "integrity": "sha512-lzLrcJp9QBWpo40OcOM9B8QEtBw2Fk1zOZQdvv+rWS6gKmhQBCEMc4SMABQfWdjsylBcDfniD1Q+fUX1dcBTXA==", + "dev": true, + "peer": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "@firebase/util": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/@firebase/util/-/util-1.5.2.tgz", + "integrity": "sha512-YvBH2UxFcdWG2HdFnhxZptPl2eVFlpOyTH66iDo13JPEYraWzWToZ5AMTtkyRHVmu7sssUpQlU9igy1KET7TOw==", + "dev": true, + "peer": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true, + "peer": true + } + } + }, + "@firebase/app-compat": { + "version": "0.1.23", + "resolved": "https://registry.npmjs.org/@firebase/app-compat/-/app-compat-0.1.23.tgz", + "integrity": "sha512-c0QOhU2UVxZ7N5++nLQgKZ899ZC8+/ESa8VCzsQDwBw1T3MFAD1cG40KhB+CGtp/uYk/w6Jtk8k0xyZu6O2LOg==", + "dev": true, + "peer": true, + "requires": { + "@firebase/app": "0.7.22", + "@firebase/component": "0.5.13", + "@firebase/logger": "0.3.2", + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + }, + "dependencies": { + "@firebase/component": { + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/@firebase/component/-/component-0.5.13.tgz", + "integrity": "sha512-hxhJtpD8Ppf/VU2Rlos6KFCEV77TGIGD5bJlkPK1+B/WUe0mC6dTjW7KhZtXTc+qRBp9nFHWcsIORnT8liHP9w==", + "dev": true, + "peer": true, + "requires": { + "@firebase/util": "1.5.2", + "tslib": "^2.1.0" + } + }, + "@firebase/logger": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/@firebase/logger/-/logger-0.3.2.tgz", + "integrity": "sha512-lzLrcJp9QBWpo40OcOM9B8QEtBw2Fk1zOZQdvv+rWS6gKmhQBCEMc4SMABQfWdjsylBcDfniD1Q+fUX1dcBTXA==", + "dev": true, + "peer": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "@firebase/util": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/@firebase/util/-/util-1.5.2.tgz", + "integrity": "sha512-YvBH2UxFcdWG2HdFnhxZptPl2eVFlpOyTH66iDo13JPEYraWzWToZ5AMTtkyRHVmu7sssUpQlU9igy1KET7TOw==", + "dev": true, + "peer": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true, + "peer": true + } + } + }, "@firebase/app-types": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.7.0.tgz", From 5ef1a52f9bea8c1af06878795897759979f914e5 Mon Sep 17 00:00:00 2001 From: Daniel Young Lee Date: Mon, 2 May 2022 23:25:07 -0700 Subject: [PATCH 5/5] Update package-lock.json --- package-lock.json | 540 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 536 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 4e1d204b0..5b5f7fc85 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,6 +45,48 @@ "@cspotcode/source-map-consumer": "0.8.0" } }, + "@firebase/api-documenter": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.1.2.tgz", + "integrity": "sha512-aDofRZebqbMzrbo5WAi9f21qUTzhIub7yOszirik3AwujqOzcUr1F7lIFrI41686JD1Zw56lLL/B5EWZTwvVjA==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0", + "@rushstack/ts-command-line": "4.7.8", + "api-extractor-model-me": "0.1.1", + "colors": "~1.2.1", + "js-yaml": "4.0.0", + "resolve": "~1.17.0", + "tslib": "^2.1.0" + }, + "dependencies": { + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "js-yaml": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.0.0.tgz", + "integrity": "sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==", + "dev": true, + "requires": { + "argparse": "^2.0.1" + } + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, "@firebase/app-types": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/@firebase/app-types/-/app-types-0.7.0.tgz", @@ -256,6 +298,296 @@ } } }, + "@microsoft/api-documenter": { + "version": "7.17.11", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.17.11.tgz", + "integrity": "sha512-VdCu4eG5RISGEiG/hFO3jaN3gEgMZVXZRFpch/PQzrLO3Vh2QhZTz2LsZ2SYyb7UwBZCK9Z76ULv5cGoflylNA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.1.tgz", + "integrity": "sha512-6Wci+Tp3CgPt/B9B0a3J4s3yMgLNSku6w5TV6mN+61C71UqsRBv2FUibBf3tPGlNxebgPHMEUzKpb1ggE8KCKw==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.4.tgz", + "integrity": "sha512-FMoEQWjK7nWAO2uFgV1eVpVhY9ZDGOdIIomi9zTej64cKJ+8/Nvu+ny0xKaUDEjw/ALftN2D2ml7L0RDpW/Z9g==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.10", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.10.tgz", + "integrity": "sha512-F+MH7InPDXqX40qvvcEsnvPpmg566SBpfFqj2fcCh8RjM6AyOoWlXc8zx7giBD3ZN85NVAEjZAgrcLU0z+R2yg==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.3.tgz", + "integrity": "sha512-sGvEcBOTNum68x9jCpCVGPFJ6mWnkD0YxOcddDlJHRx3tKdB2q8pCHExMVZo/AV/6geuVJXG7hljDaWG8+5GDw==", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.23.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.23.0.tgz", + "integrity": "sha512-fbdX05RVE1EMA7nvyRHuS9nx1pryhjgURDx6pQlE/9yOXQ5PO7MpYdfWGaRsQwyYuU3+tPxgro819c0R3AK6KA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/rig-package": "0.3.11", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.6.3" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.1.tgz", + "integrity": "sha512-6Wci+Tp3CgPt/B9B0a3J4s3yMgLNSku6w5TV6mN+61C71UqsRBv2FUibBf3tPGlNxebgPHMEUzKpb1ggE8KCKw==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.4.tgz", + "integrity": "sha512-FMoEQWjK7nWAO2uFgV1eVpVhY9ZDGOdIIomi9zTej64cKJ+8/Nvu+ny0xKaUDEjw/ALftN2D2ml7L0RDpW/Z9g==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.10", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.10.tgz", + "integrity": "sha512-F+MH7InPDXqX40qvvcEsnvPpmg566SBpfFqj2fcCh8RjM6AyOoWlXc8zx7giBD3ZN85NVAEjZAgrcLU0z+R2yg==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.3.tgz", + "integrity": "sha512-sGvEcBOTNum68x9jCpCVGPFJ6mWnkD0YxOcddDlJHRx3tKdB2q8pCHExMVZo/AV/6geuVJXG7hljDaWG8+5GDw==", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.17.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.17.2.tgz", + "integrity": "sha512-fYfCeBeLm7jnZligC64qHiH4/vzswFLDfyPpX+uKO36OI2kIeMHrYG0zaezmuinKvE4vg1dAz38zZeDbPvBKGg==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.1.tgz", + "integrity": "sha512-6Wci+Tp3CgPt/B9B0a3J4s3yMgLNSku6w5TV6mN+61C71UqsRBv2FUibBf3tPGlNxebgPHMEUzKpb1ggE8KCKw==", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.4.tgz", + "integrity": "sha512-FMoEQWjK7nWAO2uFgV1eVpVhY9ZDGOdIIomi9zTej64cKJ+8/Nvu+ny0xKaUDEjw/ALftN2D2ml7L0RDpW/Z9g==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.3.tgz", + "integrity": "sha512-sGvEcBOTNum68x9jCpCVGPFJ6mWnkD0YxOcddDlJHRx3tKdB2q8pCHExMVZo/AV/6geuVJXG7hljDaWG8+5GDw==", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/tsdoc": { + "version": "0.12.24", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.24.tgz", + "integrity": "sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.16.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.1.tgz", + "integrity": "sha512-2RqkwiD4uN6MLnHFljqBlZIXlt/SaUT6cuogU1w2ARw4nKuuppSmR0+s+NC+7kXBQykd9zzu0P4HtBpZT5zBpQ==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.1", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.1.tgz", + "integrity": "sha512-6Wci+Tp3CgPt/B9B0a3J4s3yMgLNSku6w5TV6mN+61C71UqsRBv2FUibBf3tPGlNxebgPHMEUzKpb1ggE8KCKw==", + "dev": true + }, + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, "@panva/asn1.js": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/@panva/asn1.js/-/asn1.js-1.0.0.tgz", @@ -336,6 +668,79 @@ "dev": true, "optional": true }, + "@rushstack/node-core-library": { + "version": "3.36.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.36.0.tgz", + "integrity": "sha512-bID2vzXpg8zweXdXgQkKToEdZwVrVCN9vE9viTRk58gqzYaTlz4fMId6V3ZfpXN6H0d319uGi2KDlm+lUEeqCg==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, + "@rushstack/rig-package": { + "version": "0.3.11", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.11.tgz", + "integrity": "sha512-uI1/g5oQPtyrT9nStoyX/xgZSLa2b+srRFaDk3r1eqC7zA5th4/bvTGl2QfV3C9NcP+coSqmk5mFJkUfH6i3Lw==", + "dev": true, + "requires": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.7.8.tgz", + "integrity": "sha512-8ghIWhkph7NnLCMDJtthpsb7TMOsVGXVDvmxjE/CeklTqjbbUFBjGXizJfpbEkRQTELuZQ2+vGn7sGwIWKN2uA==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, "@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -403,6 +808,12 @@ "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", "dev": true }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "@types/body-parser": { "version": "1.19.2", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.2.tgz", @@ -679,6 +1090,18 @@ } } }, + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, "ansi-colors": { "version": "3.2.3", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", @@ -706,6 +1129,16 @@ "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", "dev": true }, + "api-extractor-model-me": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/api-extractor-model-me/-/api-extractor-model-me-0.1.1.tgz", + "integrity": "sha512-Ez801ZMADfkseOWNRFquvyQYDm3D9McpxfkKMWL6JFCGcpub0miJ+TFNphIR1nSZbrsxz3kIeOovNMY4VlL6Bw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + } + }, "arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -1001,6 +1434,12 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -1531,8 +1970,7 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true, - "optional": true + "dev": true }, "fast-diff": { "version": "1.2.0", @@ -1540,6 +1978,12 @@ "integrity": "sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w==", "dev": true }, + "fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, "fast-levenshtein": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", @@ -1640,6 +2084,17 @@ "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=" }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -1815,8 +2270,7 @@ "version": "4.2.10", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", - "dev": true, - "optional": true + "dev": true }, "growl": { "version": "1.10.5", @@ -2019,6 +2473,12 @@ "safer-buffer": ">= 2.1.2 < 3" } }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true + }, "imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -2235,6 +2695,12 @@ "integrity": "sha512-5IZ7sY9dBAYSV+YjQ0Ovb540Ku7AO9Z5o2Cg789xj167iQuZ2cG+z0f3Uct6WeYLbU6aQiM2pCs7sZ+4dotydw==", "dev": true }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true + }, "jose": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/jose/-/jose-2.0.5.tgz", @@ -2365,6 +2831,12 @@ "bignumber.js": "^9.0.0" } }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, "json-stringify-safe": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", @@ -2377,6 +2849,15 @@ "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", "dev": true }, + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, "jsonwebtoken": { "version": "8.5.1", "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz", @@ -2550,6 +3031,12 @@ "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", "dev": true }, + "lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true + }, "lodash.includes": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz", @@ -2562,6 +3049,12 @@ "integrity": "sha1-bC4XHbKiV82WgC/UOwGyDV9YcPY=", "dev": true }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true + }, "lodash.isinteger": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz", @@ -3737,6 +4230,12 @@ "integrity": "sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==", "dev": true }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, "string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -3853,6 +4352,12 @@ "thenify": ">= 3.1.0 < 4" } }, + "timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=", + "dev": true + }, "toidentifier": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", @@ -4143,6 +4648,15 @@ "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" }, + "uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "requires": { + "punycode": "^2.1.0" + } + }, "util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", @@ -4168,6 +4682,12 @@ "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", "dev": true }, + "validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "dev": true + }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -4652,6 +5172,18 @@ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "optional": true + }, + "z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + } } } }