diff --git a/docs-devsite/_toc.yaml b/docs-devsite/_toc.yaml deleted file mode 100644 index 04d65f6c333..00000000000 --- a/docs-devsite/_toc.yaml +++ /dev/null @@ -1,696 +0,0 @@ -toc: -- title: firebase - path: /docs/reference/js/index -- title: ai - path: /docs/reference/js/ai.md - section: - - 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: Backend - path: /docs/reference/js/ai.backend.md - - title: BaseParams - path: /docs/reference/js/ai.baseparams.md - - title: BooleanSchema - path: /docs/reference/js/ai.booleanschema.md - - title: ChatSession - path: /docs/reference/js/ai.chatsession.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: 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: 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: 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: 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: 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: 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: ModalityTokenCount - path: /docs/reference/js/ai.modalitytokencount.md - - title: ModelParams - path: /docs/reference/js/ai.modelparams.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: 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: SpeechConfig - path: /docs/reference/js/ai.speechconfig.md - - title: StartAudioConversationOptions - path: /docs/reference/js/ai.startaudioconversationoptions.md - - title: StartChatParams - path: /docs/reference/js/ai.startchatparams.md - - title: StringSchema - path: /docs/reference/js/ai.stringschema.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: 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: 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: 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: 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: FirebaseRemoteConfigObject - path: /docs/reference/js/remote-config.firebaseremoteconfigobject.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 diff --git a/docs-devsite/data-connect.connectorconfig.md b/docs-devsite/data-connect.connectorconfig.md new file mode 100644 index 00000000000..b4998e93a14 --- /dev/null +++ b/docs-devsite/data-connect.connectorconfig.md @@ -0,0 +1,51 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# ConnectorConfig interface +Connector Config for calling Data Connect backend. + +Signature: + +```typescript +export declare interface ConnectorConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [connector](./data-connect.connectorconfig.md#connectorconfigconnector) | string | | +| [location](./data-connect.connectorconfig.md#connectorconfiglocation) | string | | +| [service](./data-connect.connectorconfig.md#connectorconfigservice) | string | | + +## ConnectorConfig.connector + +Signature: + +```typescript +connector: string; +``` + +## ConnectorConfig.location + +Signature: + +```typescript +location: string; +``` + +## ConnectorConfig.service + +Signature: + +```typescript +service: string; +``` diff --git a/docs-devsite/data-connect.dataconnect.md b/docs-devsite/data-connect.dataconnect.md new file mode 100644 index 00000000000..bec53472e11 --- /dev/null +++ b/docs-devsite/data-connect.dataconnect.md @@ -0,0 +1,116 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnect class +Class representing Firebase Data Connect + +Signature: + +```typescript +export declare class DataConnect +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(app, dataConnectOptions, \_authProvider, \_appCheckProvider)](./data-connect.dataconnect.md#dataconnectconstructor) | | Constructs a new instance of the DataConnect class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [app](./data-connect.dataconnect.md#dataconnectapp) | | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | | +| [isEmulator](./data-connect.dataconnect.md#dataconnectisemulator) | | boolean | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [enableEmulator(transportOptions)](./data-connect.dataconnect.md#dataconnectenableemulator) | | | +| [getSettings()](./data-connect.dataconnect.md#dataconnectgetsettings) | | | +| [setInitialized()](./data-connect.dataconnect.md#dataconnectsetinitialized) | | | + +## DataConnect.(constructor) + +Constructs a new instance of the `DataConnect` class + +Signature: + +```typescript +constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider, _appCheckProvider: Provider); +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | | +| dataConnectOptions | [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | | +| \_authProvider | Provider<FirebaseAuthInternalName> | | +| \_appCheckProvider | Provider<AppCheckInternalComponentName> | | + +## DataConnect.app + +Signature: + +```typescript +readonly app: FirebaseApp; +``` + +## DataConnect.isEmulator + +Signature: + +```typescript +isEmulator: boolean; +``` + +## DataConnect.enableEmulator() + +Signature: + +```typescript +enableEmulator(transportOptions: TransportOptions): void; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| transportOptions | [TransportOptions](./data-connect.transportoptions.md#transportoptions_interface) | | + +Returns: + +void + +## DataConnect.getSettings() + +Signature: + +```typescript +getSettings(): ConnectorConfig; +``` +Returns: + +[ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface) + +## DataConnect.setInitialized() + +Signature: + +```typescript +setInitialized(): void; +``` +Returns: + +void + diff --git a/docs-devsite/data-connect.dataconnecterror.md b/docs-devsite/data-connect.dataconnecterror.md new file mode 100644 index 00000000000..638ed7ce5f2 --- /dev/null +++ b/docs-devsite/data-connect.dataconnecterror.md @@ -0,0 +1,44 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectError class +An error returned by a DataConnect operation. + +Signature: + +```typescript +export declare class DataConnectError extends FirebaseError +``` +Extends: [FirebaseError](./util.firebaseerror.md#firebaseerror_class) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(code, message)](./data-connect.dataconnecterror.md#dataconnecterrorconstructor) | | Constructs a new instance of the DataConnectError class | + +## DataConnectError.(constructor) + +Constructs a new instance of the `DataConnectError` class + +Signature: + +```typescript +constructor(code: Code, message: string); +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| code | [Code](./data-connect.md#code) | | +| message | string | | + diff --git a/docs-devsite/data-connect.dataconnectoperationerror.md b/docs-devsite/data-connect.dataconnectoperationerror.md new file mode 100644 index 00000000000..f676ab14840 --- /dev/null +++ b/docs-devsite/data-connect.dataconnectoperationerror.md @@ -0,0 +1,36 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectOperationError class +An error returned by a DataConnect operation. + +Signature: + +```typescript +export declare class DataConnectOperationError extends DataConnectError +``` +Extends: [DataConnectError](./data-connect.dataconnecterror.md#dataconnecterror_class) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [response](./data-connect.dataconnectoperationerror.md#dataconnectoperationerrorresponse) | | [DataConnectOperationFailureResponse](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponse_interface) | The response received from the backend. | + +## DataConnectOperationError.response + +The response received from the backend. + +Signature: + +```typescript +readonly response: DataConnectOperationFailureResponse; +``` diff --git a/docs-devsite/data-connect.dataconnectoperationfailureresponse.md b/docs-devsite/data-connect.dataconnectoperationfailureresponse.md new file mode 100644 index 00000000000..d0f31f041d5 --- /dev/null +++ b/docs-devsite/data-connect.dataconnectoperationfailureresponse.md @@ -0,0 +1,40 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectOperationFailureResponse interface +Signature: + +```typescript +export declare interface DataConnectOperationFailureResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [data](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponsedata) | Record<string, unknown> \| null | | +| [errors](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponseerrors) | [DataConnectOperationFailureResponseErrorInfo](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfo_interface)\[\] | | + +## DataConnectOperationFailureResponse.data + +Signature: + +```typescript +readonly data?: Record | null; +``` + +## DataConnectOperationFailureResponse.errors + +Signature: + +```typescript +readonly errors: DataConnectOperationFailureResponseErrorInfo[]; +``` diff --git a/docs-devsite/data-connect.dataconnectoperationfailureresponseerrorinfo.md b/docs-devsite/data-connect.dataconnectoperationfailureresponseerrorinfo.md new file mode 100644 index 00000000000..906a8b94868 --- /dev/null +++ b/docs-devsite/data-connect.dataconnectoperationfailureresponseerrorinfo.md @@ -0,0 +1,40 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectOperationFailureResponseErrorInfo interface +Signature: + +```typescript +export declare interface DataConnectOperationFailureResponseErrorInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [message](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfomessage) | string | | +| [path](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfopath) | Array<string \| number> | | + +## DataConnectOperationFailureResponseErrorInfo.message + +Signature: + +```typescript +readonly message: string; +``` + +## DataConnectOperationFailureResponseErrorInfo.path + +Signature: + +```typescript +readonly path: Array; +``` diff --git a/docs-devsite/data-connect.dataconnectoptions.md b/docs-devsite/data-connect.dataconnectoptions.md new file mode 100644 index 00000000000..8428cb65ca4 --- /dev/null +++ b/docs-devsite/data-connect.dataconnectoptions.md @@ -0,0 +1,34 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectOptions interface +DataConnectOptions including project id + +Signature: + +```typescript +export declare interface DataConnectOptions extends ConnectorConfig +``` +Extends: [ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [projectId](./data-connect.dataconnectoptions.md#dataconnectoptionsprojectid) | string | | + +## DataConnectOptions.projectId + +Signature: + +```typescript +projectId: string; +``` diff --git a/docs-devsite/data-connect.dataconnectresult.md b/docs-devsite/data-connect.dataconnectresult.md new file mode 100644 index 00000000000..788eef76869 --- /dev/null +++ b/docs-devsite/data-connect.dataconnectresult.md @@ -0,0 +1,32 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectResult interface +Signature: + +```typescript +export declare interface DataConnectResult extends OpResult +``` +Extends: [OpResult](./data-connect.opresult.md#opresult_interface)<Data> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [ref](./data-connect.dataconnectresult.md#dataconnectresultref) | [OperationRef](./data-connect.operationref.md#operationref_interface)<Data, Variables> | | + +## DataConnectResult.ref + +Signature: + +```typescript +ref: OperationRef; +``` diff --git a/docs-devsite/data-connect.dataconnectsubscription.md b/docs-devsite/data-connect.dataconnectsubscription.md new file mode 100644 index 00000000000..1ce290ef75b --- /dev/null +++ b/docs-devsite/data-connect.dataconnectsubscription.md @@ -0,0 +1,51 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# DataConnectSubscription interface +Representation of user provided subscription options. + +Signature: + +```typescript +export declare interface DataConnectSubscription +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [errCallback](./data-connect.dataconnectsubscription.md#dataconnectsubscriptionerrcallback) | (e?: [DataConnectError](./data-connect.dataconnecterror.md#dataconnecterror_class)) => void | | +| [unsubscribe](./data-connect.dataconnectsubscription.md#dataconnectsubscriptionunsubscribe) | () => void | | +| [userCallback](./data-connect.dataconnectsubscription.md#dataconnectsubscriptionusercallback) | [OnResultSubscription](./data-connect.md#onresultsubscription)<Data, Variables> | | + +## DataConnectSubscription.errCallback + +Signature: + +```typescript +errCallback?: (e?: DataConnectError) => void; +``` + +## DataConnectSubscription.unsubscribe + +Signature: + +```typescript +unsubscribe: () => void; +``` + +## DataConnectSubscription.userCallback + +Signature: + +```typescript +userCallback: OnResultSubscription; +``` diff --git a/docs-devsite/data-connect.md b/docs-devsite/data-connect.md new file mode 100644 index 00000000000..00586139a3d --- /dev/null +++ b/docs-devsite/data-connect.md @@ -0,0 +1,568 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# data-connect package +Firebase Data Connect + +## Functions + +| Function | Description | +| --- | --- | +| function(app, ...) | +| [getDataConnect(app, options)](./data-connect.md#getdataconnect_4a1329a) | Initialize DataConnect instance | +| function(dataConnect, ...) | +| [terminate(dataConnect)](./data-connect.md#terminate_43d8d88) | Delete DataConnect instance | +| function(dc, ...) | +| [connectDataConnectEmulator(dc, host, port, sslEnabled)](./data-connect.md#connectdataconnectemulator_842a91d) | Connect to the DataConnect Emulator | +| function(dcInstance, ...) | +| [mutationRef(dcInstance, mutationName)](./data-connect.md#mutationref_48ae5fa) | Creates a MutationRef | +| [mutationRef(dcInstance, mutationName, variables)](./data-connect.md#mutationref_1511672) | | +| [queryRef(dcInstance, queryName)](./data-connect.md#queryref_d968e5d) | Execute Query | +| [queryRef(dcInstance, queryName, variables)](./data-connect.md#queryref_6179f74) | Execute Query | +| function(logLevel, ...) | +| [setLogLevel(logLevel)](./data-connect.md#setloglevel_697d53a) | | +| function(mutationRef, ...) | +| [executeMutation(mutationRef)](./data-connect.md#executemutation_e8103b9) | Execute Mutation | +| function(options, ...) | +| [getDataConnect(options)](./data-connect.md#getdataconnect_f991922) | Initialize DataConnect instance | +| function(queryRef, ...) | +| [executeQuery(queryRef)](./data-connect.md#executequery_692a270) | Execute Query | +| function(queryRefOrSerializedResult, ...) | +| [subscribe(queryRefOrSerializedResult, observer)](./data-connect.md#subscribe_b2b4b07) | Subscribe to a QueryRef | +| [subscribe(queryRefOrSerializedResult, onNext, onError, onComplete)](./data-connect.md#subscribe_c02958e) | Subscribe to a QueryRef | +| function(serializedRef, ...) | +| [toQueryRef(serializedRef)](./data-connect.md#toqueryref_2c70e31) | Converts serialized ref to query ref | + +## Classes + +| Class | Description | +| --- | --- | +| [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Class representing Firebase Data Connect | +| [DataConnectError](./data-connect.dataconnecterror.md#dataconnecterror_class) | An error returned by a DataConnect operation. | +| [DataConnectOperationError](./data-connect.dataconnectoperationerror.md#dataconnectoperationerror_class) | An error returned by a DataConnect operation. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface) | Connector Config for calling Data Connect backend. | +| [DataConnectOperationFailureResponse](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponse_interface) | | +| [DataConnectOperationFailureResponseErrorInfo](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfo_interface) | | +| [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | DataConnectOptions including project id | +| [DataConnectResult](./data-connect.dataconnectresult.md#dataconnectresult_interface) | | +| [DataConnectSubscription](./data-connect.dataconnectsubscription.md#dataconnectsubscription_interface) | Representation of user provided subscription options. | +| [MutationPromise](./data-connect.mutationpromise.md#mutationpromise_interface) | Mutation return value from executeMutation | +| [MutationRef](./data-connect.mutationref.md#mutationref_interface) | | +| [MutationResult](./data-connect.mutationresult.md#mutationresult_interface) | Mutation Result from executeMutation | +| [OperationRef](./data-connect.operationref.md#operationref_interface) | | +| [OpResult](./data-connect.opresult.md#opresult_interface) | | +| [QueryPromise](./data-connect.querypromise.md#querypromise_interface) | Promise returned from executeQuery | +| [QueryRef](./data-connect.queryref.md#queryref_interface) | QueryRef object | +| [QueryResult](./data-connect.queryresult.md#queryresult_interface) | Result of executeQuery | +| [RefInfo](./data-connect.refinfo.md#refinfo_interface) | Serialized RefInfo as a result of QueryResult.toJSON().refInfo | +| [SerializedRef](./data-connect.serializedref.md#serializedref_interface) | Serialized Ref as a result of QueryResult.toJSON() | +| [SubscriptionOptions](./data-connect.subscriptionoptions.md#subscriptionoptions_interface) | Representation of full observer options in subscribe | +| [TransportOptions](./data-connect.transportoptions.md#transportoptions_interface) | Options to connect to emulator | + +## Variables + +| Variable | Description | +| --- | --- | +| [CallerSdkTypeEnum](./data-connect.md#callersdktypeenum) | | +| [Code](./data-connect.md#code) | | +| [MUTATION\_STR](./data-connect.md#mutation_str) | | +| [QUERY\_STR](./data-connect.md#query_str) | | +| [SOURCE\_CACHE](./data-connect.md#source_cache) | | +| [SOURCE\_SERVER](./data-connect.md#source_server) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [CallerSdkType](./data-connect.md#callersdktype) | enum representing different flavors of the SDK used by developers use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning | +| [Code](./data-connect.md#code) | | +| [DataConnectErrorCode](./data-connect.md#dataconnecterrorcode) | | +| [DataSource](./data-connect.md#datasource) | | +| [OnCompleteSubscription](./data-connect.md#oncompletesubscription) | OnCompleteSubscription | +| [OnErrorSubscription](./data-connect.md#onerrorsubscription) | Signature for OnErrorSubscription for subscribe | +| [OnResultSubscription](./data-connect.md#onresultsubscription) | Signature for OnResultSubscription for subscribe | +| [QueryUnsubscribe](./data-connect.md#queryunsubscribe) | Signature for unsubscribe from subscribe | +| [ReferenceType](./data-connect.md#referencetype) | | + +## function(app, ...) + +### getDataConnect(app, options) {:#getdataconnect_4a1329a} + +Initialize DataConnect instance + +Signature: + +```typescript +export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | FirebaseApp to initialize to. | +| options | [ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface) | ConnectorConfig | + +Returns: + +[DataConnect](./data-connect.dataconnect.md#dataconnect_class) + +## function(dataConnect, ...) + +### terminate(dataConnect) {:#terminate_43d8d88} + +Delete DataConnect instance + +Signature: + +```typescript +export declare function terminate(dataConnect: DataConnect): Promise; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dataConnect | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | DataConnect instance | + +Returns: + +Promise<void> + + +## function(dc, ...) + +### connectDataConnectEmulator(dc, host, port, sslEnabled) {:#connectdataconnectemulator_842a91d} + +Connect to the DataConnect Emulator + +Signature: + +```typescript +export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dc | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Data Connect instance | +| host | string | host of emulator server | +| port | number | port of emulator server | +| sslEnabled | boolean | use https | + +Returns: + +void + +## function(dcInstance, ...) + +### mutationRef(dcInstance, mutationName) {:#mutationref_48ae5fa} + +Creates a `MutationRef` + +Signature: + +```typescript +export declare function mutationRef(dcInstance: DataConnect, mutationName: string): MutationRef; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dcInstance | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Data Connect instance | +| mutationName | string | name of mutation | + +Returns: + +[MutationRef](./data-connect.mutationref.md#mutationref_interface)<Data, undefined> + +### mutationRef(dcInstance, mutationName, variables) {:#mutationref_1511672} + +Signature: + +```typescript +export declare function mutationRef(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dcInstance | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Data Connect instance | +| mutationName | string | name of mutation | +| variables | Variables | variables to send with mutation | + +Returns: + +[MutationRef](./data-connect.mutationref.md#mutationref_interface)<Data, Variables> + +### queryRef(dcInstance, queryName) {:#queryref_d968e5d} + +Execute Query + +Signature: + +```typescript +export declare function queryRef(dcInstance: DataConnect, queryName: string): QueryRef; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dcInstance | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Data Connect instance to use. | +| queryName | string | Query to execute | + +Returns: + +[QueryRef](./data-connect.queryref.md#queryref_interface)<Data, undefined> + +`QueryRef` + +### queryRef(dcInstance, queryName, variables) {:#queryref_6179f74} + +Execute Query + +Signature: + +```typescript +export declare function queryRef(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dcInstance | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Data Connect instance to use. | +| queryName | string | Query to execute | +| variables | Variables | Variables to execute with | + +Returns: + +[QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> + +`QueryRef` + +## function(logLevel, ...) + +### setLogLevel(logLevel) {:#setloglevel_697d53a} + +Signature: + +```typescript +export declare function setLogLevel(logLevel: LogLevelString): void; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| logLevel | LogLevelString | | + +Returns: + +void + +## function(mutationRef, ...) + +### executeMutation(mutationRef) {:#executemutation_e8103b9} + +Execute Mutation + +Signature: + +```typescript +export declare function executeMutation(mutationRef: MutationRef): MutationPromise; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| mutationRef | [MutationRef](./data-connect.mutationref.md#mutationref_interface)<Data, Variables> | mutation to execute | + +Returns: + +[MutationPromise](./data-connect.mutationpromise.md#mutationpromise_interface)<Data, Variables> + +`MutationRef` + +## function(options, ...) + +### getDataConnect(options) {:#getdataconnect_f991922} + +Initialize DataConnect instance + +Signature: + +```typescript +export declare function getDataConnect(options: ConnectorConfig): DataConnect; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface) | ConnectorConfig | + +Returns: + +[DataConnect](./data-connect.dataconnect.md#dataconnect_class) + +## function(queryRef, ...) + +### executeQuery(queryRef) {:#executequery_692a270} + +Execute Query + +Signature: + +```typescript +export declare function executeQuery(queryRef: QueryRef): QueryPromise; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| queryRef | [QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> | query to execute. | + +Returns: + +[QueryPromise](./data-connect.querypromise.md#querypromise_interface)<Data, Variables> + +`QueryPromise` + +## function(queryRefOrSerializedResult, ...) + +### subscribe(queryRefOrSerializedResult, observer) {:#subscribe_b2b4b07} + +Subscribe to a `QueryRef` + +Signature: + +```typescript +export declare function subscribe(queryRefOrSerializedResult: QueryRef | SerializedRef, observer: SubscriptionOptions): QueryUnsubscribe; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| queryRefOrSerializedResult | [QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> \| [SerializedRef](./data-connect.serializedref.md#serializedref_interface)<Data, Variables> | query ref or serialized result. | +| observer | [SubscriptionOptions](./data-connect.subscriptionoptions.md#subscriptionoptions_interface)<Data, Variables> | observer object to use for subscribing. | + +Returns: + +[QueryUnsubscribe](./data-connect.md#queryunsubscribe) + +`SubscriptionOptions` + +### subscribe(queryRefOrSerializedResult, onNext, onError, onComplete) {:#subscribe_c02958e} + +Subscribe to a `QueryRef` + +Signature: + +```typescript +export declare function subscribe(queryRefOrSerializedResult: QueryRef | SerializedRef, onNext: OnResultSubscription, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| queryRefOrSerializedResult | [QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> \| [SerializedRef](./data-connect.serializedref.md#serializedref_interface)<Data, Variables> | query ref or serialized result. | +| onNext | [OnResultSubscription](./data-connect.md#onresultsubscription)<Data, Variables> | Callback to call when result comes back. | +| onError | [OnErrorSubscription](./data-connect.md#onerrorsubscription) | Callback to call when error gets thrown. | +| onComplete | [OnCompleteSubscription](./data-connect.md#oncompletesubscription) | Called when subscription completes. | + +Returns: + +[QueryUnsubscribe](./data-connect.md#queryunsubscribe) + +`SubscriptionOptions` + +## function(serializedRef, ...) + +### toQueryRef(serializedRef) {:#toqueryref_2c70e31} + +Converts serialized ref to query ref + +Signature: + +```typescript +export declare function toQueryRef(serializedRef: SerializedRef): QueryRef; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| serializedRef | [SerializedRef](./data-connect.serializedref.md#serializedref_interface)<Data, Variables> | ref to convert to QueryRef | + +Returns: + +[QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> + +`QueryRef` + +## CallerSdkTypeEnum + +Signature: + +```typescript +CallerSdkTypeEnum: { + readonly Base: "Base"; + readonly Generated: "Generated"; + readonly TanstackReactCore: "TanstackReactCore"; + readonly GeneratedReact: "GeneratedReact"; + readonly TanstackAngularCore: "TanstackAngularCore"; + readonly GeneratedAngular: "GeneratedAngular"; +} +``` + +## Code + +Signature: + +```typescript +Code: { + OTHER: DataConnectErrorCode; + ALREADY_INITIALIZED: DataConnectErrorCode; + NOT_INITIALIZED: DataConnectErrorCode; + NOT_SUPPORTED: DataConnectErrorCode; + INVALID_ARGUMENT: DataConnectErrorCode; + PARTIAL_ERROR: DataConnectErrorCode; + UNAUTHORIZED: DataConnectErrorCode; +} +``` + +## MUTATION\_STR + +Signature: + +```typescript +MUTATION_STR = "mutation" +``` + +## QUERY\_STR + +Signature: + +```typescript +QUERY_STR = "query" +``` + +## SOURCE\_CACHE + +Signature: + +```typescript +SOURCE_CACHE = "CACHE" +``` + +## SOURCE\_SERVER + +Signature: + +```typescript +SOURCE_SERVER = "SERVER" +``` + +## CallerSdkType + +enum representing different flavors of the SDK used by developers use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning + +Signature: + +```typescript +export declare type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular'; +``` + +## Code + +Signature: + +```typescript +export declare type Code = DataConnectErrorCode; +``` + +## DataConnectErrorCode + +Signature: + +```typescript +export declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized'; +``` + +## DataSource + +Signature: + +```typescript +export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER; +``` + +## OnCompleteSubscription + +`OnCompleteSubscription` + +Signature: + +```typescript +export declare type OnCompleteSubscription = () => void; +``` + +## OnErrorSubscription + +Signature for `OnErrorSubscription` for `subscribe` + +Signature: + +```typescript +export declare type OnErrorSubscription = (err?: DataConnectError) => void; +``` + +## OnResultSubscription + +Signature for `OnResultSubscription` for `subscribe` + +Signature: + +```typescript +export declare type OnResultSubscription = (res: QueryResult) => void; +``` + +## QueryUnsubscribe + +Signature for unsubscribe from `subscribe` + +Signature: + +```typescript +export declare type QueryUnsubscribe = () => void; +``` + +## ReferenceType + +Signature: + +```typescript +export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR; +``` diff --git a/docs-devsite/data-connect.mutationpromise.md b/docs-devsite/data-connect.mutationpromise.md new file mode 100644 index 00000000000..4d9d385a1ca --- /dev/null +++ b/docs-devsite/data-connect.mutationpromise.md @@ -0,0 +1,21 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# MutationPromise interface +Mutation return value from `executeMutation` + +Signature: + +```typescript +export declare interface MutationPromise extends Promise> +``` +Extends: Promise<[MutationResult](./data-connect.mutationresult.md#mutationresult_interface)<Data, Variables>> + diff --git a/docs-devsite/data-connect.mutationref.md b/docs-devsite/data-connect.mutationref.md new file mode 100644 index 00000000000..0cf5a7185c4 --- /dev/null +++ b/docs-devsite/data-connect.mutationref.md @@ -0,0 +1,32 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# MutationRef interface +Signature: + +```typescript +export declare interface MutationRef extends OperationRef +``` +Extends: [OperationRef](./data-connect.operationref.md#operationref_interface)<Data, Variables> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [refType](./data-connect.mutationref.md#mutationrefreftype) | typeof [MUTATION\_STR](./data-connect.md#mutation_str) | | + +## MutationRef.refType + +Signature: + +```typescript +refType: typeof MUTATION_STR; +``` diff --git a/docs-devsite/data-connect.mutationresult.md b/docs-devsite/data-connect.mutationresult.md new file mode 100644 index 00000000000..94067123cff --- /dev/null +++ b/docs-devsite/data-connect.mutationresult.md @@ -0,0 +1,34 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# MutationResult interface +Mutation Result from `executeMutation` + +Signature: + +```typescript +export declare interface MutationResult extends DataConnectResult +``` +Extends: [DataConnectResult](./data-connect.dataconnectresult.md#dataconnectresult_interface)<Data, Variables> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [ref](./data-connect.mutationresult.md#mutationresultref) | [MutationRef](./data-connect.mutationref.md#mutationref_interface)<Data, Variables> | | + +## MutationResult.ref + +Signature: + +```typescript +ref: MutationRef; +``` diff --git a/docs-devsite/data-connect.operationref.md b/docs-devsite/data-connect.operationref.md new file mode 100644 index 00000000000..e73d249fbda --- /dev/null +++ b/docs-devsite/data-connect.operationref.md @@ -0,0 +1,58 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# OperationRef interface +Signature: + +```typescript +export declare interface OperationRef<_Data, Variables> +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [dataConnect](./data-connect.operationref.md#operationrefdataconnect) | [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | | +| [name](./data-connect.operationref.md#operationrefname) | string | | +| [refType](./data-connect.operationref.md#operationrefreftype) | [ReferenceType](./data-connect.md#referencetype) | | +| [variables](./data-connect.operationref.md#operationrefvariables) | Variables | | + +## OperationRef.dataConnect + +Signature: + +```typescript +dataConnect: DataConnect; +``` + +## OperationRef.name + +Signature: + +```typescript +name: string; +``` + +## OperationRef.refType + +Signature: + +```typescript +refType: ReferenceType; +``` + +## OperationRef.variables + +Signature: + +```typescript +variables: Variables; +``` diff --git a/docs-devsite/data-connect.opresult.md b/docs-devsite/data-connect.opresult.md new file mode 100644 index 00000000000..1f0a4c2c0f2 --- /dev/null +++ b/docs-devsite/data-connect.opresult.md @@ -0,0 +1,49 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# OpResult interface +Signature: + +```typescript +export declare interface OpResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [data](./data-connect.opresult.md#opresultdata) | Data | | +| [fetchTime](./data-connect.opresult.md#opresultfetchtime) | string | | +| [source](./data-connect.opresult.md#opresultsource) | [DataSource](./data-connect.md#datasource) | | + +## OpResult.data + +Signature: + +```typescript +data: Data; +``` + +## OpResult.fetchTime + +Signature: + +```typescript +fetchTime: string; +``` + +## OpResult.source + +Signature: + +```typescript +source: DataSource; +``` diff --git a/docs-devsite/data-connect.querypromise.md b/docs-devsite/data-connect.querypromise.md new file mode 100644 index 00000000000..21bf5d49324 --- /dev/null +++ b/docs-devsite/data-connect.querypromise.md @@ -0,0 +1,21 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# QueryPromise interface +Promise returned from `executeQuery` + +Signature: + +```typescript +export declare interface QueryPromise extends Promise> +``` +Extends: Promise<[QueryResult](./data-connect.queryresult.md#queryresult_interface)<Data, Variables>> + diff --git a/docs-devsite/data-connect.queryref.md b/docs-devsite/data-connect.queryref.md new file mode 100644 index 00000000000..2e67c884016 --- /dev/null +++ b/docs-devsite/data-connect.queryref.md @@ -0,0 +1,34 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# QueryRef interface +QueryRef object + +Signature: + +```typescript +export declare interface QueryRef extends OperationRef +``` +Extends: [OperationRef](./data-connect.operationref.md#operationref_interface)<Data, Variables> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [refType](./data-connect.queryref.md#queryrefreftype) | typeof [QUERY\_STR](./data-connect.md#query_str) | | + +## QueryRef.refType + +Signature: + +```typescript +refType: typeof QUERY_STR; +``` diff --git a/docs-devsite/data-connect.queryresult.md b/docs-devsite/data-connect.queryresult.md new file mode 100644 index 00000000000..ac0380e2002 --- /dev/null +++ b/docs-devsite/data-connect.queryresult.md @@ -0,0 +1,43 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# QueryResult interface +Result of `executeQuery` + +Signature: + +```typescript +export declare interface QueryResult extends DataConnectResult +``` +Extends: [DataConnectResult](./data-connect.dataconnectresult.md#dataconnectresult_interface)<Data, Variables> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [ref](./data-connect.queryresult.md#queryresultref) | [QueryRef](./data-connect.queryref.md#queryref_interface)<Data, Variables> | | +| [toJSON](./data-connect.queryresult.md#queryresulttojson) | () => [SerializedRef](./data-connect.serializedref.md#serializedref_interface)<Data, Variables> | | + +## QueryResult.ref + +Signature: + +```typescript +ref: QueryRef; +``` + +## QueryResult.toJSON + +Signature: + +```typescript +toJSON: () => SerializedRef; +``` diff --git a/docs-devsite/data-connect.refinfo.md b/docs-devsite/data-connect.refinfo.md new file mode 100644 index 00000000000..6114fc0a1fc --- /dev/null +++ b/docs-devsite/data-connect.refinfo.md @@ -0,0 +1,51 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# RefInfo interface +Serialized RefInfo as a result of `QueryResult.toJSON().refInfo` + +Signature: + +```typescript +export declare interface RefInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [connectorConfig](./data-connect.refinfo.md#refinfoconnectorconfig) | [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | | +| [name](./data-connect.refinfo.md#refinfoname) | string | | +| [variables](./data-connect.refinfo.md#refinfovariables) | Variables | | + +## RefInfo.connectorConfig + +Signature: + +```typescript +connectorConfig: DataConnectOptions; +``` + +## RefInfo.name + +Signature: + +```typescript +name: string; +``` + +## RefInfo.variables + +Signature: + +```typescript +variables: Variables; +``` diff --git a/docs-devsite/data-connect.serializedref.md b/docs-devsite/data-connect.serializedref.md new file mode 100644 index 00000000000..f93c94d722d --- /dev/null +++ b/docs-devsite/data-connect.serializedref.md @@ -0,0 +1,34 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# SerializedRef interface +Serialized Ref as a result of `QueryResult.toJSON()` + +Signature: + +```typescript +export declare interface SerializedRef extends OpResult +``` +Extends: [OpResult](./data-connect.opresult.md#opresult_interface)<Data> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [refInfo](./data-connect.serializedref.md#serializedrefrefinfo) | [RefInfo](./data-connect.refinfo.md#refinfo_interface)<Variables> | | + +## SerializedRef.refInfo + +Signature: + +```typescript +refInfo: RefInfo; +``` diff --git a/docs-devsite/data-connect.subscriptionoptions.md b/docs-devsite/data-connect.subscriptionoptions.md new file mode 100644 index 00000000000..d666f5bb380 --- /dev/null +++ b/docs-devsite/data-connect.subscriptionoptions.md @@ -0,0 +1,51 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# SubscriptionOptions interface +Representation of full observer options in `subscribe` + +Signature: + +```typescript +export declare interface SubscriptionOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [onComplete](./data-connect.subscriptionoptions.md#subscriptionoptionsoncomplete) | [OnCompleteSubscription](./data-connect.md#oncompletesubscription) | | +| [onErr](./data-connect.subscriptionoptions.md#subscriptionoptionsonerr) | [OnErrorSubscription](./data-connect.md#onerrorsubscription) | | +| [onNext](./data-connect.subscriptionoptions.md#subscriptionoptionsonnext) | [OnResultSubscription](./data-connect.md#onresultsubscription)<Data, Variables> | | + +## SubscriptionOptions.onComplete + +Signature: + +```typescript +onComplete?: OnCompleteSubscription; +``` + +## SubscriptionOptions.onErr + +Signature: + +```typescript +onErr?: OnErrorSubscription; +``` + +## SubscriptionOptions.onNext + +Signature: + +```typescript +onNext?: OnResultSubscription; +``` diff --git a/docs-devsite/data-connect.transportoptions.md b/docs-devsite/data-connect.transportoptions.md new file mode 100644 index 00000000000..dbff25dc5d1 --- /dev/null +++ b/docs-devsite/data-connect.transportoptions.md @@ -0,0 +1,51 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# TransportOptions interface +Options to connect to emulator + +Signature: + +```typescript +export declare interface TransportOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [host](./data-connect.transportoptions.md#transportoptionshost) | string | | +| [port](./data-connect.transportoptions.md#transportoptionsport) | number | | +| [sslEnabled](./data-connect.transportoptions.md#transportoptionssslenabled) | boolean | | + +## TransportOptions.host + +Signature: + +```typescript +host: string; +``` + +## TransportOptions.port + +Signature: + +```typescript +port?: number; +``` + +## TransportOptions.sslEnabled + +Signature: + +```typescript +sslEnabled?: boolean; +``` diff --git a/docs-devsite/index.md b/docs-devsite/index.md index 47ec0be16ba..6c09b4fa12a 100644 --- a/docs-devsite/index.md +++ b/docs-devsite/index.md @@ -20,6 +20,7 @@ https://github.com/firebase/firebase-js-sdk | [@firebase/app](./app.md#app_package) | Firebase App | | [@firebase/app-check](./app-check.md#app-check_package) | The Firebase App Check Web SDK. | | [@firebase/auth](./auth.md#auth_package) | Firebase Authentication | +| [@firebase/data-connect](./data-connect.md#data-connect_package) | Firebase Data Connect | | [@firebase/database](./database.md#database_package) | Firebase Realtime Database | | [@firebase/firestore](./firestore.md#firestore_package) | Cloud Firestore | | [@firebase/functions](./functions.md#functions_package) | Cloud Functions for Firebase | diff --git a/scripts/docgen/docgen.ts b/scripts/docgen/docgen.ts index 26045f84711..eaa4a025bb2 100644 --- a/scripts/docgen/docgen.ts +++ b/scripts/docgen/docgen.ts @@ -41,7 +41,6 @@ const EXCLUDED_PACKAGES = [ 'app-compat', 'util', 'rules-unit-testing', - 'data-connect' ]; /**