firestore.DocumentOptions interface
Stay organized with collections
Save and categorize content based on your preferences.
DocumentOptions extend EventHandlerOptions with provided document and optional database and namespace.
Signature:
export interface DocumentOptions<Document extends string = string> extends EventHandlerOptions
Extends: EventHandlerOptions
Properties
firestore.DocumentOptions.database
The Firestore database
Signature:
database?: string | Expression<string>;
firestore.DocumentOptions.document
The document path
Signature:
document: Document | Expression<string>;
firestore.DocumentOptions.namespace
The Firestore namespace
Signature:
namespace?: string | Expression<string>;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-20 UTC."],[],[],null,["# firestore.DocumentOptions interface\n\nDocumentOptions extend EventHandlerOptions with provided document and optional database and namespace.\n\n**Signature:** \n\n export interface DocumentOptions\u003cDocument extends string = string\u003e extends EventHandlerOptions \n\n**Extends:** [EventHandlerOptions](./firebase-functions.eventhandleroptions.md#eventhandleroptions_interface)\n\nProperties\n----------\n\n| Property | Type | Description |\n|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|-------------------------|\n| [database](./firebase-functions.firestore.documentoptions.md#firestoredocumentoptionsdatabase) | string \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e | The Firestore database |\n| [document](./firebase-functions.firestore.documentoptions.md#firestoredocumentoptionsdocument) | Document \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e | The document path |\n| [namespace](./firebase-functions.firestore.documentoptions.md#firestoredocumentoptionsnamespace) | string \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e | The Firestore namespace |\n\nfirestore.DocumentOptions.database\n----------------------------------\n\nThe Firestore database\n\n**Signature:** \n\n database?: string | Expression\u003cstring\u003e;\n\nfirestore.DocumentOptions.document\n----------------------------------\n\nThe document path\n\n**Signature:** \n\n document: Document | Expression\u003cstring\u003e;\n\nfirestore.DocumentOptions.namespace\n-----------------------------------\n\nThe Firestore namespace\n\n**Signature:** \n\n namespace?: string | Expression\u003cstring\u003e;"]]