mirror of
https://github.com/hanzoai/firebase-js-sdk.git
synced 2026-09-24 16:59:10 +00:00
* feat(ai): implementmulti-speaker speech config; includes tests * add changeset, fix typo * fix: yarn format * fix changeset * fix changeset typo * remove unnecessary tests; fix interface description to match proposal * Generate documentation * fix: yarn format & lint fix * add more descriptive changeset * Adds tests for speech config to check if its correctly passed through to the API requests for both generateContent and generateContentStream methods * yarn format * yarn format * Refine changeset file description * Fix typo * format fix * update description BaseSpeechConfig * update descriptions * format doc * yarn format * fix @ typo over MultiSpeakerSpeechConfig * fix: adjusted description wording for the interfaces; fix: public tags to beta * fix: formatting using @remarks * fix: typo * yarn format * run yarn docgen:all * update SpeechConfig to beta * update speech config to beta * upd SingleSpeakerSpeechConfig description * doc generation
881 lines
36 KiB
YAML
881 lines
36 KiB
YAML
toc:
|
|
- title: firebase
|
|
path: /docs/reference/js/index
|
|
- title: ai
|
|
path: /docs/reference/js/ai.md
|
|
section:
|
|
- title: AgentPlatformBackend
|
|
path: /docs/reference/js/ai.agentplatformbackend.md
|
|
- title: AI
|
|
path: /docs/reference/js/ai.ai.md
|
|
- title: AIError
|
|
path: /docs/reference/js/ai.aierror.md
|
|
- title: AIModel
|
|
path: /docs/reference/js/ai.aimodel.md
|
|
- title: AIOptions
|
|
path: /docs/reference/js/ai.aioptions.md
|
|
- title: AnyOfSchema
|
|
path: /docs/reference/js/ai.anyofschema.md
|
|
- title: ArraySchema
|
|
path: /docs/reference/js/ai.arrayschema.md
|
|
- title: AudioConversationController
|
|
path: /docs/reference/js/ai.audioconversationcontroller.md
|
|
- title: AudioTranscriptionConfig
|
|
path: /docs/reference/js/ai.audiotranscriptionconfig.md
|
|
- title: Backend
|
|
path: /docs/reference/js/ai.backend.md
|
|
- title: BaseParams
|
|
path: /docs/reference/js/ai.baseparams.md
|
|
- title: BaseSpeechConfig
|
|
path: /docs/reference/js/ai.basespeechconfig.md
|
|
- title: BooleanSchema
|
|
path: /docs/reference/js/ai.booleanschema.md
|
|
- title: ChatSession
|
|
path: /docs/reference/js/ai.chatsession.md
|
|
- title: ChatSessionBase
|
|
path: /docs/reference/js/ai.chatsessionbase.md
|
|
- title: ChromeAdapter
|
|
path: /docs/reference/js/ai.chromeadapter.md
|
|
- title: Citation
|
|
path: /docs/reference/js/ai.citation.md
|
|
- title: CitationMetadata
|
|
path: /docs/reference/js/ai.citationmetadata.md
|
|
- title: CodeExecutionResult
|
|
path: /docs/reference/js/ai.codeexecutionresult.md
|
|
- title: CodeExecutionResultPart
|
|
path: /docs/reference/js/ai.codeexecutionresultpart.md
|
|
- title: CodeExecutionTool
|
|
path: /docs/reference/js/ai.codeexecutiontool.md
|
|
- title: Content
|
|
path: /docs/reference/js/ai.content.md
|
|
- title: ContextWindowCompressionConfig
|
|
path: /docs/reference/js/ai.contextwindowcompressionconfig.md
|
|
- title: CountTokensRequest
|
|
path: /docs/reference/js/ai.counttokensrequest.md
|
|
- title: CountTokensResponse
|
|
path: /docs/reference/js/ai.counttokensresponse.md
|
|
- title: CustomErrorData
|
|
path: /docs/reference/js/ai.customerrordata.md
|
|
- title: Date_2
|
|
path: /docs/reference/js/ai.date_2.md
|
|
- title: EnhancedGenerateContentResponse
|
|
path: /docs/reference/js/ai.enhancedgeneratecontentresponse.md
|
|
- title: ErrorDetails
|
|
path: /docs/reference/js/ai.errordetails.md
|
|
- title: ExecutableCode
|
|
path: /docs/reference/js/ai.executablecode.md
|
|
- title: ExecutableCodePart
|
|
path: /docs/reference/js/ai.executablecodepart.md
|
|
- title: FileData
|
|
path: /docs/reference/js/ai.filedata.md
|
|
- title: FileDataPart
|
|
path: /docs/reference/js/ai.filedatapart.md
|
|
- title: FunctionCall
|
|
path: /docs/reference/js/ai.functioncall.md
|
|
- title: FunctionCallingConfig
|
|
path: /docs/reference/js/ai.functioncallingconfig.md
|
|
- title: FunctionCallPart
|
|
path: /docs/reference/js/ai.functioncallpart.md
|
|
- title: FunctionDeclaration
|
|
path: /docs/reference/js/ai.functiondeclaration.md
|
|
- title: FunctionDeclarationsTool
|
|
path: /docs/reference/js/ai.functiondeclarationstool.md
|
|
- title: FunctionResponse
|
|
path: /docs/reference/js/ai.functionresponse.md
|
|
- title: FunctionResponsePart
|
|
path: /docs/reference/js/ai.functionresponsepart.md
|
|
- title: GenerateContentCandidate
|
|
path: /docs/reference/js/ai.generatecontentcandidate.md
|
|
- title: GenerateContentRequest
|
|
path: /docs/reference/js/ai.generatecontentrequest.md
|
|
- title: GenerateContentResponse
|
|
path: /docs/reference/js/ai.generatecontentresponse.md
|
|
- title: GenerateContentResult
|
|
path: /docs/reference/js/ai.generatecontentresult.md
|
|
- title: GenerateContentStreamResult
|
|
path: /docs/reference/js/ai.generatecontentstreamresult.md
|
|
- title: GenerationConfig
|
|
path: /docs/reference/js/ai.generationconfig.md
|
|
- title: GenerativeContentBlob
|
|
path: /docs/reference/js/ai.generativecontentblob.md
|
|
- title: GenerativeModel
|
|
path: /docs/reference/js/ai.generativemodel.md
|
|
- title: GoogleAIBackend
|
|
path: /docs/reference/js/ai.googleaibackend.md
|
|
- title: GoogleMaps
|
|
path: /docs/reference/js/ai.googlemaps.md
|
|
- title: GoogleMapsGroundingChunk
|
|
path: /docs/reference/js/ai.googlemapsgroundingchunk.md
|
|
- title: GoogleMapsTool
|
|
path: /docs/reference/js/ai.googlemapstool.md
|
|
- title: GoogleSearch
|
|
path: /docs/reference/js/ai.googlesearch.md
|
|
- title: GoogleSearchTool
|
|
path: /docs/reference/js/ai.googlesearchtool.md
|
|
- title: GroundingChunk
|
|
path: /docs/reference/js/ai.groundingchunk.md
|
|
- title: GroundingMetadata
|
|
path: /docs/reference/js/ai.groundingmetadata.md
|
|
- title: GroundingSupport
|
|
path: /docs/reference/js/ai.groundingsupport.md
|
|
- title: HybridParams
|
|
path: /docs/reference/js/ai.hybridparams.md
|
|
- title: ImageConfig
|
|
path: /docs/reference/js/ai.imageconfig.md
|
|
- title: ImagenGCSImage
|
|
path: /docs/reference/js/ai.imagengcsimage.md
|
|
- title: ImagenGenerationConfig
|
|
path: /docs/reference/js/ai.imagengenerationconfig.md
|
|
- title: ImagenGenerationResponse
|
|
path: /docs/reference/js/ai.imagengenerationresponse.md
|
|
- title: ImagenImageFormat
|
|
path: /docs/reference/js/ai.imagenimageformat.md
|
|
- title: ImagenInlineImage
|
|
path: /docs/reference/js/ai.imageninlineimage.md
|
|
- title: ImagenModel
|
|
path: /docs/reference/js/ai.imagenmodel.md
|
|
- title: ImagenModelParams
|
|
path: /docs/reference/js/ai.imagenmodelparams.md
|
|
- title: ImagenSafetySettings
|
|
path: /docs/reference/js/ai.imagensafetysettings.md
|
|
- title: InlineDataPart
|
|
path: /docs/reference/js/ai.inlinedatapart.md
|
|
- title: IntegerSchema
|
|
path: /docs/reference/js/ai.integerschema.md
|
|
- title: LanguageModelCreateCoreOptions
|
|
path: /docs/reference/js/ai.languagemodelcreatecoreoptions.md
|
|
- title: LanguageModelCreateOptions
|
|
path: /docs/reference/js/ai.languagemodelcreateoptions.md
|
|
- title: LanguageModelDownloadMonitor
|
|
path: /docs/reference/js/ai.languagemodeldownloadmonitor.md
|
|
- title: LanguageModelExpected
|
|
path: /docs/reference/js/ai.languagemodelexpected.md
|
|
- title: LanguageModelMessage
|
|
path: /docs/reference/js/ai.languagemodelmessage.md
|
|
- title: LanguageModelMessageContent
|
|
path: /docs/reference/js/ai.languagemodelmessagecontent.md
|
|
- title: LanguageModelPromptOptions
|
|
path: /docs/reference/js/ai.languagemodelpromptoptions.md
|
|
- title: LatLng
|
|
path: /docs/reference/js/ai.latlng.md
|
|
- title: LiveGenerationConfig
|
|
path: /docs/reference/js/ai.livegenerationconfig.md
|
|
- title: LiveGenerativeModel
|
|
path: /docs/reference/js/ai.livegenerativemodel.md
|
|
- title: LiveModelParams
|
|
path: /docs/reference/js/ai.livemodelparams.md
|
|
- title: LiveServerContent
|
|
path: /docs/reference/js/ai.liveservercontent.md
|
|
- title: LiveServerGoingAwayNotice
|
|
path: /docs/reference/js/ai.liveservergoingawaynotice.md
|
|
- title: LiveServerToolCall
|
|
path: /docs/reference/js/ai.liveservertoolcall.md
|
|
- title: LiveServerToolCallCancellation
|
|
path: /docs/reference/js/ai.liveservertoolcallcancellation.md
|
|
- title: LiveSession
|
|
path: /docs/reference/js/ai.livesession.md
|
|
- title: LiveSessionResumptionUpdate
|
|
path: /docs/reference/js/ai.livesessionresumptionupdate.md
|
|
- title: ModalityTokenCount
|
|
path: /docs/reference/js/ai.modalitytokencount.md
|
|
- title: ModelParams
|
|
path: /docs/reference/js/ai.modelparams.md
|
|
- title: MultiSpeakerSpeechConfig
|
|
path: /docs/reference/js/ai.multispeakerspeechconfig.md
|
|
- title: MultiSpeakerVoiceConfig
|
|
path: /docs/reference/js/ai.multispeakervoiceconfig.md
|
|
- title: NumberSchema
|
|
path: /docs/reference/js/ai.numberschema.md
|
|
- title: ObjectSchema
|
|
path: /docs/reference/js/ai.objectschema.md
|
|
- title: ObjectSchemaRequest
|
|
path: /docs/reference/js/ai.objectschemarequest.md
|
|
- title: OnDeviceParams
|
|
path: /docs/reference/js/ai.ondeviceparams.md
|
|
- title: PrebuiltVoiceConfig
|
|
path: /docs/reference/js/ai.prebuiltvoiceconfig.md
|
|
- title: PromptFeedback
|
|
path: /docs/reference/js/ai.promptfeedback.md
|
|
- title: RequestOptions
|
|
path: /docs/reference/js/ai.requestoptions.md
|
|
- title: RetrievalConfig
|
|
path: /docs/reference/js/ai.retrievalconfig.md
|
|
- title: RetrievedContextAttribution
|
|
path: /docs/reference/js/ai.retrievedcontextattribution.md
|
|
- title: SafetyRating
|
|
path: /docs/reference/js/ai.safetyrating.md
|
|
- title: SafetySetting
|
|
path: /docs/reference/js/ai.safetysetting.md
|
|
- title: Schema
|
|
path: /docs/reference/js/ai.schema.md
|
|
- title: SchemaInterface
|
|
path: /docs/reference/js/ai.schemainterface.md
|
|
- title: SchemaParams
|
|
path: /docs/reference/js/ai.schemaparams.md
|
|
- title: SchemaRequest
|
|
path: /docs/reference/js/ai.schemarequest.md
|
|
- title: SchemaShared
|
|
path: /docs/reference/js/ai.schemashared.md
|
|
- title: SearchEntrypoint
|
|
path: /docs/reference/js/ai.searchentrypoint.md
|
|
- title: Segment
|
|
path: /docs/reference/js/ai.segment.md
|
|
- title: SessionResumptionConfig
|
|
path: /docs/reference/js/ai.sessionresumptionconfig.md
|
|
- title: SingleRequestOptions
|
|
path: /docs/reference/js/ai.singlerequestoptions.md
|
|
- title: SingleSpeakerSpeechConfig
|
|
path: /docs/reference/js/ai.singlespeakerspeechconfig.md
|
|
- title: SlidingWindow
|
|
path: /docs/reference/js/ai.slidingwindow.md
|
|
- title: SpeakerVoiceConfig
|
|
path: /docs/reference/js/ai.speakervoiceconfig.md
|
|
- title: StartAudioConversationOptions
|
|
path: /docs/reference/js/ai.startaudioconversationoptions.md
|
|
- title: StartChatParams
|
|
path: /docs/reference/js/ai.startchatparams.md
|
|
- title: StartTemplateChatParams
|
|
path: /docs/reference/js/ai.starttemplatechatparams.md
|
|
- title: StringSchema
|
|
path: /docs/reference/js/ai.stringschema.md
|
|
- title: TemplateChatSession
|
|
path: /docs/reference/js/ai.templatechatsession.md
|
|
- title: TemplateFunctionDeclaration
|
|
path: /docs/reference/js/ai.templatefunctiondeclaration.md
|
|
- title: TemplateFunctionDeclarationsTool
|
|
path: /docs/reference/js/ai.templatefunctiondeclarationstool.md
|
|
- title: TemplateGenerativeModel
|
|
path: /docs/reference/js/ai.templategenerativemodel.md
|
|
- title: TemplateImagenModel
|
|
path: /docs/reference/js/ai.templateimagenmodel.md
|
|
- title: TemplateToolConfig
|
|
path: /docs/reference/js/ai.templatetoolconfig.md
|
|
- title: TextPart
|
|
path: /docs/reference/js/ai.textpart.md
|
|
- title: ThinkingConfig
|
|
path: /docs/reference/js/ai.thinkingconfig.md
|
|
- title: ToolConfig
|
|
path: /docs/reference/js/ai.toolconfig.md
|
|
- title: Transcription
|
|
path: /docs/reference/js/ai.transcription.md
|
|
- title: URLContext
|
|
path: /docs/reference/js/ai.urlcontext.md
|
|
- title: URLContextMetadata
|
|
path: /docs/reference/js/ai.urlcontextmetadata.md
|
|
- title: URLContextTool
|
|
path: /docs/reference/js/ai.urlcontexttool.md
|
|
- title: URLMetadata
|
|
path: /docs/reference/js/ai.urlmetadata.md
|
|
- title: UsageMetadata
|
|
path: /docs/reference/js/ai.usagemetadata.md
|
|
- title: VertexAIBackend
|
|
path: /docs/reference/js/ai.vertexaibackend.md
|
|
- title: VideoMetadata
|
|
path: /docs/reference/js/ai.videometadata.md
|
|
- title: VoiceConfig
|
|
path: /docs/reference/js/ai.voiceconfig.md
|
|
- title: WebAttribution
|
|
path: /docs/reference/js/ai.webattribution.md
|
|
- title: WebGroundingChunk
|
|
path: /docs/reference/js/ai.webgroundingchunk.md
|
|
- title: analytics
|
|
path: /docs/reference/js/analytics.md
|
|
section:
|
|
- title: Analytics
|
|
path: /docs/reference/js/analytics.analytics.md
|
|
- title: AnalyticsCallOptions
|
|
path: /docs/reference/js/analytics.analyticscalloptions.md
|
|
- title: AnalyticsSettings
|
|
path: /docs/reference/js/analytics.analyticssettings.md
|
|
- title: ConsentSettings
|
|
path: /docs/reference/js/analytics.consentsettings.md
|
|
- title: ControlParams
|
|
path: /docs/reference/js/analytics.controlparams.md
|
|
- title: CustomParams
|
|
path: /docs/reference/js/analytics.customparams.md
|
|
- title: EventParams
|
|
path: /docs/reference/js/analytics.eventparams.md
|
|
- title: GtagConfigParams
|
|
path: /docs/reference/js/analytics.gtagconfigparams.md
|
|
- title: Item
|
|
path: /docs/reference/js/analytics.item.md
|
|
- title: Promotion
|
|
path: /docs/reference/js/analytics.promotion.md
|
|
- title: SettingsOptions
|
|
path: /docs/reference/js/analytics.settingsoptions.md
|
|
- title: app
|
|
path: /docs/reference/js/app.md
|
|
section:
|
|
- title: FirebaseApp
|
|
path: /docs/reference/js/app.firebaseapp.md
|
|
- title: FirebaseAppSettings
|
|
path: /docs/reference/js/app.firebaseappsettings.md
|
|
- title: FirebaseOptions
|
|
path: /docs/reference/js/app.firebaseoptions.md
|
|
- title: FirebaseServerApp
|
|
path: /docs/reference/js/app.firebaseserverapp.md
|
|
- title: FirebaseServerAppSettings
|
|
path: /docs/reference/js/app.firebaseserverappsettings.md
|
|
- title: app-check
|
|
path: /docs/reference/js/app-check.md
|
|
section:
|
|
- title: AppCheck
|
|
path: /docs/reference/js/app-check.appcheck.md
|
|
- title: AppCheckOptions
|
|
path: /docs/reference/js/app-check.appcheckoptions.md
|
|
- title: AppCheckToken
|
|
path: /docs/reference/js/app-check.appchecktoken.md
|
|
- title: AppCheckTokenResult
|
|
path: /docs/reference/js/app-check.appchecktokenresult.md
|
|
- title: CustomProvider
|
|
path: /docs/reference/js/app-check.customprovider.md
|
|
- title: CustomProviderOptions
|
|
path: /docs/reference/js/app-check.customprovideroptions.md
|
|
- title: ReCaptchaEnterpriseProvider
|
|
path: /docs/reference/js/app-check.recaptchaenterpriseprovider.md
|
|
- title: ReCaptchaV3Provider
|
|
path: /docs/reference/js/app-check.recaptchav3provider.md
|
|
- title: auth
|
|
path: /docs/reference/js/auth.md
|
|
section:
|
|
- title: ActionCodeInfo
|
|
path: /docs/reference/js/auth.actioncodeinfo.md
|
|
- title: ActionCodeSettings
|
|
path: /docs/reference/js/auth.actioncodesettings.md
|
|
- title: ActionCodeURL
|
|
path: /docs/reference/js/auth.actioncodeurl.md
|
|
- title: AdditionalUserInfo
|
|
path: /docs/reference/js/auth.additionaluserinfo.md
|
|
- title: ApplicationVerifier
|
|
path: /docs/reference/js/auth.applicationverifier.md
|
|
- title: Auth
|
|
path: /docs/reference/js/auth.auth.md
|
|
- title: AuthCredential
|
|
path: /docs/reference/js/auth.authcredential.md
|
|
- title: AuthError
|
|
path: /docs/reference/js/auth.autherror.md
|
|
- title: AuthErrorMap
|
|
path: /docs/reference/js/auth.autherrormap.md
|
|
- title: AuthProvider
|
|
path: /docs/reference/js/auth.authprovider.md
|
|
- title: AuthSettings
|
|
path: /docs/reference/js/auth.authsettings.md
|
|
- title: Config
|
|
path: /docs/reference/js/auth.config.md
|
|
- title: ConfirmationResult
|
|
path: /docs/reference/js/auth.confirmationresult.md
|
|
- title: Dependencies
|
|
path: /docs/reference/js/auth.dependencies.md
|
|
- title: EmailAuthCredential
|
|
path: /docs/reference/js/auth.emailauthcredential.md
|
|
- title: EmailAuthProvider
|
|
path: /docs/reference/js/auth.emailauthprovider.md
|
|
- title: EmulatorConfig
|
|
path: /docs/reference/js/auth.emulatorconfig.md
|
|
- title: FacebookAuthProvider
|
|
path: /docs/reference/js/auth.facebookauthprovider.md
|
|
- title: GithubAuthProvider
|
|
path: /docs/reference/js/auth.githubauthprovider.md
|
|
- title: GoogleAuthProvider
|
|
path: /docs/reference/js/auth.googleauthprovider.md
|
|
- title: IdTokenResult
|
|
path: /docs/reference/js/auth.idtokenresult.md
|
|
- title: MultiFactorAssertion
|
|
path: /docs/reference/js/auth.multifactorassertion.md
|
|
- title: MultiFactorError
|
|
path: /docs/reference/js/auth.multifactorerror.md
|
|
- title: MultiFactorInfo
|
|
path: /docs/reference/js/auth.multifactorinfo.md
|
|
- title: MultiFactorResolver
|
|
path: /docs/reference/js/auth.multifactorresolver.md
|
|
- title: MultiFactorSession
|
|
path: /docs/reference/js/auth.multifactorsession.md
|
|
- title: MultiFactorUser
|
|
path: /docs/reference/js/auth.multifactoruser.md
|
|
- title: OAuthCredential
|
|
path: /docs/reference/js/auth.oauthcredential.md
|
|
- title: OAuthCredentialOptions
|
|
path: /docs/reference/js/auth.oauthcredentialoptions.md
|
|
- title: OAuthProvider
|
|
path: /docs/reference/js/auth.oauthprovider.md
|
|
- title: ParsedToken
|
|
path: /docs/reference/js/auth.parsedtoken.md
|
|
- title: PasswordPolicy
|
|
path: /docs/reference/js/auth.passwordpolicy.md
|
|
- title: PasswordValidationStatus
|
|
path: /docs/reference/js/auth.passwordvalidationstatus.md
|
|
- title: Persistence
|
|
path: /docs/reference/js/auth.persistence.md
|
|
- title: PhoneAuthCredential
|
|
path: /docs/reference/js/auth.phoneauthcredential.md
|
|
- title: PhoneAuthProvider
|
|
path: /docs/reference/js/auth.phoneauthprovider.md
|
|
- title: PhoneMultiFactorAssertion
|
|
path: /docs/reference/js/auth.phonemultifactorassertion.md
|
|
- title: PhoneMultiFactorEnrollInfoOptions
|
|
path: /docs/reference/js/auth.phonemultifactorenrollinfooptions.md
|
|
- title: PhoneMultiFactorGenerator
|
|
path: /docs/reference/js/auth.phonemultifactorgenerator.md
|
|
- title: PhoneMultiFactorInfo
|
|
path: /docs/reference/js/auth.phonemultifactorinfo.md
|
|
- title: PhoneMultiFactorSignInInfoOptions
|
|
path: /docs/reference/js/auth.phonemultifactorsignininfooptions.md
|
|
- title: PhoneSingleFactorInfoOptions
|
|
path: /docs/reference/js/auth.phonesinglefactorinfooptions.md
|
|
- title: PopupRedirectResolver
|
|
path: /docs/reference/js/auth.popupredirectresolver.md
|
|
- title: ReactNativeAsyncStorage
|
|
path: /docs/reference/js/auth.reactnativeasyncstorage.md
|
|
- title: RecaptchaParameters
|
|
path: /docs/reference/js/auth.recaptchaparameters.md
|
|
- title: RecaptchaVerifier
|
|
path: /docs/reference/js/auth.recaptchaverifier.md
|
|
- title: SAMLAuthProvider
|
|
path: /docs/reference/js/auth.samlauthprovider.md
|
|
- title: TotpMultiFactorAssertion
|
|
path: /docs/reference/js/auth.totpmultifactorassertion.md
|
|
- title: TotpMultiFactorGenerator
|
|
path: /docs/reference/js/auth.totpmultifactorgenerator.md
|
|
- title: TotpMultiFactorInfo
|
|
path: /docs/reference/js/auth.totpmultifactorinfo.md
|
|
- title: TotpSecret
|
|
path: /docs/reference/js/auth.totpsecret.md
|
|
- title: TwitterAuthProvider
|
|
path: /docs/reference/js/auth.twitterauthprovider.md
|
|
- title: User
|
|
path: /docs/reference/js/auth.user.md
|
|
- title: UserCredential
|
|
path: /docs/reference/js/auth.usercredential.md
|
|
- title: UserInfo
|
|
path: /docs/reference/js/auth.userinfo.md
|
|
- title: UserMetadata
|
|
path: /docs/reference/js/auth.usermetadata.md
|
|
- title: database
|
|
path: /docs/reference/js/database.md
|
|
section:
|
|
- title: Database
|
|
path: /docs/reference/js/database.database.md
|
|
- title: DatabaseReference
|
|
path: /docs/reference/js/database.databasereference.md
|
|
- title: DataSnapshot
|
|
path: /docs/reference/js/database.datasnapshot.md
|
|
- title: IteratedDataSnapshot
|
|
path: /docs/reference/js/database.iterateddatasnapshot.md
|
|
- title: ListenOptions
|
|
path: /docs/reference/js/database.listenoptions.md
|
|
- title: OnDisconnect
|
|
path: /docs/reference/js/database.ondisconnect.md
|
|
- title: Query
|
|
path: /docs/reference/js/database.query.md
|
|
- title: QueryConstraint
|
|
path: /docs/reference/js/database.queryconstraint.md
|
|
- title: ThenableReference
|
|
path: /docs/reference/js/database.thenablereference.md
|
|
- title: TransactionOptions
|
|
path: /docs/reference/js/database.transactionoptions.md
|
|
- title: TransactionResult
|
|
path: /docs/reference/js/database.transactionresult.md
|
|
- title: firestore
|
|
path: /docs/reference/js/firestore_.md
|
|
section:
|
|
- title: AggregateField
|
|
path: /docs/reference/js/firestore_.aggregatefield.md
|
|
- title: AggregateQuerySnapshot
|
|
path: /docs/reference/js/firestore_.aggregatequerysnapshot.md
|
|
- title: AggregateSpec
|
|
path: /docs/reference/js/firestore_.aggregatespec.md
|
|
- title: Bytes
|
|
path: /docs/reference/js/firestore_.bytes.md
|
|
- title: CollectionReference
|
|
path: /docs/reference/js/firestore_.collectionreference.md
|
|
- title: DocumentChange
|
|
path: /docs/reference/js/firestore_.documentchange.md
|
|
- title: DocumentData
|
|
path: /docs/reference/js/firestore_.documentdata.md
|
|
- title: DocumentReference
|
|
path: /docs/reference/js/firestore_.documentreference.md
|
|
- title: DocumentSnapshot
|
|
path: /docs/reference/js/firestore_.documentsnapshot.md
|
|
- title: ExperimentalLongPollingOptions
|
|
path: /docs/reference/js/firestore_.experimentallongpollingoptions.md
|
|
- title: FieldPath
|
|
path: /docs/reference/js/firestore_.fieldpath.md
|
|
- title: FieldValue
|
|
path: /docs/reference/js/firestore_.fieldvalue.md
|
|
- title: Firestore
|
|
path: /docs/reference/js/firestore_.firestore.md
|
|
- title: FirestoreDataConverter
|
|
path: /docs/reference/js/firestore_.firestoredataconverter.md
|
|
- title: FirestoreError
|
|
path: /docs/reference/js/firestore_.firestoreerror.md
|
|
- title: FirestoreSettings
|
|
path: /docs/reference/js/firestore_.firestoresettings.md
|
|
- title: GeoPoint
|
|
path: /docs/reference/js/firestore_.geopoint.md
|
|
- title: Index
|
|
path: /docs/reference/js/firestore_.index.md
|
|
- title: IndexConfiguration
|
|
path: /docs/reference/js/firestore_.indexconfiguration.md
|
|
- title: IndexField
|
|
path: /docs/reference/js/firestore_.indexfield.md
|
|
- title: LoadBundleTask
|
|
path: /docs/reference/js/firestore_.loadbundletask.md
|
|
- title: LoadBundleTaskProgress
|
|
path: /docs/reference/js/firestore_.loadbundletaskprogress.md
|
|
- title: MemoryCacheSettings
|
|
path: /docs/reference/js/firestore_.memorycachesettings.md
|
|
- title: MemoryEagerGarbageCollector
|
|
path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md
|
|
- title: MemoryLocalCache
|
|
path: /docs/reference/js/firestore_.memorylocalcache.md
|
|
- title: MemoryLruGarbageCollector
|
|
path: /docs/reference/js/firestore_.memorylrugarbagecollector.md
|
|
- title: PersistenceSettings
|
|
path: /docs/reference/js/firestore_.persistencesettings.md
|
|
- title: PersistentCacheIndexManager
|
|
path: /docs/reference/js/firestore_.persistentcacheindexmanager.md
|
|
- title: PersistentCacheSettings
|
|
path: /docs/reference/js/firestore_.persistentcachesettings.md
|
|
- title: PersistentLocalCache
|
|
path: /docs/reference/js/firestore_.persistentlocalcache.md
|
|
- title: PersistentMultipleTabManager
|
|
path: /docs/reference/js/firestore_.persistentmultipletabmanager.md
|
|
- title: PersistentSingleTabManager
|
|
path: /docs/reference/js/firestore_.persistentsingletabmanager.md
|
|
- title: PersistentSingleTabManagerSettings
|
|
path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md
|
|
- title: Query
|
|
path: /docs/reference/js/firestore_.query.md
|
|
- title: QueryCompositeFilterConstraint
|
|
path: /docs/reference/js/firestore_.querycompositefilterconstraint.md
|
|
- title: QueryConstraint
|
|
path: /docs/reference/js/firestore_.queryconstraint.md
|
|
- title: QueryDocumentSnapshot
|
|
path: /docs/reference/js/firestore_.querydocumentsnapshot.md
|
|
- title: QueryEndAtConstraint
|
|
path: /docs/reference/js/firestore_.queryendatconstraint.md
|
|
- title: QueryFieldFilterConstraint
|
|
path: /docs/reference/js/firestore_.queryfieldfilterconstraint.md
|
|
- title: QueryLimitConstraint
|
|
path: /docs/reference/js/firestore_.querylimitconstraint.md
|
|
- title: QueryOrderByConstraint
|
|
path: /docs/reference/js/firestore_.queryorderbyconstraint.md
|
|
- title: QuerySnapshot
|
|
path: /docs/reference/js/firestore_.querysnapshot.md
|
|
- title: QueryStartAtConstraint
|
|
path: /docs/reference/js/firestore_.querystartatconstraint.md
|
|
- title: SnapshotListenOptions
|
|
path: /docs/reference/js/firestore_.snapshotlistenoptions.md
|
|
- title: SnapshotMetadata
|
|
path: /docs/reference/js/firestore_.snapshotmetadata.md
|
|
- title: SnapshotOptions
|
|
path: /docs/reference/js/firestore_.snapshotoptions.md
|
|
- title: Timestamp
|
|
path: /docs/reference/js/firestore_.timestamp.md
|
|
- title: Transaction
|
|
path: /docs/reference/js/firestore_.transaction.md
|
|
- title: TransactionOptions
|
|
path: /docs/reference/js/firestore_.transactionoptions.md
|
|
- title: Unsubscribe
|
|
path: /docs/reference/js/firestore_.unsubscribe.md
|
|
- title: VectorValue
|
|
path: /docs/reference/js/firestore_.vectorvalue.md
|
|
- title: WriteBatch
|
|
path: /docs/reference/js/firestore_.writebatch.md
|
|
- title: firestore/lite
|
|
path: /docs/reference/js/firestore_lite.md
|
|
section:
|
|
- title: AggregateField
|
|
path: /docs/reference/js/firestore_lite.aggregatefield.md
|
|
- title: AggregateQuerySnapshot
|
|
path: /docs/reference/js/firestore_lite.aggregatequerysnapshot.md
|
|
- title: AggregateSpec
|
|
path: /docs/reference/js/firestore_lite.aggregatespec.md
|
|
- title: Bytes
|
|
path: /docs/reference/js/firestore_lite.bytes.md
|
|
- title: CollectionReference
|
|
path: /docs/reference/js/firestore_lite.collectionreference.md
|
|
- title: DocumentData
|
|
path: /docs/reference/js/firestore_lite.documentdata.md
|
|
- title: DocumentReference
|
|
path: /docs/reference/js/firestore_lite.documentreference.md
|
|
- title: DocumentSnapshot
|
|
path: /docs/reference/js/firestore_lite.documentsnapshot.md
|
|
- title: FieldPath
|
|
path: /docs/reference/js/firestore_lite.fieldpath.md
|
|
- title: FieldValue
|
|
path: /docs/reference/js/firestore_lite.fieldvalue.md
|
|
- title: Firestore
|
|
path: /docs/reference/js/firestore_lite.firestore.md
|
|
- title: FirestoreDataConverter
|
|
path: /docs/reference/js/firestore_lite.firestoredataconverter.md
|
|
- title: FirestoreError
|
|
path: /docs/reference/js/firestore_lite.firestoreerror.md
|
|
- title: GeoPoint
|
|
path: /docs/reference/js/firestore_lite.geopoint.md
|
|
- title: Query
|
|
path: /docs/reference/js/firestore_lite.query.md
|
|
- title: QueryCompositeFilterConstraint
|
|
path: /docs/reference/js/firestore_lite.querycompositefilterconstraint.md
|
|
- title: QueryConstraint
|
|
path: /docs/reference/js/firestore_lite.queryconstraint.md
|
|
- title: QueryDocumentSnapshot
|
|
path: /docs/reference/js/firestore_lite.querydocumentsnapshot.md
|
|
- title: QueryEndAtConstraint
|
|
path: /docs/reference/js/firestore_lite.queryendatconstraint.md
|
|
- title: QueryFieldFilterConstraint
|
|
path: /docs/reference/js/firestore_lite.queryfieldfilterconstraint.md
|
|
- title: QueryLimitConstraint
|
|
path: /docs/reference/js/firestore_lite.querylimitconstraint.md
|
|
- title: QueryOrderByConstraint
|
|
path: /docs/reference/js/firestore_lite.queryorderbyconstraint.md
|
|
- title: QuerySnapshot
|
|
path: /docs/reference/js/firestore_lite.querysnapshot.md
|
|
- title: QueryStartAtConstraint
|
|
path: /docs/reference/js/firestore_lite.querystartatconstraint.md
|
|
- title: Settings
|
|
path: /docs/reference/js/firestore_lite.settings.md
|
|
- title: Timestamp
|
|
path: /docs/reference/js/firestore_lite.timestamp.md
|
|
- title: Transaction
|
|
path: /docs/reference/js/firestore_lite.transaction.md
|
|
- title: TransactionOptions
|
|
path: /docs/reference/js/firestore_lite.transactionoptions.md
|
|
- title: VectorValue
|
|
path: /docs/reference/js/firestore_lite.vectorvalue.md
|
|
- title: WriteBatch
|
|
path: /docs/reference/js/firestore_lite.writebatch.md
|
|
- title: firestore/lite/pipelines
|
|
path: /docs/reference/js/firestore_lite_pipelines.md
|
|
section:
|
|
- title: AggregateFunction
|
|
path: /docs/reference/js/firestore_lite_pipelines.aggregatefunction.md
|
|
- title: AliasedAggregate
|
|
path: /docs/reference/js/firestore_lite_pipelines.aliasedaggregate.md
|
|
- title: AliasedExpression
|
|
path: /docs/reference/js/firestore_lite_pipelines.aliasedexpression.md
|
|
- title: BooleanExpression
|
|
path: /docs/reference/js/firestore_lite_pipelines.booleanexpression.md
|
|
- title: Bytes
|
|
path: /docs/reference/js/firestore_lite_pipelines.bytes.md
|
|
- title: CollectionReference
|
|
path: /docs/reference/js/firestore_lite_pipelines.collectionreference.md
|
|
- title: DocumentData
|
|
path: /docs/reference/js/firestore_lite_pipelines.documentdata.md
|
|
- title: DocumentReference
|
|
path: /docs/reference/js/firestore_lite_pipelines.documentreference.md
|
|
- title: DocumentSnapshot
|
|
path: /docs/reference/js/firestore_lite_pipelines.documentsnapshot.md
|
|
- title: Expression
|
|
path: /docs/reference/js/firestore_lite_pipelines.expression.md
|
|
- title: Field
|
|
path: /docs/reference/js/firestore_lite_pipelines.field.md
|
|
- title: FieldPath
|
|
path: /docs/reference/js/firestore_lite_pipelines.fieldpath.md
|
|
- title: FieldValue
|
|
path: /docs/reference/js/firestore_lite_pipelines.fieldvalue.md
|
|
- title: Firestore
|
|
path: /docs/reference/js/firestore_lite_pipelines.firestore.md
|
|
- title: FirestoreDataConverter
|
|
path: /docs/reference/js/firestore_lite_pipelines.firestoredataconverter.md
|
|
- title: FunctionExpression
|
|
path: /docs/reference/js/firestore_lite_pipelines.functionexpression.md
|
|
- title: GeoPoint
|
|
path: /docs/reference/js/firestore_lite_pipelines.geopoint.md
|
|
- title: Ordering
|
|
path: /docs/reference/js/firestore_lite_pipelines.ordering.md
|
|
- title: Pipeline
|
|
path: /docs/reference/js/firestore_lite_pipelines.pipeline.md
|
|
- title: PipelineResult
|
|
path: /docs/reference/js/firestore_lite_pipelines.pipelineresult.md
|
|
- title: PipelineSnapshot
|
|
path: /docs/reference/js/firestore_lite_pipelines.pipelinesnapshot.md
|
|
- title: PipelineSource
|
|
path: /docs/reference/js/firestore_lite_pipelines.pipelinesource.md
|
|
- title: Query
|
|
path: /docs/reference/js/firestore_lite_pipelines.query.md
|
|
- title: QueryDocumentSnapshot
|
|
path: /docs/reference/js/firestore_lite_pipelines.querydocumentsnapshot.md
|
|
- title: Selectable
|
|
path: /docs/reference/js/firestore_lite_pipelines.selectable.md
|
|
- title: Timestamp
|
|
path: /docs/reference/js/firestore_lite_pipelines.timestamp.md
|
|
- title: VectorValue
|
|
path: /docs/reference/js/firestore_lite_pipelines.vectorvalue.md
|
|
- title: firestore/pipelines
|
|
path: /docs/reference/js/firestore_pipelines.md
|
|
section:
|
|
- title: AggregateFunction
|
|
path: /docs/reference/js/firestore_pipelines.aggregatefunction.md
|
|
- title: AliasedAggregate
|
|
path: /docs/reference/js/firestore_pipelines.aliasedaggregate.md
|
|
- title: AliasedExpression
|
|
path: /docs/reference/js/firestore_pipelines.aliasedexpression.md
|
|
- title: BooleanExpression
|
|
path: /docs/reference/js/firestore_pipelines.booleanexpression.md
|
|
- title: Bytes
|
|
path: /docs/reference/js/firestore_pipelines.bytes.md
|
|
- title: CollectionReference
|
|
path: /docs/reference/js/firestore_pipelines.collectionreference.md
|
|
- title: DocumentData
|
|
path: /docs/reference/js/firestore_pipelines.documentdata.md
|
|
- title: DocumentReference
|
|
path: /docs/reference/js/firestore_pipelines.documentreference.md
|
|
- title: DocumentSnapshot
|
|
path: /docs/reference/js/firestore_pipelines.documentsnapshot.md
|
|
- title: Expression
|
|
path: /docs/reference/js/firestore_pipelines.expression.md
|
|
- title: Field
|
|
path: /docs/reference/js/firestore_pipelines.field.md
|
|
- title: FieldPath
|
|
path: /docs/reference/js/firestore_pipelines.fieldpath.md
|
|
- title: FieldValue
|
|
path: /docs/reference/js/firestore_pipelines.fieldvalue.md
|
|
- title: Firestore
|
|
path: /docs/reference/js/firestore_pipelines.firestore.md
|
|
- title: FirestoreDataConverter
|
|
path: /docs/reference/js/firestore_pipelines.firestoredataconverter.md
|
|
- title: FunctionExpression
|
|
path: /docs/reference/js/firestore_pipelines.functionexpression.md
|
|
- title: GeoPoint
|
|
path: /docs/reference/js/firestore_pipelines.geopoint.md
|
|
- title: Ordering
|
|
path: /docs/reference/js/firestore_pipelines.ordering.md
|
|
- title: Pipeline
|
|
path: /docs/reference/js/firestore_pipelines.pipeline.md
|
|
- title: PipelineExecuteOptions
|
|
path: /docs/reference/js/firestore_pipelines.pipelineexecuteoptions.md
|
|
- title: PipelineResult
|
|
path: /docs/reference/js/firestore_pipelines.pipelineresult.md
|
|
- title: PipelineSnapshot
|
|
path: /docs/reference/js/firestore_pipelines.pipelinesnapshot.md
|
|
- title: PipelineSource
|
|
path: /docs/reference/js/firestore_pipelines.pipelinesource.md
|
|
- title: Query
|
|
path: /docs/reference/js/firestore_pipelines.query.md
|
|
- title: QueryDocumentSnapshot
|
|
path: /docs/reference/js/firestore_pipelines.querydocumentsnapshot.md
|
|
- title: Selectable
|
|
path: /docs/reference/js/firestore_pipelines.selectable.md
|
|
- title: SnapshotMetadata
|
|
path: /docs/reference/js/firestore_pipelines.snapshotmetadata.md
|
|
- title: SnapshotOptions
|
|
path: /docs/reference/js/firestore_pipelines.snapshotoptions.md
|
|
- title: Timestamp
|
|
path: /docs/reference/js/firestore_pipelines.timestamp.md
|
|
- title: VectorValue
|
|
path: /docs/reference/js/firestore_pipelines.vectorvalue.md
|
|
- title: functions
|
|
path: /docs/reference/js/functions.md
|
|
section:
|
|
- title: Functions
|
|
path: /docs/reference/js/functions.functions.md
|
|
- title: FunctionsError
|
|
path: /docs/reference/js/functions.functionserror.md
|
|
- title: HttpsCallable
|
|
path: /docs/reference/js/functions.httpscallable.md
|
|
- title: HttpsCallableOptions
|
|
path: /docs/reference/js/functions.httpscallableoptions.md
|
|
- title: HttpsCallableResult
|
|
path: /docs/reference/js/functions.httpscallableresult.md
|
|
- title: HttpsCallableStreamOptions
|
|
path: /docs/reference/js/functions.httpscallablestreamoptions.md
|
|
- title: HttpsCallableStreamResult
|
|
path: /docs/reference/js/functions.httpscallablestreamresult.md
|
|
- title: installations
|
|
path: /docs/reference/js/installations.md
|
|
section:
|
|
- title: Installations
|
|
path: /docs/reference/js/installations.installations.md
|
|
- title: messaging
|
|
path: /docs/reference/js/messaging_.md
|
|
section:
|
|
- title: FcmOptions
|
|
path: /docs/reference/js/messaging_.fcmoptions.md
|
|
- title: GetTokenOptions
|
|
path: /docs/reference/js/messaging_.gettokenoptions.md
|
|
- title: MessagePayload
|
|
path: /docs/reference/js/messaging_.messagepayload.md
|
|
- title: Messaging
|
|
path: /docs/reference/js/messaging_.messaging.md
|
|
- title: NotificationPayload
|
|
path: /docs/reference/js/messaging_.notificationpayload.md
|
|
- title: RegisterOptions
|
|
path: /docs/reference/js/messaging_.registeroptions.md
|
|
- title: messaging/sw
|
|
path: /docs/reference/js/messaging_sw.md
|
|
section:
|
|
- title: FcmOptions
|
|
path: /docs/reference/js/messaging_sw.fcmoptions.md
|
|
- title: GetTokenOptions
|
|
path: /docs/reference/js/messaging_sw.gettokenoptions.md
|
|
- title: MessagePayload
|
|
path: /docs/reference/js/messaging_sw.messagepayload.md
|
|
- title: Messaging
|
|
path: /docs/reference/js/messaging_sw.messaging.md
|
|
- title: NotificationPayload
|
|
path: /docs/reference/js/messaging_sw.notificationpayload.md
|
|
- title: RegisterOptions
|
|
path: /docs/reference/js/messaging_sw.registeroptions.md
|
|
- title: performance
|
|
path: /docs/reference/js/performance.md
|
|
section:
|
|
- title: FirebasePerformance
|
|
path: /docs/reference/js/performance.firebaseperformance.md
|
|
- title: PerformanceSettings
|
|
path: /docs/reference/js/performance.performancesettings.md
|
|
- title: PerformanceTrace
|
|
path: /docs/reference/js/performance.performancetrace.md
|
|
- title: remote-config
|
|
path: /docs/reference/js/remote-config.md
|
|
section:
|
|
- title: ConfigUpdate
|
|
path: /docs/reference/js/remote-config.configupdate.md
|
|
- title: ConfigUpdateObserver
|
|
path: /docs/reference/js/remote-config.configupdateobserver.md
|
|
- title: CustomSignals
|
|
path: /docs/reference/js/remote-config.customsignals.md
|
|
- title: FetchResponse
|
|
path: /docs/reference/js/remote-config.fetchresponse.md
|
|
- title: FirebaseExperimentDescription
|
|
path: /docs/reference/js/remote-config.firebaseexperimentdescription.md
|
|
- title: FirebaseRemoteConfigObject
|
|
path: /docs/reference/js/remote-config.firebaseremoteconfigobject.md
|
|
- title: FirebaseRolloutMetadata
|
|
path: /docs/reference/js/remote-config.firebaserolloutmetadata.md
|
|
- title: RemoteConfig
|
|
path: /docs/reference/js/remote-config.remoteconfig.md
|
|
- title: RemoteConfigOptions
|
|
path: /docs/reference/js/remote-config.remoteconfigoptions.md
|
|
- title: RemoteConfigSettings
|
|
path: /docs/reference/js/remote-config.remoteconfigsettings.md
|
|
- title: Value
|
|
path: /docs/reference/js/remote-config.value.md
|
|
- title: storage
|
|
path: /docs/reference/js/storage.md
|
|
section:
|
|
- title: FirebaseStorage
|
|
path: /docs/reference/js/storage.firebasestorage.md
|
|
- title: FullMetadata
|
|
path: /docs/reference/js/storage.fullmetadata.md
|
|
- title: ListOptions
|
|
path: /docs/reference/js/storage.listoptions.md
|
|
- title: ListResult
|
|
path: /docs/reference/js/storage.listresult.md
|
|
- title: SettableMetadata
|
|
path: /docs/reference/js/storage.settablemetadata.md
|
|
- title: StorageError
|
|
path: /docs/reference/js/storage.storageerror.md
|
|
- title: StorageObserver
|
|
path: /docs/reference/js/storage.storageobserver.md
|
|
- title: StorageReference
|
|
path: /docs/reference/js/storage.storagereference.md
|
|
- title: UploadMetadata
|
|
path: /docs/reference/js/storage.uploadmetadata.md
|
|
- title: UploadResult
|
|
path: /docs/reference/js/storage.uploadresult.md
|
|
- title: UploadTask
|
|
path: /docs/reference/js/storage.uploadtask.md
|
|
- title: UploadTaskSnapshot
|
|
path: /docs/reference/js/storage.uploadtasksnapshot.md
|