From 626c05b36cfe7f91ac9b6aad730c0f04d6bb8c01 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Fri, 9 Apr 2021 11:18:56 -0700 Subject: [PATCH] Fix tsdoc and update reference docs (#4744) * fix tsdoc * fix tsdoc in rc * update reference docs --- common/api-review/firestore-exp.api.md | 2 +- common/api-review/firestore-lite.api.md | 2 +- common/api-review/installations-exp.api.md | 2 +- common/api-review/performance-exp.api.md | 2 +- common/api-review/remote-config-exp.api.md | 2 +- docs-exp/analytics-types.analytics.app.md | 13 -- docs-exp/analytics-types.analytics.md | 18 --- ...ytics-types.analyticscalloptions.global.md | 13 -- .../analytics-types.analyticscalloptions.md | 20 --- ...tics-types.controlparams.event_callback.md | 11 -- ...ytics-types.controlparams.event_timeout.md | 11 -- .../analytics-types.controlparams.groups.md | 11 -- docs-exp/analytics-types.controlparams.md | 23 --- .../analytics-types.controlparams.send_to.md | 11 -- docs-exp/analytics-types.currency.md | 11 -- docs-exp/analytics-types.customparams.md | 13 -- docs-exp/analytics-types.datalayer.md | 11 -- .../analytics-types.dynamicconfig.apikey.md | 11 -- .../analytics-types.dynamicconfig.appid.md | 11 -- ...nalytics-types.dynamicconfig.authdomain.md | 11 -- ...alytics-types.dynamicconfig.databaseurl.md | 11 -- ...nalytics-types.dynamicconfig.locationid.md | 11 -- docs-exp/analytics-types.dynamicconfig.md | 28 ---- ...ytics-types.dynamicconfig.measurementid.md | 11 -- ...s-types.dynamicconfig.messagingsenderid.md | 11 -- ...analytics-types.dynamicconfig.projectid.md | 11 -- ...ytics-types.dynamicconfig.storagebucket.md | 11 -- docs-exp/analytics-types.eventnamestring.md | 40 ------ ...analytics-types.eventparams.affiliation.md | 11 -- ...ytics-types.eventparams.checkout_option.md | 11 -- ...alytics-types.eventparams.checkout_step.md | 11 -- .../analytics-types.eventparams.content_id.md | 11 -- ...nalytics-types.eventparams.content_type.md | 11 -- .../analytics-types.eventparams.coupon.md | 11 -- .../analytics-types.eventparams.currency.md | 11 -- ...analytics-types.eventparams.description.md | 11 -- ...lytics-types.eventparams.event_category.md | 11 -- ...analytics-types.eventparams.event_label.md | 11 -- docs-exp/analytics-types.eventparams.fatal.md | 11 -- ...nalytics-types.eventparams.item_list_id.md | 11 -- ...lytics-types.eventparams.item_list_name.md | 11 -- docs-exp/analytics-types.eventparams.items.md | 11 -- docs-exp/analytics-types.eventparams.md | 49 ------- .../analytics-types.eventparams.method.md | 11 -- .../analytics-types.eventparams.number.md | 11 -- ...alytics-types.eventparams.page_location.md | 11 -- .../analytics-types.eventparams.page_path.md | 11 -- .../analytics-types.eventparams.page_title.md | 11 -- ...nalytics-types.eventparams.payment_type.md | 11 -- ...nalytics-types.eventparams.promotion_id.md | 11 -- ...lytics-types.eventparams.promotion_name.md | 11 -- .../analytics-types.eventparams.promotions.md | 11 -- ...analytics-types.eventparams.screen_name.md | 11 -- ...analytics-types.eventparams.search_term.md | 11 -- .../analytics-types.eventparams.shipping.md | 11 -- ...alytics-types.eventparams.shipping_tier.md | 11 -- docs-exp/analytics-types.eventparams.tax.md | 11 -- ...lytics-types.eventparams.transaction_id.md | 11 -- docs-exp/analytics-types.eventparams.value.md | 11 -- docs-exp/analytics-types.gtag.md | 13 -- docs-exp/analytics-types.item.affiliation.md | 11 -- docs-exp/analytics-types.item.brand.md | 16 --- docs-exp/analytics-types.item.category.md | 16 --- docs-exp/analytics-types.item.coupon.md | 11 -- .../analytics-types.item.creative_name.md | 11 -- .../analytics-types.item.creative_slot.md | 11 -- docs-exp/analytics-types.item.discount.md | 11 -- docs-exp/analytics-types.item.id.md | 16 --- docs-exp/analytics-types.item.index.md | 11 -- docs-exp/analytics-types.item.item_brand.md | 11 -- .../analytics-types.item.item_category.md | 11 -- .../analytics-types.item.item_category2.md | 11 -- .../analytics-types.item.item_category3.md | 11 -- .../analytics-types.item.item_category4.md | 11 -- .../analytics-types.item.item_category5.md | 11 -- docs-exp/analytics-types.item.item_id.md | 11 -- docs-exp/analytics-types.item.item_list_id.md | 11 -- .../analytics-types.item.item_list_name.md | 11 -- docs-exp/analytics-types.item.item_name.md | 11 -- docs-exp/analytics-types.item.item_variant.md | 11 -- docs-exp/analytics-types.item.location_id.md | 11 -- docs-exp/analytics-types.item.md | 43 ------ docs-exp/analytics-types.item.name.md | 16 --- docs-exp/analytics-types.item.price.md | 11 -- docs-exp/analytics-types.item.promotion_id.md | 11 -- .../analytics-types.item.promotion_name.md | 11 -- docs-exp/analytics-types.item.quantity.md | 11 -- docs-exp/analytics-types.md | 31 ---- ...lytics-types.minimaldynamicconfig.appid.md | 11 -- .../analytics-types.minimaldynamicconfig.md | 19 --- ...ypes.minimaldynamicconfig.measurementid.md | 11 -- ...analytics-types.promotion.creative_name.md | 11 -- ...analytics-types.promotion.creative_slot.md | 11 -- docs-exp/analytics-types.promotion.id.md | 11 -- docs-exp/analytics-types.promotion.md | 26 ---- docs-exp/analytics-types.promotion.name.md | 11 -- ...ics-types.settingsoptions.datalayername.md | 13 -- ...nalytics-types.settingsoptions.gtagname.md | 13 -- docs-exp/analytics-types.settingsoptions.md | 21 --- ...ics-types.throttlemetadata.backoffcount.md | 11 -- docs-exp/analytics-types.throttlemetadata.md | 21 --- ....throttlemetadata.throttleendtimemillis.md | 11 -- docs-exp/analytics.getanalytics.md | 2 +- ...ebaseapp.automaticdatacollectionenabled.md | 13 -- docs-exp/app-types.firebaseapp.md | 24 ---- docs-exp/app-types.firebaseapp.name.md | 36 ----- docs-exp/app-types.firebaseapp.options.md | 23 --- ...ppconfig.automaticdatacollectionenabled.md | 11 -- docs-exp/app-types.firebaseappconfig.md | 20 --- docs-exp/app-types.firebaseappconfig.name.md | 11 -- docs-exp/app-types.firebaseoptions.apikey.md | 11 -- docs-exp/app-types.firebaseoptions.appid.md | 11 -- .../app-types.firebaseoptions.authdomain.md | 11 -- .../app-types.firebaseoptions.databaseurl.md | 11 -- docs-exp/app-types.firebaseoptions.md | 26 ---- ...app-types.firebaseoptions.measurementid.md | 11 -- ...types.firebaseoptions.messagingsenderid.md | 11 -- .../app-types.firebaseoptions.projectid.md | 11 -- ...app-types.firebaseoptions.storagebucket.md | 11 -- docs-exp/app-types.md | 14 -- docs-exp/auth-types.actioncodeinfo.data.md | 28 ---- docs-exp/auth-types.actioncodeinfo.md | 21 --- .../auth-types.actioncodeinfo.operation.md | 13 -- docs-exp/auth-types.actioncodeoperation.md | 25 ---- .../auth-types.actioncodesettings.android.md | 22 --- ...es.actioncodesettings.dynamiclinkdomain.md | 13 -- ...ypes.actioncodesettings.handlecodeinapp.md | 18 --- docs-exp/auth-types.actioncodesettings.ios.md | 22 --- docs-exp/auth-types.actioncodesettings.md | 24 ---- docs-exp/auth-types.actioncodesettings.url.md | 18 --- docs-exp/auth-types.actioncodeurl.apikey.md | 13 -- docs-exp/auth-types.actioncodeurl.code.md | 13 -- .../auth-types.actioncodeurl.continueurl.md | 13 -- .../auth-types.actioncodeurl.languagecode.md | 13 -- docs-exp/auth-types.actioncodeurl.md | 31 ---- .../auth-types.actioncodeurl.operation.md | 13 -- .../auth-types.actioncodeurl.parselink.md | 26 ---- docs-exp/auth-types.actioncodeurl.tenantid.md | 13 -- ...auth-types.additionaluserinfo.isnewuser.md | 13 -- docs-exp/auth-types.additionaluserinfo.md | 23 --- .../auth-types.additionaluserinfo.profile.md | 13 -- ...uth-types.additionaluserinfo.providerid.md | 13 -- .../auth-types.additionaluserinfo.username.md | 13 -- docs-exp/auth-types.applicationverifier.md | 30 ---- .../auth-types.applicationverifier.type.md | 13 -- .../auth-types.applicationverifier.verify.md | 19 --- docs-exp/auth-types.auth.config.md | 13 -- docs-exp/auth-types.auth.currentuser.md | 13 -- docs-exp/auth-types.auth.languagecode.md | 18 --- docs-exp/auth-types.auth.md | 41 ------ docs-exp/auth-types.auth.name.md | 13 -- .../auth-types.auth.onauthstatechanged.md | 34 ----- docs-exp/auth-types.auth.onidtokenchanged.md | 34 ----- docs-exp/auth-types.auth.setpersistence.md | 38 ----- docs-exp/auth-types.auth.settings.md | 18 --- docs-exp/auth-types.auth.signout.md | 17 --- docs-exp/auth-types.auth.tenantid.md | 31 ---- docs-exp/auth-types.auth.updatecurrentuser.md | 32 ----- docs-exp/auth-types.auth.usedevicelanguage.md | 17 --- docs-exp/auth-types.auth.useemulator.md | 29 ---- .../auth-types.authcredential.fromjson.md | 26 ---- docs-exp/auth-types.authcredential.md | 32 ----- .../auth-types.authcredential.providerid.md | 18 --- .../auth-types.authcredential.signinmethod.md | 18 --- docs-exp/auth-types.authcredential.tojson.md | 19 --- docs-exp/auth-types.autherror.appname.md | 13 -- docs-exp/auth-types.autherror.email.md | 13 -- docs-exp/auth-types.autherror.md | 24 ---- docs-exp/auth-types.autherror.phonenumber.md | 13 -- docs-exp/auth-types.autherror.tenantid.md | 18 --- docs-exp/auth-types.autherrormap.md | 22 --- docs-exp/auth-types.authprovider.md | 20 --- .../auth-types.authprovider.providerid.md | 13 -- ...tings.appverificationdisabledfortesting.md | 17 --- docs-exp/auth-types.authsettings.md | 24 ---- docs-exp/auth-types.config.apihost.md | 13 -- docs-exp/auth-types.config.apikey.md | 13 -- docs-exp/auth-types.config.apischeme.md | 13 -- docs-exp/auth-types.config.authdomain.md | 13 -- docs-exp/auth-types.config.md | 25 ---- .../auth-types.config.sdkclientversion.md | 13 -- docs-exp/auth-types.config.tokenapihost.md | 13 -- .../auth-types.confirmationresult.confirm.md | 34 ----- docs-exp/auth-types.confirmationresult.md | 26 ---- ...types.confirmationresult.verificationid.md | 18 --- ...auth-types.emailauthprovider.credential.md | 44 ------ ...es.emailauthprovider.credentialwithlink.md | 51 ------- ...lauthprovider.email_link_sign_in_method.md | 13 -- ...hprovider.email_password_sign_in_method.md | 13 -- docs-exp/auth-types.emailauthprovider.md | 31 ---- ...uth-types.emailauthprovider.provider_id.md | 13 -- ...auth-types.emailauthprovider.providerid.md | 13 -- docs-exp/auth-types.factorid.md | 20 --- docs-exp/auth-types.idtokenresult.authtime.md | 18 --- docs-exp/auth-types.idtokenresult.claims.md | 13 -- ...auth-types.idtokenresult.expirationtime.md | 13 -- .../auth-types.idtokenresult.issuedattime.md | 13 -- docs-exp/auth-types.idtokenresult.md | 32 ----- ...auth-types.idtokenresult.signinprovider.md | 18 --- ...-types.idtokenresult.signinsecondfactor.md | 13 -- docs-exp/auth-types.idtokenresult.token.md | 13 -- docs-exp/auth-types.md | 77 ---------- ...uth-types.multifactorassertion.factorid.md | 13 -- docs-exp/auth-types.multifactorassertion.md | 24 ---- docs-exp/auth-types.multifactorerror.md | 51 ------- ...th-types.multifactorerror.operationtype.md | 13 -- .../auth-types.multifactorinfo.displayname.md | 13 -- ...th-types.multifactorinfo.enrollmenttime.md | 13 -- .../auth-types.multifactorinfo.factorid.md | 13 -- docs-exp/auth-types.multifactorinfo.md | 23 --- docs-exp/auth-types.multifactorinfo.uid.md | 13 -- .../auth-types.multifactorresolver.hints.md | 13 -- docs-exp/auth-types.multifactorresolver.md | 70 --------- ...types.multifactorresolver.resolvesignin.md | 36 ----- .../auth-types.multifactorresolver.session.md | 13 -- docs-exp/auth-types.multifactorsession.md | 13 -- docs-exp/auth-types.multifactoruser.enroll.md | 55 ------- ...h-types.multifactoruser.enrolledfactors.md | 13 -- .../auth-types.multifactoruser.getsession.md | 41 ------ docs-exp/auth-types.multifactoruser.md | 28 ---- .../auth-types.multifactoruser.unenroll.md | 40 ------ docs-exp/auth-types.nextorobserver.md | 13 -- .../auth-types.oauthcredential.accesstoken.md | 13 -- .../auth-types.oauthcredential.fromjson.md | 26 ---- .../auth-types.oauthcredential.idtoken.md | 13 -- docs-exp/auth-types.oauthcredential.md | 33 ----- docs-exp/auth-types.oauthcredential.secret.md | 13 -- docs-exp/auth-types.operationtype.md | 22 --- docs-exp/auth-types.parsedtoken.auth_time.md | 13 -- docs-exp/auth-types.parsedtoken.exp.md | 13 -- docs-exp/auth-types.parsedtoken.firebase.md | 16 --- docs-exp/auth-types.parsedtoken.iat.md | 13 -- docs-exp/auth-types.parsedtoken.md | 24 ---- docs-exp/auth-types.parsedtoken.sub.md | 13 -- docs-exp/auth-types.persistence.md | 20 --- docs-exp/auth-types.persistence.type.md | 13 -- ...auth-types.phoneauthcredential.fromjson.md | 26 ---- docs-exp/auth-types.phoneauthcredential.md | 22 --- .../auth-types.phoneauthcredential.tojson.md | 19 --- ...h-types.phoneauthprovider._constructor_.md | 24 ---- ...auth-types.phoneauthprovider.credential.md | 53 ------- docs-exp/auth-types.phoneauthprovider.md | 50 ------- ....phoneauthprovider.phone_sign_in_method.md | 13 -- ...uth-types.phoneauthprovider.provider_id.md | 13 -- ...auth-types.phoneauthprovider.providerid.md | 13 -- ...pes.phoneauthprovider.verifyphonenumber.md | 53 ------- docs-exp/auth-types.phoneinfooptions.md | 22 --- .../auth-types.phonemultifactorassertion.md | 15 -- ...types.phonemultifactorenrollinfooptions.md | 21 --- ...ultifactorenrollinfooptions.phonenumber.md | 13 -- ...onemultifactorenrollinfooptions.session.md | 13 -- ...pes.phonemultifactorgenerator.assertion.md | 28 ---- ...pes.phonemultifactorgenerator.factor_id.md | 13 -- .../auth-types.phonemultifactorgenerator.md | 26 ---- ...types.phonemultifactorsignininfooptions.md | 22 --- ...factorsignininfooptions.multifactorhint.md | 15 -- ...ifactorsignininfooptions.multifactoruid.md | 15 -- ...onemultifactorsignininfooptions.session.md | 13 -- ...auth-types.phonesinglefactorinfooptions.md | 20 --- ...honesinglefactorinfooptions.phonenumber.md | 13 -- docs-exp/auth-types.popupredirectresolver.md | 13 -- docs-exp/auth-types.providerid.md | 28 ---- ...h-types.reactnativeasyncstorage.getitem.md | 24 ---- .../auth-types.reactnativeasyncstorage.md | 22 --- ...ypes.reactnativeasyncstorage.removeitem.md | 24 ---- ...h-types.reactnativeasyncstorage.setitem.md | 25 ---- ...h-types.recaptchaverifier._constructor_.md | 26 ---- .../auth-types.recaptchaverifier.clear.md | 17 --- docs-exp/auth-types.recaptchaverifier.md | 35 ----- .../auth-types.recaptchaverifier.render.md | 19 --- docs-exp/auth-types.recaptchaverifier.type.md | 18 --- .../auth-types.recaptchaverifier.verify.md | 19 --- docs-exp/auth-types.signinmethod.md | 27 ---- docs-exp/auth-types.user.delete.md | 21 --- docs-exp/auth-types.user.emailverified.md | 13 -- docs-exp/auth-types.user.getidtoken.md | 28 ---- docs-exp/auth-types.user.getidtokenresult.md | 28 ---- docs-exp/auth-types.user.isanonymous.md | 13 -- docs-exp/auth-types.user.md | 36 ----- docs-exp/auth-types.user.metadata.md | 13 -- docs-exp/auth-types.user.providerdata.md | 13 -- docs-exp/auth-types.user.refreshtoken.md | 13 -- docs-exp/auth-types.user.reload.md | 17 --- docs-exp/auth-types.user.tenantid.md | 31 ---- docs-exp/auth-types.user.tojson.md | 19 --- docs-exp/auth-types.usercredential.md | 26 ---- ...auth-types.usercredential.operationtype.md | 13 -- .../auth-types.usercredential.providerid.md | 13 -- docs-exp/auth-types.usercredential.user.md | 13 -- docs-exp/auth-types.userinfo.displayname.md | 13 -- docs-exp/auth-types.userinfo.email.md | 13 -- docs-exp/auth-types.userinfo.md | 25 ---- docs-exp/auth-types.userinfo.phonenumber.md | 18 --- docs-exp/auth-types.userinfo.photourl.md | 13 -- docs-exp/auth-types.userinfo.providerid.md | 13 -- docs-exp/auth-types.userinfo.uid.md | 13 -- .../auth-types.usermetadata.creationtime.md | 13 -- .../auth-types.usermetadata.lastsignintime.md | 13 -- docs-exp/auth-types.usermetadata.md | 21 --- docs-exp/auth-types.userprofile.md | 13 -- docs-exp/auth.getauth.md | 2 +- docs-exp/auth.phoneauthcredential.fromjson.md | 5 +- docs-exp/auth.phoneauthcredential.md | 2 +- docs-exp/auth.sendsigninlinktoemail.md | 2 +- docs-exp/firestore_.arrayunion.md | 2 +- docs-exp/firestore_.deletefield.md | 2 +- docs-exp/firestore_.documentdata.md | 2 +- docs-exp/firestore_.documentreference.md | 2 +- ...estore_.documentreference.withconverter.md | 2 +- docs-exp/firestore_.firestoredataconverter.md | 2 +- ...e_.firestoredataconverter.tofirestore_1.md | 2 +- docs-exp/firestore_.getfirestore.md | 6 +- docs-exp/firestore_.increment.md | 2 +- docs-exp/firestore_.initializefirestore.md | 2 +- docs-exp/firestore_.loadbundle.md | 4 +- docs-exp/firestore_.md | 22 +-- docs-exp/firestore_.queryconstraint.md | 2 +- docs-exp/firestore_.servertimestamp.md | 2 +- docs-exp/firestore_.setoptions.md | 2 +- docs-exp/firestore_.snapshotlistenoptions.md | 2 +- docs-exp/firestore_.updatedata.md | 2 +- docs-exp/firestore_lite.arrayunion.md | 2 +- docs-exp/firestore_lite.deletefield.md | 2 +- docs-exp/firestore_lite.documentdata.md | 2 +- docs-exp/firestore_lite.documentreference.md | 2 +- ...re_lite.documentreference.withconverter.md | 2 +- .../firestore_lite.firebasefirestore.app.md | 2 +- docs-exp/firestore_lite.firebasefirestore.md | 2 +- .../firestore_lite.firestoredataconverter.md | 4 +- ...lite.firestoredataconverter.tofirestore.md | 2 +- ...te.firestoredataconverter.tofirestore_1.md | 2 +- docs-exp/firestore_lite.getfirestore.md | 6 +- docs-exp/firestore_lite.increment.md | 2 +- .../firestore_lite.initializefirestore.md | 2 +- docs-exp/firestore_lite.md | 20 +-- docs-exp/firestore_lite.queryconstraint.md | 2 +- docs-exp/firestore_lite.servertimestamp.md | 2 +- docs-exp/firestore_lite.setoptions.md | 2 +- docs-exp/firestore_lite.updatedata.md | 2 +- docs-exp/functions-compat.md | 6 - docs-exp/functions-types.functions.app.md | 13 -- .../functions-types.functions.customdomain.md | 13 -- docs-exp/functions-types.functions.md | 22 --- docs-exp/functions-types.functions.region.md | 13 -- .../functions-types.functionserror.code.md | 13 -- .../functions-types.functionserror.details.md | 13 -- docs-exp/functions-types.functionserror.md | 20 --- .../functions-types.functionserrorcode.md | 32 ----- docs-exp/functions-types.httpscallable.md | 13 -- .../functions-types.httpscallableoptions.md | 20 --- ...ions-types.httpscallableoptions.timeout.md | 11 -- ...unctions-types.httpscallableresult.data.md | 11 -- .../functions-types.httpscallableresult.md | 20 --- docs-exp/functions-types.md | 22 --- docs-exp/functions.getfunctions.md | 2 +- docs-exp/index.md | 9 -- ...stallations-types.firebaseinstallations.md | 13 -- docs-exp/installations-types.md | 12 -- docs-exp/installations.getinstallations.md | 2 +- docs-exp/messaging.getmessaging.md | 2 +- ...rebaseperformance.datacollectionenabled.md | 13 -- ...ebaseperformance.instrumentationenabled.md | 13 -- .../performance-types.firebaseperformance.md | 20 --- docs-exp/performance-types.md | 14 -- ...rformancesettings.datacollectionenabled.md | 13 -- ...formancesettings.instrumentationenabled.md | 13 -- .../performance-types.performancesettings.md | 20 --- ...nce-types.performancetrace.getattribute.md | 24 ---- ...ce-types.performancetrace.getattributes.md | 17 --- ...rmance-types.performancetrace.getmetric.md | 24 ---- ...-types.performancetrace.incrementmetric.md | 25 ---- .../performance-types.performancetrace.md | 28 ---- ...nce-types.performancetrace.putattribute.md | 25 ---- ...rmance-types.performancetrace.putmetric.md | 25 ---- ...rformance-types.performancetrace.record.md | 33 ----- ...-types.performancetrace.removeattribute.md | 24 ---- ...erformance-types.performancetrace.start.md | 17 --- ...performance-types.performancetrace.stop.md | 17 --- docs-exp/performance.getperformance.md | 2 +- docs-exp/remote-config-types.fetchstatus.md | 15 -- docs-exp/remote-config-types.loglevel.md | 13 -- docs-exp/remote-config-types.md | 22 --- ...config-types.remoteconfig.defaultconfig.md | 13 -- ...nfig-types.remoteconfig.fetchtimemillis.md | 13 -- ...nfig-types.remoteconfig.lastfetchstatus.md | 13 -- docs-exp/remote-config-types.remoteconfig.md | 23 --- ...mote-config-types.remoteconfig.settings.md | 13 -- ...onfig-types.settings.fetchtimeoutmillis.md | 13 -- docs-exp/remote-config-types.settings.md | 21 --- ...pes.settings.minimumfetchintervalmillis.md | 13 -- .../remote-config-types.value.asboolean.md | 19 --- .../remote-config-types.value.asnumber.md | 17 --- .../remote-config-types.value.asstring.md | 17 --- .../remote-config-types.value.getsource.md | 17 --- docs-exp/remote-config-types.value.md | 23 --- docs-exp/remote-config-types.valuesource.md | 15 -- docs-exp/remote-config.getremoteconfig.md | 2 +- docs-exp/remote-config.getvalue.md | 2 +- docs-exp/remote-config.md | 2 +- .../storage-types.firebasestorageerror.md | 21 --- ...pes.firebasestorageerror.serverresponse.md | 13 -- docs-exp/storage-types.fullmetadata.bucket.md | 13 -- ...orage-types.fullmetadata.downloadtokens.md | 13 -- .../storage-types.fullmetadata.fullpath.md | 13 -- .../storage-types.fullmetadata.generation.md | 13 -- docs-exp/storage-types.fullmetadata.md | 30 ---- ...orage-types.fullmetadata.metageneration.md | 13 -- docs-exp/storage-types.fullmetadata.name.md | 13 -- docs-exp/storage-types.fullmetadata.ref.md | 13 -- docs-exp/storage-types.fullmetadata.size.md | 13 -- .../storage-types.fullmetadata.timecreated.md | 13 -- .../storage-types.fullmetadata.updated.md | 13 -- .../storage-types.listoptions.maxresults.md | 13 -- docs-exp/storage-types.listoptions.md | 21 --- .../storage-types.listoptions.pagetoken.md | 13 -- docs-exp/storage-types.listresult.items.md | 13 -- docs-exp/storage-types.listresult.md | 22 --- .../storage-types.listresult.nextpagetoken.md | 13 -- docs-exp/storage-types.listresult.prefixes.md | 15 -- docs-exp/storage-types.md | 30 ---- ...age-types.settablemetadata.cachecontrol.md | 13 -- ...pes.settablemetadata.contentdisposition.md | 13 -- ...-types.settablemetadata.contentencoding.md | 13 -- ...-types.settablemetadata.contentlanguage.md | 13 -- ...rage-types.settablemetadata.contenttype.md | 13 -- ...e-types.settablemetadata.custommetadata.md | 17 --- docs-exp/storage-types.settablemetadata.md | 25 ---- .../storage-types.storageobserver.complete.md | 11 -- .../storage-types.storageobserver.error.md | 11 -- docs-exp/storage-types.storageobserver.md | 22 --- .../storage-types.storageobserver.next.md | 11 -- .../storage-types.storagereference.bucket.md | 13 -- ...storage-types.storagereference.fullpath.md | 13 -- docs-exp/storage-types.storagereference.md | 31 ---- .../storage-types.storagereference.name.md | 13 -- .../storage-types.storagereference.parent.md | 13 -- .../storage-types.storagereference.root.md | 13 -- .../storage-types.storagereference.storage.md | 13 -- ...storage-types.storagereference.tostring.md | 19 --- docs-exp/storage-types.storageservice.app.md | 13 -- ...es.storageservice.maxoperationretrytime.md | 13 -- ...types.storageservice.maxuploadretrytime.md | 13 -- docs-exp/storage-types.storageservice.md | 22 --- docs-exp/storage-types.taskevent.md | 13 -- docs-exp/storage-types.taskstate.md | 13 -- docs-exp/storage-types.uploadmetadata.md | 21 --- .../storage-types.uploadmetadata.md5hash.md | 13 -- docs-exp/storage-types.uploadresult.md | 21 --- .../storage-types.uploadresult.metadata.md | 13 -- docs-exp/storage-types.uploadresult.ref.md | 13 -- docs-exp/storage-types.uploadtask.cancel.md | 19 --- docs-exp/storage-types.uploadtask.catch.md | 24 ---- docs-exp/storage-types.uploadtask.md | 31 ---- docs-exp/storage-types.uploadtask.on.md | 134 ------------------ docs-exp/storage-types.uploadtask.pause.md | 19 --- docs-exp/storage-types.uploadtask.resume.md | 19 --- docs-exp/storage-types.uploadtask.snapshot.md | 13 -- docs-exp/storage-types.uploadtask.then.md | 28 ---- ...pes.uploadtasksnapshot.bytestransferred.md | 13 -- docs-exp/storage-types.uploadtasksnapshot.md | 25 ---- ...orage-types.uploadtasksnapshot.metadata.md | 13 -- .../storage-types.uploadtasksnapshot.ref.md | 13 -- .../storage-types.uploadtasksnapshot.state.md | 13 -- .../storage-types.uploadtasksnapshot.task.md | 13 -- ...age-types.uploadtasksnapshot.totalbytes.md | 13 -- docs-exp/storage.getstorage.md | 2 +- .../auth-exp/src/core/providers/saml.ts | 2 +- packages-exp/remote-config-exp/src/api.ts | 2 +- packages/firestore/src/exp/database.ts | 8 +- packages/firestore/src/exp/reference_impl.ts | 4 +- packages/firestore/src/exp/snapshot.ts | 4 +- packages/firestore/src/lite/database.ts | 8 +- .../firestore/src/lite/field_value_impl.ts | 16 +-- packages/firestore/src/lite/query.ts | 4 +- packages/firestore/src/lite/reference.ts | 10 +- packages/firestore/src/lite/snapshot.ts | 8 +- packages/firestore/src/lite/write_batch.ts | 2 +- 477 files changed, 116 insertions(+), 7555 deletions(-) delete mode 100644 docs-exp/analytics-types.analytics.app.md delete mode 100644 docs-exp/analytics-types.analytics.md delete mode 100644 docs-exp/analytics-types.analyticscalloptions.global.md delete mode 100644 docs-exp/analytics-types.analyticscalloptions.md delete mode 100644 docs-exp/analytics-types.controlparams.event_callback.md delete mode 100644 docs-exp/analytics-types.controlparams.event_timeout.md delete mode 100644 docs-exp/analytics-types.controlparams.groups.md delete mode 100644 docs-exp/analytics-types.controlparams.md delete mode 100644 docs-exp/analytics-types.controlparams.send_to.md delete mode 100644 docs-exp/analytics-types.currency.md delete mode 100644 docs-exp/analytics-types.customparams.md delete mode 100644 docs-exp/analytics-types.datalayer.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.apikey.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.appid.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.authdomain.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.databaseurl.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.locationid.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.measurementid.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.messagingsenderid.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.projectid.md delete mode 100644 docs-exp/analytics-types.dynamicconfig.storagebucket.md delete mode 100644 docs-exp/analytics-types.eventnamestring.md delete mode 100644 docs-exp/analytics-types.eventparams.affiliation.md delete mode 100644 docs-exp/analytics-types.eventparams.checkout_option.md delete mode 100644 docs-exp/analytics-types.eventparams.checkout_step.md delete mode 100644 docs-exp/analytics-types.eventparams.content_id.md delete mode 100644 docs-exp/analytics-types.eventparams.content_type.md delete mode 100644 docs-exp/analytics-types.eventparams.coupon.md delete mode 100644 docs-exp/analytics-types.eventparams.currency.md delete mode 100644 docs-exp/analytics-types.eventparams.description.md delete mode 100644 docs-exp/analytics-types.eventparams.event_category.md delete mode 100644 docs-exp/analytics-types.eventparams.event_label.md delete mode 100644 docs-exp/analytics-types.eventparams.fatal.md delete mode 100644 docs-exp/analytics-types.eventparams.item_list_id.md delete mode 100644 docs-exp/analytics-types.eventparams.item_list_name.md delete mode 100644 docs-exp/analytics-types.eventparams.items.md delete mode 100644 docs-exp/analytics-types.eventparams.md delete mode 100644 docs-exp/analytics-types.eventparams.method.md delete mode 100644 docs-exp/analytics-types.eventparams.number.md delete mode 100644 docs-exp/analytics-types.eventparams.page_location.md delete mode 100644 docs-exp/analytics-types.eventparams.page_path.md delete mode 100644 docs-exp/analytics-types.eventparams.page_title.md delete mode 100644 docs-exp/analytics-types.eventparams.payment_type.md delete mode 100644 docs-exp/analytics-types.eventparams.promotion_id.md delete mode 100644 docs-exp/analytics-types.eventparams.promotion_name.md delete mode 100644 docs-exp/analytics-types.eventparams.promotions.md delete mode 100644 docs-exp/analytics-types.eventparams.screen_name.md delete mode 100644 docs-exp/analytics-types.eventparams.search_term.md delete mode 100644 docs-exp/analytics-types.eventparams.shipping.md delete mode 100644 docs-exp/analytics-types.eventparams.shipping_tier.md delete mode 100644 docs-exp/analytics-types.eventparams.tax.md delete mode 100644 docs-exp/analytics-types.eventparams.transaction_id.md delete mode 100644 docs-exp/analytics-types.eventparams.value.md delete mode 100644 docs-exp/analytics-types.gtag.md delete mode 100644 docs-exp/analytics-types.item.affiliation.md delete mode 100644 docs-exp/analytics-types.item.brand.md delete mode 100644 docs-exp/analytics-types.item.category.md delete mode 100644 docs-exp/analytics-types.item.coupon.md delete mode 100644 docs-exp/analytics-types.item.creative_name.md delete mode 100644 docs-exp/analytics-types.item.creative_slot.md delete mode 100644 docs-exp/analytics-types.item.discount.md delete mode 100644 docs-exp/analytics-types.item.id.md delete mode 100644 docs-exp/analytics-types.item.index.md delete mode 100644 docs-exp/analytics-types.item.item_brand.md delete mode 100644 docs-exp/analytics-types.item.item_category.md delete mode 100644 docs-exp/analytics-types.item.item_category2.md delete mode 100644 docs-exp/analytics-types.item.item_category3.md delete mode 100644 docs-exp/analytics-types.item.item_category4.md delete mode 100644 docs-exp/analytics-types.item.item_category5.md delete mode 100644 docs-exp/analytics-types.item.item_id.md delete mode 100644 docs-exp/analytics-types.item.item_list_id.md delete mode 100644 docs-exp/analytics-types.item.item_list_name.md delete mode 100644 docs-exp/analytics-types.item.item_name.md delete mode 100644 docs-exp/analytics-types.item.item_variant.md delete mode 100644 docs-exp/analytics-types.item.location_id.md delete mode 100644 docs-exp/analytics-types.item.md delete mode 100644 docs-exp/analytics-types.item.name.md delete mode 100644 docs-exp/analytics-types.item.price.md delete mode 100644 docs-exp/analytics-types.item.promotion_id.md delete mode 100644 docs-exp/analytics-types.item.promotion_name.md delete mode 100644 docs-exp/analytics-types.item.quantity.md delete mode 100644 docs-exp/analytics-types.md delete mode 100644 docs-exp/analytics-types.minimaldynamicconfig.appid.md delete mode 100644 docs-exp/analytics-types.minimaldynamicconfig.md delete mode 100644 docs-exp/analytics-types.minimaldynamicconfig.measurementid.md delete mode 100644 docs-exp/analytics-types.promotion.creative_name.md delete mode 100644 docs-exp/analytics-types.promotion.creative_slot.md delete mode 100644 docs-exp/analytics-types.promotion.id.md delete mode 100644 docs-exp/analytics-types.promotion.md delete mode 100644 docs-exp/analytics-types.promotion.name.md delete mode 100644 docs-exp/analytics-types.settingsoptions.datalayername.md delete mode 100644 docs-exp/analytics-types.settingsoptions.gtagname.md delete mode 100644 docs-exp/analytics-types.settingsoptions.md delete mode 100644 docs-exp/analytics-types.throttlemetadata.backoffcount.md delete mode 100644 docs-exp/analytics-types.throttlemetadata.md delete mode 100644 docs-exp/analytics-types.throttlemetadata.throttleendtimemillis.md delete mode 100644 docs-exp/app-types.firebaseapp.automaticdatacollectionenabled.md delete mode 100644 docs-exp/app-types.firebaseapp.md delete mode 100644 docs-exp/app-types.firebaseapp.name.md delete mode 100644 docs-exp/app-types.firebaseapp.options.md delete mode 100644 docs-exp/app-types.firebaseappconfig.automaticdatacollectionenabled.md delete mode 100644 docs-exp/app-types.firebaseappconfig.md delete mode 100644 docs-exp/app-types.firebaseappconfig.name.md delete mode 100644 docs-exp/app-types.firebaseoptions.apikey.md delete mode 100644 docs-exp/app-types.firebaseoptions.appid.md delete mode 100644 docs-exp/app-types.firebaseoptions.authdomain.md delete mode 100644 docs-exp/app-types.firebaseoptions.databaseurl.md delete mode 100644 docs-exp/app-types.firebaseoptions.md delete mode 100644 docs-exp/app-types.firebaseoptions.measurementid.md delete mode 100644 docs-exp/app-types.firebaseoptions.messagingsenderid.md delete mode 100644 docs-exp/app-types.firebaseoptions.projectid.md delete mode 100644 docs-exp/app-types.firebaseoptions.storagebucket.md delete mode 100644 docs-exp/app-types.md delete mode 100644 docs-exp/auth-types.actioncodeinfo.data.md delete mode 100644 docs-exp/auth-types.actioncodeinfo.md delete mode 100644 docs-exp/auth-types.actioncodeinfo.operation.md delete mode 100644 docs-exp/auth-types.actioncodeoperation.md delete mode 100644 docs-exp/auth-types.actioncodesettings.android.md delete mode 100644 docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md delete mode 100644 docs-exp/auth-types.actioncodesettings.handlecodeinapp.md delete mode 100644 docs-exp/auth-types.actioncodesettings.ios.md delete mode 100644 docs-exp/auth-types.actioncodesettings.md delete mode 100644 docs-exp/auth-types.actioncodesettings.url.md delete mode 100644 docs-exp/auth-types.actioncodeurl.apikey.md delete mode 100644 docs-exp/auth-types.actioncodeurl.code.md delete mode 100644 docs-exp/auth-types.actioncodeurl.continueurl.md delete mode 100644 docs-exp/auth-types.actioncodeurl.languagecode.md delete mode 100644 docs-exp/auth-types.actioncodeurl.md delete mode 100644 docs-exp/auth-types.actioncodeurl.operation.md delete mode 100644 docs-exp/auth-types.actioncodeurl.parselink.md delete mode 100644 docs-exp/auth-types.actioncodeurl.tenantid.md delete mode 100644 docs-exp/auth-types.additionaluserinfo.isnewuser.md delete mode 100644 docs-exp/auth-types.additionaluserinfo.md delete mode 100644 docs-exp/auth-types.additionaluserinfo.profile.md delete mode 100644 docs-exp/auth-types.additionaluserinfo.providerid.md delete mode 100644 docs-exp/auth-types.additionaluserinfo.username.md delete mode 100644 docs-exp/auth-types.applicationverifier.md delete mode 100644 docs-exp/auth-types.applicationverifier.type.md delete mode 100644 docs-exp/auth-types.applicationverifier.verify.md delete mode 100644 docs-exp/auth-types.auth.config.md delete mode 100644 docs-exp/auth-types.auth.currentuser.md delete mode 100644 docs-exp/auth-types.auth.languagecode.md delete mode 100644 docs-exp/auth-types.auth.md delete mode 100644 docs-exp/auth-types.auth.name.md delete mode 100644 docs-exp/auth-types.auth.onauthstatechanged.md delete mode 100644 docs-exp/auth-types.auth.onidtokenchanged.md delete mode 100644 docs-exp/auth-types.auth.setpersistence.md delete mode 100644 docs-exp/auth-types.auth.settings.md delete mode 100644 docs-exp/auth-types.auth.signout.md delete mode 100644 docs-exp/auth-types.auth.tenantid.md delete mode 100644 docs-exp/auth-types.auth.updatecurrentuser.md delete mode 100644 docs-exp/auth-types.auth.usedevicelanguage.md delete mode 100644 docs-exp/auth-types.auth.useemulator.md delete mode 100644 docs-exp/auth-types.authcredential.fromjson.md delete mode 100644 docs-exp/auth-types.authcredential.md delete mode 100644 docs-exp/auth-types.authcredential.providerid.md delete mode 100644 docs-exp/auth-types.authcredential.signinmethod.md delete mode 100644 docs-exp/auth-types.authcredential.tojson.md delete mode 100644 docs-exp/auth-types.autherror.appname.md delete mode 100644 docs-exp/auth-types.autherror.email.md delete mode 100644 docs-exp/auth-types.autherror.md delete mode 100644 docs-exp/auth-types.autherror.phonenumber.md delete mode 100644 docs-exp/auth-types.autherror.tenantid.md delete mode 100644 docs-exp/auth-types.autherrormap.md delete mode 100644 docs-exp/auth-types.authprovider.md delete mode 100644 docs-exp/auth-types.authprovider.providerid.md delete mode 100644 docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md delete mode 100644 docs-exp/auth-types.authsettings.md delete mode 100644 docs-exp/auth-types.config.apihost.md delete mode 100644 docs-exp/auth-types.config.apikey.md delete mode 100644 docs-exp/auth-types.config.apischeme.md delete mode 100644 docs-exp/auth-types.config.authdomain.md delete mode 100644 docs-exp/auth-types.config.md delete mode 100644 docs-exp/auth-types.config.sdkclientversion.md delete mode 100644 docs-exp/auth-types.config.tokenapihost.md delete mode 100644 docs-exp/auth-types.confirmationresult.confirm.md delete mode 100644 docs-exp/auth-types.confirmationresult.md delete mode 100644 docs-exp/auth-types.confirmationresult.verificationid.md delete mode 100644 docs-exp/auth-types.emailauthprovider.credential.md delete mode 100644 docs-exp/auth-types.emailauthprovider.credentialwithlink.md delete mode 100644 docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md delete mode 100644 docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md delete mode 100644 docs-exp/auth-types.emailauthprovider.md delete mode 100644 docs-exp/auth-types.emailauthprovider.provider_id.md delete mode 100644 docs-exp/auth-types.emailauthprovider.providerid.md delete mode 100644 docs-exp/auth-types.factorid.md delete mode 100644 docs-exp/auth-types.idtokenresult.authtime.md delete mode 100644 docs-exp/auth-types.idtokenresult.claims.md delete mode 100644 docs-exp/auth-types.idtokenresult.expirationtime.md delete mode 100644 docs-exp/auth-types.idtokenresult.issuedattime.md delete mode 100644 docs-exp/auth-types.idtokenresult.md delete mode 100644 docs-exp/auth-types.idtokenresult.signinprovider.md delete mode 100644 docs-exp/auth-types.idtokenresult.signinsecondfactor.md delete mode 100644 docs-exp/auth-types.idtokenresult.token.md delete mode 100644 docs-exp/auth-types.md delete mode 100644 docs-exp/auth-types.multifactorassertion.factorid.md delete mode 100644 docs-exp/auth-types.multifactorassertion.md delete mode 100644 docs-exp/auth-types.multifactorerror.md delete mode 100644 docs-exp/auth-types.multifactorerror.operationtype.md delete mode 100644 docs-exp/auth-types.multifactorinfo.displayname.md delete mode 100644 docs-exp/auth-types.multifactorinfo.enrollmenttime.md delete mode 100644 docs-exp/auth-types.multifactorinfo.factorid.md delete mode 100644 docs-exp/auth-types.multifactorinfo.md delete mode 100644 docs-exp/auth-types.multifactorinfo.uid.md delete mode 100644 docs-exp/auth-types.multifactorresolver.hints.md delete mode 100644 docs-exp/auth-types.multifactorresolver.md delete mode 100644 docs-exp/auth-types.multifactorresolver.resolvesignin.md delete mode 100644 docs-exp/auth-types.multifactorresolver.session.md delete mode 100644 docs-exp/auth-types.multifactorsession.md delete mode 100644 docs-exp/auth-types.multifactoruser.enroll.md delete mode 100644 docs-exp/auth-types.multifactoruser.enrolledfactors.md delete mode 100644 docs-exp/auth-types.multifactoruser.getsession.md delete mode 100644 docs-exp/auth-types.multifactoruser.md delete mode 100644 docs-exp/auth-types.multifactoruser.unenroll.md delete mode 100644 docs-exp/auth-types.nextorobserver.md delete mode 100644 docs-exp/auth-types.oauthcredential.accesstoken.md delete mode 100644 docs-exp/auth-types.oauthcredential.fromjson.md delete mode 100644 docs-exp/auth-types.oauthcredential.idtoken.md delete mode 100644 docs-exp/auth-types.oauthcredential.md delete mode 100644 docs-exp/auth-types.oauthcredential.secret.md delete mode 100644 docs-exp/auth-types.operationtype.md delete mode 100644 docs-exp/auth-types.parsedtoken.auth_time.md delete mode 100644 docs-exp/auth-types.parsedtoken.exp.md delete mode 100644 docs-exp/auth-types.parsedtoken.firebase.md delete mode 100644 docs-exp/auth-types.parsedtoken.iat.md delete mode 100644 docs-exp/auth-types.parsedtoken.md delete mode 100644 docs-exp/auth-types.parsedtoken.sub.md delete mode 100644 docs-exp/auth-types.persistence.md delete mode 100644 docs-exp/auth-types.persistence.type.md delete mode 100644 docs-exp/auth-types.phoneauthcredential.fromjson.md delete mode 100644 docs-exp/auth-types.phoneauthcredential.md delete mode 100644 docs-exp/auth-types.phoneauthcredential.tojson.md delete mode 100644 docs-exp/auth-types.phoneauthprovider._constructor_.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.credential.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.provider_id.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.providerid.md delete mode 100644 docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md delete mode 100644 docs-exp/auth-types.phoneinfooptions.md delete mode 100644 docs-exp/auth-types.phonemultifactorassertion.md delete mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.md delete mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md delete mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md delete mode 100644 docs-exp/auth-types.phonemultifactorgenerator.assertion.md delete mode 100644 docs-exp/auth-types.phonemultifactorgenerator.factor_id.md delete mode 100644 docs-exp/auth-types.phonemultifactorgenerator.md delete mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.md delete mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md delete mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md delete mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.session.md delete mode 100644 docs-exp/auth-types.phonesinglefactorinfooptions.md delete mode 100644 docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md delete mode 100644 docs-exp/auth-types.popupredirectresolver.md delete mode 100644 docs-exp/auth-types.providerid.md delete mode 100644 docs-exp/auth-types.reactnativeasyncstorage.getitem.md delete mode 100644 docs-exp/auth-types.reactnativeasyncstorage.md delete mode 100644 docs-exp/auth-types.reactnativeasyncstorage.removeitem.md delete mode 100644 docs-exp/auth-types.reactnativeasyncstorage.setitem.md delete mode 100644 docs-exp/auth-types.recaptchaverifier._constructor_.md delete mode 100644 docs-exp/auth-types.recaptchaverifier.clear.md delete mode 100644 docs-exp/auth-types.recaptchaverifier.md delete mode 100644 docs-exp/auth-types.recaptchaverifier.render.md delete mode 100644 docs-exp/auth-types.recaptchaverifier.type.md delete mode 100644 docs-exp/auth-types.recaptchaverifier.verify.md delete mode 100644 docs-exp/auth-types.signinmethod.md delete mode 100644 docs-exp/auth-types.user.delete.md delete mode 100644 docs-exp/auth-types.user.emailverified.md delete mode 100644 docs-exp/auth-types.user.getidtoken.md delete mode 100644 docs-exp/auth-types.user.getidtokenresult.md delete mode 100644 docs-exp/auth-types.user.isanonymous.md delete mode 100644 docs-exp/auth-types.user.md delete mode 100644 docs-exp/auth-types.user.metadata.md delete mode 100644 docs-exp/auth-types.user.providerdata.md delete mode 100644 docs-exp/auth-types.user.refreshtoken.md delete mode 100644 docs-exp/auth-types.user.reload.md delete mode 100644 docs-exp/auth-types.user.tenantid.md delete mode 100644 docs-exp/auth-types.user.tojson.md delete mode 100644 docs-exp/auth-types.usercredential.md delete mode 100644 docs-exp/auth-types.usercredential.operationtype.md delete mode 100644 docs-exp/auth-types.usercredential.providerid.md delete mode 100644 docs-exp/auth-types.usercredential.user.md delete mode 100644 docs-exp/auth-types.userinfo.displayname.md delete mode 100644 docs-exp/auth-types.userinfo.email.md delete mode 100644 docs-exp/auth-types.userinfo.md delete mode 100644 docs-exp/auth-types.userinfo.phonenumber.md delete mode 100644 docs-exp/auth-types.userinfo.photourl.md delete mode 100644 docs-exp/auth-types.userinfo.providerid.md delete mode 100644 docs-exp/auth-types.userinfo.uid.md delete mode 100644 docs-exp/auth-types.usermetadata.creationtime.md delete mode 100644 docs-exp/auth-types.usermetadata.lastsignintime.md delete mode 100644 docs-exp/auth-types.usermetadata.md delete mode 100644 docs-exp/auth-types.userprofile.md delete mode 100644 docs-exp/functions-compat.md delete mode 100644 docs-exp/functions-types.functions.app.md delete mode 100644 docs-exp/functions-types.functions.customdomain.md delete mode 100644 docs-exp/functions-types.functions.md delete mode 100644 docs-exp/functions-types.functions.region.md delete mode 100644 docs-exp/functions-types.functionserror.code.md delete mode 100644 docs-exp/functions-types.functionserror.details.md delete mode 100644 docs-exp/functions-types.functionserror.md delete mode 100644 docs-exp/functions-types.functionserrorcode.md delete mode 100644 docs-exp/functions-types.httpscallable.md delete mode 100644 docs-exp/functions-types.httpscallableoptions.md delete mode 100644 docs-exp/functions-types.httpscallableoptions.timeout.md delete mode 100644 docs-exp/functions-types.httpscallableresult.data.md delete mode 100644 docs-exp/functions-types.httpscallableresult.md delete mode 100644 docs-exp/functions-types.md delete mode 100644 docs-exp/installations-types.firebaseinstallations.md delete mode 100644 docs-exp/installations-types.md delete mode 100644 docs-exp/performance-types.firebaseperformance.datacollectionenabled.md delete mode 100644 docs-exp/performance-types.firebaseperformance.instrumentationenabled.md delete mode 100644 docs-exp/performance-types.firebaseperformance.md delete mode 100644 docs-exp/performance-types.md delete mode 100644 docs-exp/performance-types.performancesettings.datacollectionenabled.md delete mode 100644 docs-exp/performance-types.performancesettings.instrumentationenabled.md delete mode 100644 docs-exp/performance-types.performancesettings.md delete mode 100644 docs-exp/performance-types.performancetrace.getattribute.md delete mode 100644 docs-exp/performance-types.performancetrace.getattributes.md delete mode 100644 docs-exp/performance-types.performancetrace.getmetric.md delete mode 100644 docs-exp/performance-types.performancetrace.incrementmetric.md delete mode 100644 docs-exp/performance-types.performancetrace.md delete mode 100644 docs-exp/performance-types.performancetrace.putattribute.md delete mode 100644 docs-exp/performance-types.performancetrace.putmetric.md delete mode 100644 docs-exp/performance-types.performancetrace.record.md delete mode 100644 docs-exp/performance-types.performancetrace.removeattribute.md delete mode 100644 docs-exp/performance-types.performancetrace.start.md delete mode 100644 docs-exp/performance-types.performancetrace.stop.md delete mode 100644 docs-exp/remote-config-types.fetchstatus.md delete mode 100644 docs-exp/remote-config-types.loglevel.md delete mode 100644 docs-exp/remote-config-types.md delete mode 100644 docs-exp/remote-config-types.remoteconfig.defaultconfig.md delete mode 100644 docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md delete mode 100644 docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md delete mode 100644 docs-exp/remote-config-types.remoteconfig.md delete mode 100644 docs-exp/remote-config-types.remoteconfig.settings.md delete mode 100644 docs-exp/remote-config-types.settings.fetchtimeoutmillis.md delete mode 100644 docs-exp/remote-config-types.settings.md delete mode 100644 docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md delete mode 100644 docs-exp/remote-config-types.value.asboolean.md delete mode 100644 docs-exp/remote-config-types.value.asnumber.md delete mode 100644 docs-exp/remote-config-types.value.asstring.md delete mode 100644 docs-exp/remote-config-types.value.getsource.md delete mode 100644 docs-exp/remote-config-types.value.md delete mode 100644 docs-exp/remote-config-types.valuesource.md delete mode 100644 docs-exp/storage-types.firebasestorageerror.md delete mode 100644 docs-exp/storage-types.firebasestorageerror.serverresponse.md delete mode 100644 docs-exp/storage-types.fullmetadata.bucket.md delete mode 100644 docs-exp/storage-types.fullmetadata.downloadtokens.md delete mode 100644 docs-exp/storage-types.fullmetadata.fullpath.md delete mode 100644 docs-exp/storage-types.fullmetadata.generation.md delete mode 100644 docs-exp/storage-types.fullmetadata.md delete mode 100644 docs-exp/storage-types.fullmetadata.metageneration.md delete mode 100644 docs-exp/storage-types.fullmetadata.name.md delete mode 100644 docs-exp/storage-types.fullmetadata.ref.md delete mode 100644 docs-exp/storage-types.fullmetadata.size.md delete mode 100644 docs-exp/storage-types.fullmetadata.timecreated.md delete mode 100644 docs-exp/storage-types.fullmetadata.updated.md delete mode 100644 docs-exp/storage-types.listoptions.maxresults.md delete mode 100644 docs-exp/storage-types.listoptions.md delete mode 100644 docs-exp/storage-types.listoptions.pagetoken.md delete mode 100644 docs-exp/storage-types.listresult.items.md delete mode 100644 docs-exp/storage-types.listresult.md delete mode 100644 docs-exp/storage-types.listresult.nextpagetoken.md delete mode 100644 docs-exp/storage-types.listresult.prefixes.md delete mode 100644 docs-exp/storage-types.md delete mode 100644 docs-exp/storage-types.settablemetadata.cachecontrol.md delete mode 100644 docs-exp/storage-types.settablemetadata.contentdisposition.md delete mode 100644 docs-exp/storage-types.settablemetadata.contentencoding.md delete mode 100644 docs-exp/storage-types.settablemetadata.contentlanguage.md delete mode 100644 docs-exp/storage-types.settablemetadata.contenttype.md delete mode 100644 docs-exp/storage-types.settablemetadata.custommetadata.md delete mode 100644 docs-exp/storage-types.settablemetadata.md delete mode 100644 docs-exp/storage-types.storageobserver.complete.md delete mode 100644 docs-exp/storage-types.storageobserver.error.md delete mode 100644 docs-exp/storage-types.storageobserver.md delete mode 100644 docs-exp/storage-types.storageobserver.next.md delete mode 100644 docs-exp/storage-types.storagereference.bucket.md delete mode 100644 docs-exp/storage-types.storagereference.fullpath.md delete mode 100644 docs-exp/storage-types.storagereference.md delete mode 100644 docs-exp/storage-types.storagereference.name.md delete mode 100644 docs-exp/storage-types.storagereference.parent.md delete mode 100644 docs-exp/storage-types.storagereference.root.md delete mode 100644 docs-exp/storage-types.storagereference.storage.md delete mode 100644 docs-exp/storage-types.storagereference.tostring.md delete mode 100644 docs-exp/storage-types.storageservice.app.md delete mode 100644 docs-exp/storage-types.storageservice.maxoperationretrytime.md delete mode 100644 docs-exp/storage-types.storageservice.maxuploadretrytime.md delete mode 100644 docs-exp/storage-types.storageservice.md delete mode 100644 docs-exp/storage-types.taskevent.md delete mode 100644 docs-exp/storage-types.taskstate.md delete mode 100644 docs-exp/storage-types.uploadmetadata.md delete mode 100644 docs-exp/storage-types.uploadmetadata.md5hash.md delete mode 100644 docs-exp/storage-types.uploadresult.md delete mode 100644 docs-exp/storage-types.uploadresult.metadata.md delete mode 100644 docs-exp/storage-types.uploadresult.ref.md delete mode 100644 docs-exp/storage-types.uploadtask.cancel.md delete mode 100644 docs-exp/storage-types.uploadtask.catch.md delete mode 100644 docs-exp/storage-types.uploadtask.md delete mode 100644 docs-exp/storage-types.uploadtask.on.md delete mode 100644 docs-exp/storage-types.uploadtask.pause.md delete mode 100644 docs-exp/storage-types.uploadtask.resume.md delete mode 100644 docs-exp/storage-types.uploadtask.snapshot.md delete mode 100644 docs-exp/storage-types.uploadtask.then.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.bytestransferred.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.metadata.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.ref.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.state.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.task.md delete mode 100644 docs-exp/storage-types.uploadtasksnapshot.totalbytes.md diff --git a/common/api-review/firestore-exp.api.md b/common/api-review/firestore-exp.api.md index d532c8a3f36..afcbdb33ca0 100644 --- a/common/api-review/firestore-exp.api.md +++ b/common/api-review/firestore-exp.api.md @@ -200,7 +200,7 @@ export function getDocsFromCache(query: Query): Promise>; export function getDocsFromServer(query: Query): Promise>; // @public -export function getFirestore(app: FirebaseApp): FirebaseFirestore; +export function getFirestore(app?: FirebaseApp): FirebaseFirestore; // @public export function increment(n: number): FieldValue; diff --git a/common/api-review/firestore-lite.api.md b/common/api-review/firestore-lite.api.md index c4696ab2baf..5aceb99e451 100644 --- a/common/api-review/firestore-lite.api.md +++ b/common/api-review/firestore-lite.api.md @@ -158,7 +158,7 @@ export function getDoc(reference: DocumentReference): Promise(query: Query): Promise>; // @public -export function getFirestore(app: FirebaseApp): FirebaseFirestore; +export function getFirestore(app?: FirebaseApp): FirebaseFirestore; // @public export function increment(n: number): FieldValue; diff --git a/common/api-review/installations-exp.api.md b/common/api-review/installations-exp.api.md index fd1412fe673..ad487b87a40 100644 --- a/common/api-review/installations-exp.api.md +++ b/common/api-review/installations-exp.api.md @@ -23,7 +23,7 @@ export interface _FirebaseInstallationsInternal { export function getId(installations: FirebaseInstallations): Promise; // @public -export function getInstallations(app: FirebaseApp): FirebaseInstallations; +export function getInstallations(app?: FirebaseApp): FirebaseInstallations; // @public export function getToken(installations: FirebaseInstallations, forceRefresh?: boolean): Promise; diff --git a/common/api-review/performance-exp.api.md b/common/api-review/performance-exp.api.md index f234946d8bd..a04556fe6d8 100644 --- a/common/api-review/performance-exp.api.md +++ b/common/api-review/performance-exp.api.md @@ -13,7 +13,7 @@ export interface FirebasePerformance { } // @public -export function getPerformance(app: FirebaseApp): FirebasePerformance; +export function getPerformance(app?: FirebaseApp): FirebasePerformance; // @public export function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance; diff --git a/common/api-review/remote-config-exp.api.md b/common/api-review/remote-config-exp.api.md index ba8402c6857..6ce51f8e22b 100644 --- a/common/api-review/remote-config-exp.api.md +++ b/common/api-review/remote-config-exp.api.md @@ -31,7 +31,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean; export function getNumber(remoteConfig: RemoteConfig, key: string): number; // @public (undocumented) -export function getRemoteConfig(app: FirebaseApp): RemoteConfig; +export function getRemoteConfig(app?: FirebaseApp): RemoteConfig; // @public export function getString(remoteConfig: RemoteConfig, key: string): string; diff --git a/docs-exp/analytics-types.analytics.app.md b/docs-exp/analytics-types.analytics.app.md deleted file mode 100644 index 2deef7f723c..00000000000 --- a/docs-exp/analytics-types.analytics.app.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Analytics](./analytics-types.analytics.md) > [app](./analytics-types.analytics.app.md) - -## Analytics.app property - -The FirebaseApp this Functions instance is associated with. - -Signature: - -```typescript -app: FirebaseApp; -``` diff --git a/docs-exp/analytics-types.analytics.md b/docs-exp/analytics-types.analytics.md deleted file mode 100644 index ff689e19d90..00000000000 --- a/docs-exp/analytics-types.analytics.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Analytics](./analytics-types.analytics.md) - -## Analytics interface - -Signature: - -```typescript -export interface Analytics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [app](./analytics-types.analytics.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | The FirebaseApp this Functions instance is associated with. | - diff --git a/docs-exp/analytics-types.analyticscalloptions.global.md b/docs-exp/analytics-types.analyticscalloptions.global.md deleted file mode 100644 index 18bd685db50..00000000000 --- a/docs-exp/analytics-types.analyticscalloptions.global.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md) > [global](./analytics-types.analyticscalloptions.global.md) - -## AnalyticsCallOptions.global property - -If true, this config or event call applies globally to all analytics properties on the page. - -Signature: - -```typescript -global: boolean; -``` diff --git a/docs-exp/analytics-types.analyticscalloptions.md b/docs-exp/analytics-types.analyticscalloptions.md deleted file mode 100644 index 39ad9857575..00000000000 --- a/docs-exp/analytics-types.analyticscalloptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md) - -## AnalyticsCallOptions interface - -Additional options that can be passed to Firebase Analytics method calls such as `logEvent`, `setCurrentScreen`, etc. - -Signature: - -```typescript -export interface AnalyticsCallOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [global](./analytics-types.analyticscalloptions.global.md) | boolean | If true, this config or event call applies globally to all analytics properties on the page. | - diff --git a/docs-exp/analytics-types.controlparams.event_callback.md b/docs-exp/analytics-types.controlparams.event_callback.md deleted file mode 100644 index 347c6ed56a6..00000000000 --- a/docs-exp/analytics-types.controlparams.event_callback.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ControlParams](./analytics-types.controlparams.md) > [event\_callback](./analytics-types.controlparams.event_callback.md) - -## ControlParams.event\_callback property - -Signature: - -```typescript -event_callback?: () => void; -``` diff --git a/docs-exp/analytics-types.controlparams.event_timeout.md b/docs-exp/analytics-types.controlparams.event_timeout.md deleted file mode 100644 index f07b78b7d2d..00000000000 --- a/docs-exp/analytics-types.controlparams.event_timeout.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ControlParams](./analytics-types.controlparams.md) > [event\_timeout](./analytics-types.controlparams.event_timeout.md) - -## ControlParams.event\_timeout property - -Signature: - -```typescript -event_timeout?: number; -``` diff --git a/docs-exp/analytics-types.controlparams.groups.md b/docs-exp/analytics-types.controlparams.groups.md deleted file mode 100644 index 36741315678..00000000000 --- a/docs-exp/analytics-types.controlparams.groups.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ControlParams](./analytics-types.controlparams.md) > [groups](./analytics-types.controlparams.groups.md) - -## ControlParams.groups property - -Signature: - -```typescript -groups?: string | string[]; -``` diff --git a/docs-exp/analytics-types.controlparams.md b/docs-exp/analytics-types.controlparams.md deleted file mode 100644 index f2df092e288..00000000000 --- a/docs-exp/analytics-types.controlparams.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ControlParams](./analytics-types.controlparams.md) - -## ControlParams interface - -Standard gtag.js control parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter). - -Signature: - -```typescript -export interface ControlParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event\_callback](./analytics-types.controlparams.event_callback.md) | () => void | | -| [event\_timeout](./analytics-types.controlparams.event_timeout.md) | number | | -| [groups](./analytics-types.controlparams.groups.md) | string \| string\[\] | | -| [send\_to](./analytics-types.controlparams.send_to.md) | string \| string\[\] | | - diff --git a/docs-exp/analytics-types.controlparams.send_to.md b/docs-exp/analytics-types.controlparams.send_to.md deleted file mode 100644 index 15ff930c6b0..00000000000 --- a/docs-exp/analytics-types.controlparams.send_to.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ControlParams](./analytics-types.controlparams.md) > [send\_to](./analytics-types.controlparams.send_to.md) - -## ControlParams.send\_to property - -Signature: - -```typescript -send_to?: string | string[]; -``` diff --git a/docs-exp/analytics-types.currency.md b/docs-exp/analytics-types.currency.md deleted file mode 100644 index 26cd443df4d..00000000000 --- a/docs-exp/analytics-types.currency.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Currency](./analytics-types.currency.md) - -## Currency type - -Signature: - -```typescript -export type Currency = string | number; -``` diff --git a/docs-exp/analytics-types.customparams.md b/docs-exp/analytics-types.customparams.md deleted file mode 100644 index 9077fbd6212..00000000000 --- a/docs-exp/analytics-types.customparams.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [CustomParams](./analytics-types.customparams.md) - -## CustomParams interface - -Any custom params the user may pass to gtag.js. - -Signature: - -```typescript -export interface CustomParams -``` diff --git a/docs-exp/analytics-types.datalayer.md b/docs-exp/analytics-types.datalayer.md deleted file mode 100644 index e0631c30c05..00000000000 --- a/docs-exp/analytics-types.datalayer.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DataLayer](./analytics-types.datalayer.md) - -## DataLayer type - -Signature: - -```typescript -export type DataLayer = Array; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.apikey.md b/docs-exp/analytics-types.dynamicconfig.apikey.md deleted file mode 100644 index 3be21ed8750..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.apikey.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [apiKey](./analytics-types.dynamicconfig.apikey.md) - -## DynamicConfig.apiKey property - -Signature: - -```typescript -apiKey: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.appid.md b/docs-exp/analytics-types.dynamicconfig.appid.md deleted file mode 100644 index 4177ee855b9..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.appid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [appId](./analytics-types.dynamicconfig.appid.md) - -## DynamicConfig.appId property - -Signature: - -```typescript -appId: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.authdomain.md b/docs-exp/analytics-types.dynamicconfig.authdomain.md deleted file mode 100644 index 67f2a07a6ce..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.authdomain.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [authDomain](./analytics-types.dynamicconfig.authdomain.md) - -## DynamicConfig.authDomain property - -Signature: - -```typescript -authDomain: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.databaseurl.md b/docs-exp/analytics-types.dynamicconfig.databaseurl.md deleted file mode 100644 index 29b7b92ca9e..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.databaseurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [databaseURL](./analytics-types.dynamicconfig.databaseurl.md) - -## DynamicConfig.databaseURL property - -Signature: - -```typescript -databaseURL: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.locationid.md b/docs-exp/analytics-types.dynamicconfig.locationid.md deleted file mode 100644 index a6022b1c781..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.locationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [locationId](./analytics-types.dynamicconfig.locationid.md) - -## DynamicConfig.locationId property - -Signature: - -```typescript -locationId: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.md b/docs-exp/analytics-types.dynamicconfig.md deleted file mode 100644 index 64739cf2454..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) - -## DynamicConfig interface - -Dynamic configuration fetched from server. See https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps/getConfig - -Signature: - -```typescript -interface DynamicConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey](./analytics-types.dynamicconfig.apikey.md) | string | | -| [appId](./analytics-types.dynamicconfig.appid.md) | string | | -| [authDomain](./analytics-types.dynamicconfig.authdomain.md) | string | | -| [databaseURL](./analytics-types.dynamicconfig.databaseurl.md) | string | | -| [locationId](./analytics-types.dynamicconfig.locationid.md) | string | | -| [measurementId](./analytics-types.dynamicconfig.measurementid.md) | string | | -| [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md) | string | | -| [projectId](./analytics-types.dynamicconfig.projectid.md) | string | | -| [storageBucket](./analytics-types.dynamicconfig.storagebucket.md) | string | | - diff --git a/docs-exp/analytics-types.dynamicconfig.measurementid.md b/docs-exp/analytics-types.dynamicconfig.measurementid.md deleted file mode 100644 index 88dd81e8560..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.measurementid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [measurementId](./analytics-types.dynamicconfig.measurementid.md) - -## DynamicConfig.measurementId property - -Signature: - -```typescript -measurementId: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.messagingsenderid.md b/docs-exp/analytics-types.dynamicconfig.messagingsenderid.md deleted file mode 100644 index e0321e09e0a..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.messagingsenderid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md) - -## DynamicConfig.messagingSenderId property - -Signature: - -```typescript -messagingSenderId: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.projectid.md b/docs-exp/analytics-types.dynamicconfig.projectid.md deleted file mode 100644 index f16dcc43cf9..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.projectid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [projectId](./analytics-types.dynamicconfig.projectid.md) - -## DynamicConfig.projectId property - -Signature: - -```typescript -projectId: string; -``` diff --git a/docs-exp/analytics-types.dynamicconfig.storagebucket.md b/docs-exp/analytics-types.dynamicconfig.storagebucket.md deleted file mode 100644 index 6229da6bed8..00000000000 --- a/docs-exp/analytics-types.dynamicconfig.storagebucket.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [DynamicConfig](./analytics-types.dynamicconfig.md) > [storageBucket](./analytics-types.dynamicconfig.storagebucket.md) - -## DynamicConfig.storageBucket property - -Signature: - -```typescript -storageBucket: string; -``` diff --git a/docs-exp/analytics-types.eventnamestring.md b/docs-exp/analytics-types.eventnamestring.md deleted file mode 100644 index eaa8f163f49..00000000000 --- a/docs-exp/analytics-types.eventnamestring.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventNameString](./analytics-types.eventnamestring.md) - -## EventNameString type - -Type for standard gtag.js event names. `logEvent` also accepts any custom string and interprets it as a custom event name. - -Signature: - -```typescript -export type EventNameString = - | 'add_payment_info' - | 'add_shipping_info' - | 'add_to_cart' - | 'add_to_wishlist' - | 'begin_checkout' - | 'checkout_progress' - | 'exception' - | 'generate_lead' - | 'login' - | 'page_view' - | 'purchase' - | 'refund' - | 'remove_from_cart' - | 'screen_view' - | 'search' - | 'select_content' - | 'select_item' - | 'select_promotion' - | 'set_checkout_option' - | 'share' - | 'sign_up' - | 'timing_complete' - | 'view_cart' - | 'view_item' - | 'view_item_list' - | 'view_promotion' - | 'view_search_results'; -``` diff --git a/docs-exp/analytics-types.eventparams.affiliation.md b/docs-exp/analytics-types.eventparams.affiliation.md deleted file mode 100644 index 801399ece01..00000000000 --- a/docs-exp/analytics-types.eventparams.affiliation.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [affiliation](./analytics-types.eventparams.affiliation.md) - -## EventParams.affiliation property - -Signature: - -```typescript -affiliation?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.checkout_option.md b/docs-exp/analytics-types.eventparams.checkout_option.md deleted file mode 100644 index cd87d26de21..00000000000 --- a/docs-exp/analytics-types.eventparams.checkout_option.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [checkout\_option](./analytics-types.eventparams.checkout_option.md) - -## EventParams.checkout\_option property - -Signature: - -```typescript -checkout_option?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.checkout_step.md b/docs-exp/analytics-types.eventparams.checkout_step.md deleted file mode 100644 index b499e678685..00000000000 --- a/docs-exp/analytics-types.eventparams.checkout_step.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [checkout\_step](./analytics-types.eventparams.checkout_step.md) - -## EventParams.checkout\_step property - -Signature: - -```typescript -checkout_step?: number; -``` diff --git a/docs-exp/analytics-types.eventparams.content_id.md b/docs-exp/analytics-types.eventparams.content_id.md deleted file mode 100644 index 65e795c0f97..00000000000 --- a/docs-exp/analytics-types.eventparams.content_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [content\_id](./analytics-types.eventparams.content_id.md) - -## EventParams.content\_id property - -Signature: - -```typescript -content_id?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.content_type.md b/docs-exp/analytics-types.eventparams.content_type.md deleted file mode 100644 index 201f4d037e6..00000000000 --- a/docs-exp/analytics-types.eventparams.content_type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [content\_type](./analytics-types.eventparams.content_type.md) - -## EventParams.content\_type property - -Signature: - -```typescript -content_type?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.coupon.md b/docs-exp/analytics-types.eventparams.coupon.md deleted file mode 100644 index 7c65a51c43c..00000000000 --- a/docs-exp/analytics-types.eventparams.coupon.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [coupon](./analytics-types.eventparams.coupon.md) - -## EventParams.coupon property - -Signature: - -```typescript -coupon?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.currency.md b/docs-exp/analytics-types.eventparams.currency.md deleted file mode 100644 index 49416bab826..00000000000 --- a/docs-exp/analytics-types.eventparams.currency.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [currency](./analytics-types.eventparams.currency.md) - -## EventParams.currency property - -Signature: - -```typescript -currency?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.description.md b/docs-exp/analytics-types.eventparams.description.md deleted file mode 100644 index 6ce6ef0d4a7..00000000000 --- a/docs-exp/analytics-types.eventparams.description.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [description](./analytics-types.eventparams.description.md) - -## EventParams.description property - -Signature: - -```typescript -description?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.event_category.md b/docs-exp/analytics-types.eventparams.event_category.md deleted file mode 100644 index 20f6a1bb198..00000000000 --- a/docs-exp/analytics-types.eventparams.event_category.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [event\_category](./analytics-types.eventparams.event_category.md) - -## EventParams.event\_category property - -Signature: - -```typescript -event_category?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.event_label.md b/docs-exp/analytics-types.eventparams.event_label.md deleted file mode 100644 index 69e9937b4e4..00000000000 --- a/docs-exp/analytics-types.eventparams.event_label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [event\_label](./analytics-types.eventparams.event_label.md) - -## EventParams.event\_label property - -Signature: - -```typescript -event_label?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.fatal.md b/docs-exp/analytics-types.eventparams.fatal.md deleted file mode 100644 index 7db11a08ae5..00000000000 --- a/docs-exp/analytics-types.eventparams.fatal.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [fatal](./analytics-types.eventparams.fatal.md) - -## EventParams.fatal property - -Signature: - -```typescript -fatal?: boolean; -``` diff --git a/docs-exp/analytics-types.eventparams.item_list_id.md b/docs-exp/analytics-types.eventparams.item_list_id.md deleted file mode 100644 index 849359dcb54..00000000000 --- a/docs-exp/analytics-types.eventparams.item_list_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [item\_list\_id](./analytics-types.eventparams.item_list_id.md) - -## EventParams.item\_list\_id property - -Signature: - -```typescript -item_list_id?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.item_list_name.md b/docs-exp/analytics-types.eventparams.item_list_name.md deleted file mode 100644 index 87769a9b53d..00000000000 --- a/docs-exp/analytics-types.eventparams.item_list_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [item\_list\_name](./analytics-types.eventparams.item_list_name.md) - -## EventParams.item\_list\_name property - -Signature: - -```typescript -item_list_name?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.items.md b/docs-exp/analytics-types.eventparams.items.md deleted file mode 100644 index 0a658e22ffc..00000000000 --- a/docs-exp/analytics-types.eventparams.items.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [items](./analytics-types.eventparams.items.md) - -## EventParams.items property - -Signature: - -```typescript -items?: Item[]; -``` diff --git a/docs-exp/analytics-types.eventparams.md b/docs-exp/analytics-types.eventparams.md deleted file mode 100644 index fe0087e57a5..00000000000 --- a/docs-exp/analytics-types.eventparams.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) - -## EventParams interface - -Standard gtag.js event parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter). - -Signature: - -```typescript -export interface EventParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [affiliation](./analytics-types.eventparams.affiliation.md) | string | | -| [checkout\_option](./analytics-types.eventparams.checkout_option.md) | string | | -| [checkout\_step](./analytics-types.eventparams.checkout_step.md) | number | | -| [content\_id](./analytics-types.eventparams.content_id.md) | string | | -| [content\_type](./analytics-types.eventparams.content_type.md) | string | | -| [coupon](./analytics-types.eventparams.coupon.md) | string | | -| [currency](./analytics-types.eventparams.currency.md) | string | | -| [description](./analytics-types.eventparams.description.md) | string | | -| [event\_category](./analytics-types.eventparams.event_category.md) | string | | -| [event\_label](./analytics-types.eventparams.event_label.md) | string | | -| [fatal](./analytics-types.eventparams.fatal.md) | boolean | | -| [item\_list\_id](./analytics-types.eventparams.item_list_id.md) | string | | -| [item\_list\_name](./analytics-types.eventparams.item_list_name.md) | string | | -| [items](./analytics-types.eventparams.items.md) | [Item](./analytics-types.item.md)\[\] | | -| [method](./analytics-types.eventparams.method.md) | string | | -| [number](./analytics-types.eventparams.number.md) | string | | -| [page\_location](./analytics-types.eventparams.page_location.md) | string | | -| [page\_path](./analytics-types.eventparams.page_path.md) | string | | -| [page\_title](./analytics-types.eventparams.page_title.md) | string | | -| [payment\_type](./analytics-types.eventparams.payment_type.md) | string | | -| [promotion\_id](./analytics-types.eventparams.promotion_id.md) | string | | -| [promotion\_name](./analytics-types.eventparams.promotion_name.md) | string | | -| [promotions](./analytics-types.eventparams.promotions.md) | [Promotion](./analytics-types.promotion.md)\[\] | | -| [screen\_name](./analytics-types.eventparams.screen_name.md) | string | | -| [search\_term](./analytics-types.eventparams.search_term.md) | string | | -| [shipping\_tier](./analytics-types.eventparams.shipping_tier.md) | string | | -| [shipping](./analytics-types.eventparams.shipping.md) | [Currency](./analytics-types.currency.md) | | -| [tax](./analytics-types.eventparams.tax.md) | [Currency](./analytics-types.currency.md) | | -| [transaction\_id](./analytics-types.eventparams.transaction_id.md) | string | | -| [value](./analytics-types.eventparams.value.md) | number | | - diff --git a/docs-exp/analytics-types.eventparams.method.md b/docs-exp/analytics-types.eventparams.method.md deleted file mode 100644 index e5375576254..00000000000 --- a/docs-exp/analytics-types.eventparams.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [method](./analytics-types.eventparams.method.md) - -## EventParams.method property - -Signature: - -```typescript -method?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.number.md b/docs-exp/analytics-types.eventparams.number.md deleted file mode 100644 index a4f11f79c75..00000000000 --- a/docs-exp/analytics-types.eventparams.number.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [number](./analytics-types.eventparams.number.md) - -## EventParams.number property - -Signature: - -```typescript -number?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.page_location.md b/docs-exp/analytics-types.eventparams.page_location.md deleted file mode 100644 index f986d4cba09..00000000000 --- a/docs-exp/analytics-types.eventparams.page_location.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [page\_location](./analytics-types.eventparams.page_location.md) - -## EventParams.page\_location property - -Signature: - -```typescript -page_location?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.page_path.md b/docs-exp/analytics-types.eventparams.page_path.md deleted file mode 100644 index a4a9be6e937..00000000000 --- a/docs-exp/analytics-types.eventparams.page_path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [page\_path](./analytics-types.eventparams.page_path.md) - -## EventParams.page\_path property - -Signature: - -```typescript -page_path?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.page_title.md b/docs-exp/analytics-types.eventparams.page_title.md deleted file mode 100644 index 49322692558..00000000000 --- a/docs-exp/analytics-types.eventparams.page_title.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [page\_title](./analytics-types.eventparams.page_title.md) - -## EventParams.page\_title property - -Signature: - -```typescript -page_title?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.payment_type.md b/docs-exp/analytics-types.eventparams.payment_type.md deleted file mode 100644 index 9ef0ad83328..00000000000 --- a/docs-exp/analytics-types.eventparams.payment_type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [payment\_type](./analytics-types.eventparams.payment_type.md) - -## EventParams.payment\_type property - -Signature: - -```typescript -payment_type?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.promotion_id.md b/docs-exp/analytics-types.eventparams.promotion_id.md deleted file mode 100644 index 6e742456567..00000000000 --- a/docs-exp/analytics-types.eventparams.promotion_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [promotion\_id](./analytics-types.eventparams.promotion_id.md) - -## EventParams.promotion\_id property - -Signature: - -```typescript -promotion_id?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.promotion_name.md b/docs-exp/analytics-types.eventparams.promotion_name.md deleted file mode 100644 index 90ba96533a2..00000000000 --- a/docs-exp/analytics-types.eventparams.promotion_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [promotion\_name](./analytics-types.eventparams.promotion_name.md) - -## EventParams.promotion\_name property - -Signature: - -```typescript -promotion_name?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.promotions.md b/docs-exp/analytics-types.eventparams.promotions.md deleted file mode 100644 index 75284fa56da..00000000000 --- a/docs-exp/analytics-types.eventparams.promotions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [promotions](./analytics-types.eventparams.promotions.md) - -## EventParams.promotions property - -Signature: - -```typescript -promotions?: Promotion[]; -``` diff --git a/docs-exp/analytics-types.eventparams.screen_name.md b/docs-exp/analytics-types.eventparams.screen_name.md deleted file mode 100644 index 28e5e3ff974..00000000000 --- a/docs-exp/analytics-types.eventparams.screen_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [screen\_name](./analytics-types.eventparams.screen_name.md) - -## EventParams.screen\_name property - -Signature: - -```typescript -screen_name?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.search_term.md b/docs-exp/analytics-types.eventparams.search_term.md deleted file mode 100644 index 6dc55904e12..00000000000 --- a/docs-exp/analytics-types.eventparams.search_term.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [search\_term](./analytics-types.eventparams.search_term.md) - -## EventParams.search\_term property - -Signature: - -```typescript -search_term?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.shipping.md b/docs-exp/analytics-types.eventparams.shipping.md deleted file mode 100644 index 5c3e6d51c7b..00000000000 --- a/docs-exp/analytics-types.eventparams.shipping.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [shipping](./analytics-types.eventparams.shipping.md) - -## EventParams.shipping property - -Signature: - -```typescript -shipping?: Currency; -``` diff --git a/docs-exp/analytics-types.eventparams.shipping_tier.md b/docs-exp/analytics-types.eventparams.shipping_tier.md deleted file mode 100644 index fbb852f7e65..00000000000 --- a/docs-exp/analytics-types.eventparams.shipping_tier.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [shipping\_tier](./analytics-types.eventparams.shipping_tier.md) - -## EventParams.shipping\_tier property - -Signature: - -```typescript -shipping_tier?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.tax.md b/docs-exp/analytics-types.eventparams.tax.md deleted file mode 100644 index 55f8766deff..00000000000 --- a/docs-exp/analytics-types.eventparams.tax.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [tax](./analytics-types.eventparams.tax.md) - -## EventParams.tax property - -Signature: - -```typescript -tax?: Currency; -``` diff --git a/docs-exp/analytics-types.eventparams.transaction_id.md b/docs-exp/analytics-types.eventparams.transaction_id.md deleted file mode 100644 index 9436bec1bdb..00000000000 --- a/docs-exp/analytics-types.eventparams.transaction_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [transaction\_id](./analytics-types.eventparams.transaction_id.md) - -## EventParams.transaction\_id property - -Signature: - -```typescript -transaction_id?: string; -``` diff --git a/docs-exp/analytics-types.eventparams.value.md b/docs-exp/analytics-types.eventparams.value.md deleted file mode 100644 index a110366c620..00000000000 --- a/docs-exp/analytics-types.eventparams.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [EventParams](./analytics-types.eventparams.md) > [value](./analytics-types.eventparams.value.md) - -## EventParams.value property - -Signature: - -```typescript -value?: number; -``` diff --git a/docs-exp/analytics-types.gtag.md b/docs-exp/analytics-types.gtag.md deleted file mode 100644 index 5be3c022e46..00000000000 --- a/docs-exp/analytics-types.gtag.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Gtag](./analytics-types.gtag.md) - -## Gtag interface - -Standard `gtag` function provided by gtag.js. - -Signature: - -```typescript -export interface Gtag -``` diff --git a/docs-exp/analytics-types.item.affiliation.md b/docs-exp/analytics-types.item.affiliation.md deleted file mode 100644 index 8fe41edaed3..00000000000 --- a/docs-exp/analytics-types.item.affiliation.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [affiliation](./analytics-types.item.affiliation.md) - -## Item.affiliation property - -Signature: - -```typescript -affiliation?: string; -``` diff --git a/docs-exp/analytics-types.item.brand.md b/docs-exp/analytics-types.item.brand.md deleted file mode 100644 index fda6657f4d1..00000000000 --- a/docs-exp/analytics-types.item.brand.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [brand](./analytics-types.item.brand.md) - -## Item.brand property - -> Warning: This API is now obsolete. -> -> Use item\_brand instead. -> - -Signature: - -```typescript -brand?: string; -``` diff --git a/docs-exp/analytics-types.item.category.md b/docs-exp/analytics-types.item.category.md deleted file mode 100644 index 2a77f4a3867..00000000000 --- a/docs-exp/analytics-types.item.category.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [category](./analytics-types.item.category.md) - -## Item.category property - -> Warning: This API is now obsolete. -> -> Use item\_category instead. -> - -Signature: - -```typescript -category?: string; -``` diff --git a/docs-exp/analytics-types.item.coupon.md b/docs-exp/analytics-types.item.coupon.md deleted file mode 100644 index 18cfcbb47ab..00000000000 --- a/docs-exp/analytics-types.item.coupon.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [coupon](./analytics-types.item.coupon.md) - -## Item.coupon property - -Signature: - -```typescript -coupon?: string; -``` diff --git a/docs-exp/analytics-types.item.creative_name.md b/docs-exp/analytics-types.item.creative_name.md deleted file mode 100644 index 4421515c587..00000000000 --- a/docs-exp/analytics-types.item.creative_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [creative\_name](./analytics-types.item.creative_name.md) - -## Item.creative\_name property - -Signature: - -```typescript -creative_name?: string; -``` diff --git a/docs-exp/analytics-types.item.creative_slot.md b/docs-exp/analytics-types.item.creative_slot.md deleted file mode 100644 index 367800ace3b..00000000000 --- a/docs-exp/analytics-types.item.creative_slot.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [creative\_slot](./analytics-types.item.creative_slot.md) - -## Item.creative\_slot property - -Signature: - -```typescript -creative_slot?: string; -``` diff --git a/docs-exp/analytics-types.item.discount.md b/docs-exp/analytics-types.item.discount.md deleted file mode 100644 index 405de31da4b..00000000000 --- a/docs-exp/analytics-types.item.discount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [discount](./analytics-types.item.discount.md) - -## Item.discount property - -Signature: - -```typescript -discount?: Currency; -``` diff --git a/docs-exp/analytics-types.item.id.md b/docs-exp/analytics-types.item.id.md deleted file mode 100644 index f4a7361c4ad..00000000000 --- a/docs-exp/analytics-types.item.id.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [id](./analytics-types.item.id.md) - -## Item.id property - -> Warning: This API is now obsolete. -> -> Use item\_id instead. -> - -Signature: - -```typescript -id?: string; -``` diff --git a/docs-exp/analytics-types.item.index.md b/docs-exp/analytics-types.item.index.md deleted file mode 100644 index 9ab460732eb..00000000000 --- a/docs-exp/analytics-types.item.index.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [index](./analytics-types.item.index.md) - -## Item.index property - -Signature: - -```typescript -index?: number; -``` diff --git a/docs-exp/analytics-types.item.item_brand.md b/docs-exp/analytics-types.item.item_brand.md deleted file mode 100644 index e7215f9a26d..00000000000 --- a/docs-exp/analytics-types.item.item_brand.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_brand](./analytics-types.item.item_brand.md) - -## Item.item\_brand property - -Signature: - -```typescript -item_brand?: string; -``` diff --git a/docs-exp/analytics-types.item.item_category.md b/docs-exp/analytics-types.item.item_category.md deleted file mode 100644 index 6e38be54101..00000000000 --- a/docs-exp/analytics-types.item.item_category.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_category](./analytics-types.item.item_category.md) - -## Item.item\_category property - -Signature: - -```typescript -item_category?: string; -``` diff --git a/docs-exp/analytics-types.item.item_category2.md b/docs-exp/analytics-types.item.item_category2.md deleted file mode 100644 index 4abe13881e6..00000000000 --- a/docs-exp/analytics-types.item.item_category2.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_category2](./analytics-types.item.item_category2.md) - -## Item.item\_category2 property - -Signature: - -```typescript -item_category2?: string; -``` diff --git a/docs-exp/analytics-types.item.item_category3.md b/docs-exp/analytics-types.item.item_category3.md deleted file mode 100644 index 81ecaec6ea6..00000000000 --- a/docs-exp/analytics-types.item.item_category3.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_category3](./analytics-types.item.item_category3.md) - -## Item.item\_category3 property - -Signature: - -```typescript -item_category3?: string; -``` diff --git a/docs-exp/analytics-types.item.item_category4.md b/docs-exp/analytics-types.item.item_category4.md deleted file mode 100644 index 75c182deb86..00000000000 --- a/docs-exp/analytics-types.item.item_category4.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_category4](./analytics-types.item.item_category4.md) - -## Item.item\_category4 property - -Signature: - -```typescript -item_category4?: string; -``` diff --git a/docs-exp/analytics-types.item.item_category5.md b/docs-exp/analytics-types.item.item_category5.md deleted file mode 100644 index ad91c5fdf8f..00000000000 --- a/docs-exp/analytics-types.item.item_category5.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_category5](./analytics-types.item.item_category5.md) - -## Item.item\_category5 property - -Signature: - -```typescript -item_category5?: string; -``` diff --git a/docs-exp/analytics-types.item.item_id.md b/docs-exp/analytics-types.item.item_id.md deleted file mode 100644 index e8ec9d27653..00000000000 --- a/docs-exp/analytics-types.item.item_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_id](./analytics-types.item.item_id.md) - -## Item.item\_id property - -Signature: - -```typescript -item_id?: string; -``` diff --git a/docs-exp/analytics-types.item.item_list_id.md b/docs-exp/analytics-types.item.item_list_id.md deleted file mode 100644 index 72a44277901..00000000000 --- a/docs-exp/analytics-types.item.item_list_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_list\_id](./analytics-types.item.item_list_id.md) - -## Item.item\_list\_id property - -Signature: - -```typescript -item_list_id?: string; -``` diff --git a/docs-exp/analytics-types.item.item_list_name.md b/docs-exp/analytics-types.item.item_list_name.md deleted file mode 100644 index b2e9bb2e005..00000000000 --- a/docs-exp/analytics-types.item.item_list_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_list\_name](./analytics-types.item.item_list_name.md) - -## Item.item\_list\_name property - -Signature: - -```typescript -item_list_name?: string; -``` diff --git a/docs-exp/analytics-types.item.item_name.md b/docs-exp/analytics-types.item.item_name.md deleted file mode 100644 index 7e8e944063e..00000000000 --- a/docs-exp/analytics-types.item.item_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_name](./analytics-types.item.item_name.md) - -## Item.item\_name property - -Signature: - -```typescript -item_name?: string; -``` diff --git a/docs-exp/analytics-types.item.item_variant.md b/docs-exp/analytics-types.item.item_variant.md deleted file mode 100644 index e5ee9836047..00000000000 --- a/docs-exp/analytics-types.item.item_variant.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [item\_variant](./analytics-types.item.item_variant.md) - -## Item.item\_variant property - -Signature: - -```typescript -item_variant?: string; -``` diff --git a/docs-exp/analytics-types.item.location_id.md b/docs-exp/analytics-types.item.location_id.md deleted file mode 100644 index db29cfb8414..00000000000 --- a/docs-exp/analytics-types.item.location_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [location\_id](./analytics-types.item.location_id.md) - -## Item.location\_id property - -Signature: - -```typescript -location_id?: string; -``` diff --git a/docs-exp/analytics-types.item.md b/docs-exp/analytics-types.item.md deleted file mode 100644 index a1de7f4beb9..00000000000 --- a/docs-exp/analytics-types.item.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) - -## Item interface - -Signature: - -```typescript -export interface Item -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [affiliation](./analytics-types.item.affiliation.md) | string | | -| [brand](./analytics-types.item.brand.md) | string | | -| [category](./analytics-types.item.category.md) | string | | -| [coupon](./analytics-types.item.coupon.md) | string | | -| [creative\_name](./analytics-types.item.creative_name.md) | string | | -| [creative\_slot](./analytics-types.item.creative_slot.md) | string | | -| [discount](./analytics-types.item.discount.md) | [Currency](./analytics-types.currency.md) | | -| [id](./analytics-types.item.id.md) | string | | -| [index](./analytics-types.item.index.md) | number | | -| [item\_brand](./analytics-types.item.item_brand.md) | string | | -| [item\_category](./analytics-types.item.item_category.md) | string | | -| [item\_category2](./analytics-types.item.item_category2.md) | string | | -| [item\_category3](./analytics-types.item.item_category3.md) | string | | -| [item\_category4](./analytics-types.item.item_category4.md) | string | | -| [item\_category5](./analytics-types.item.item_category5.md) | string | | -| [item\_id](./analytics-types.item.item_id.md) | string | | -| [item\_list\_id](./analytics-types.item.item_list_id.md) | string | | -| [item\_list\_name](./analytics-types.item.item_list_name.md) | string | | -| [item\_name](./analytics-types.item.item_name.md) | string | | -| [item\_variant](./analytics-types.item.item_variant.md) | string | | -| [location\_id](./analytics-types.item.location_id.md) | string | | -| [name](./analytics-types.item.name.md) | string | | -| [price](./analytics-types.item.price.md) | [Currency](./analytics-types.currency.md) | | -| [promotion\_id](./analytics-types.item.promotion_id.md) | string | | -| [promotion\_name](./analytics-types.item.promotion_name.md) | string | | -| [quantity](./analytics-types.item.quantity.md) | number | | - diff --git a/docs-exp/analytics-types.item.name.md b/docs-exp/analytics-types.item.name.md deleted file mode 100644 index 1eccf462c0a..00000000000 --- a/docs-exp/analytics-types.item.name.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [name](./analytics-types.item.name.md) - -## Item.name property - -> Warning: This API is now obsolete. -> -> Use item\_name instead. -> - -Signature: - -```typescript -name?: string; -``` diff --git a/docs-exp/analytics-types.item.price.md b/docs-exp/analytics-types.item.price.md deleted file mode 100644 index 598db9e703f..00000000000 --- a/docs-exp/analytics-types.item.price.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [price](./analytics-types.item.price.md) - -## Item.price property - -Signature: - -```typescript -price?: Currency; -``` diff --git a/docs-exp/analytics-types.item.promotion_id.md b/docs-exp/analytics-types.item.promotion_id.md deleted file mode 100644 index 7f99293e358..00000000000 --- a/docs-exp/analytics-types.item.promotion_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [promotion\_id](./analytics-types.item.promotion_id.md) - -## Item.promotion\_id property - -Signature: - -```typescript -promotion_id?: string; -``` diff --git a/docs-exp/analytics-types.item.promotion_name.md b/docs-exp/analytics-types.item.promotion_name.md deleted file mode 100644 index 129bcff7247..00000000000 --- a/docs-exp/analytics-types.item.promotion_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [promotion\_name](./analytics-types.item.promotion_name.md) - -## Item.promotion\_name property - -Signature: - -```typescript -promotion_name?: string; -``` diff --git a/docs-exp/analytics-types.item.quantity.md b/docs-exp/analytics-types.item.quantity.md deleted file mode 100644 index 30ed2a26654..00000000000 --- a/docs-exp/analytics-types.item.quantity.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Item](./analytics-types.item.md) > [quantity](./analytics-types.item.quantity.md) - -## Item.quantity property - -Signature: - -```typescript -quantity?: number; -``` diff --git a/docs-exp/analytics-types.md b/docs-exp/analytics-types.md deleted file mode 100644 index 9423cbed506..00000000000 --- a/docs-exp/analytics-types.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) - -## analytics-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [Analytics](./analytics-types.analytics.md) | | -| [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md) | Additional options that can be passed to Firebase Analytics method calls such as logEvent, setCurrentScreen, etc. | -| [ControlParams](./analytics-types.controlparams.md) | Standard gtag.js control parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter). | -| [CustomParams](./analytics-types.customparams.md) | Any custom params the user may pass to gtag.js. | -| [DynamicConfig](./analytics-types.dynamicconfig.md) | Dynamic configuration fetched from server. See https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps/getConfig | -| [EventParams](./analytics-types.eventparams.md) | Standard gtag.js event parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter). | -| [Gtag](./analytics-types.gtag.md) | Standard gtag function provided by gtag.js. | -| [Item](./analytics-types.item.md) | | -| [MinimalDynamicConfig](./analytics-types.minimaldynamicconfig.md) | | -| [Promotion](./analytics-types.promotion.md) | | -| [SettingsOptions](./analytics-types.settingsoptions.md) | Specifies custom options for your Firebase Analytics instance. You must set these before initializing firebase.analytics(). | -| [ThrottleMetadata](./analytics-types.throttlemetadata.md) | Encapsulates metadata concerning throttled fetch requests. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [Currency](./analytics-types.currency.md) | | -| [DataLayer](./analytics-types.datalayer.md) | | -| [EventNameString](./analytics-types.eventnamestring.md) | Type for standard gtag.js event names. logEvent also accepts any custom string and interprets it as a custom event name. | - diff --git a/docs-exp/analytics-types.minimaldynamicconfig.appid.md b/docs-exp/analytics-types.minimaldynamicconfig.appid.md deleted file mode 100644 index fe08515ad7d..00000000000 --- a/docs-exp/analytics-types.minimaldynamicconfig.appid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [MinimalDynamicConfig](./analytics-types.minimaldynamicconfig.md) > [appId](./analytics-types.minimaldynamicconfig.appid.md) - -## MinimalDynamicConfig.appId property - -Signature: - -```typescript -appId: string; -``` diff --git a/docs-exp/analytics-types.minimaldynamicconfig.md b/docs-exp/analytics-types.minimaldynamicconfig.md deleted file mode 100644 index 41c37e71b05..00000000000 --- a/docs-exp/analytics-types.minimaldynamicconfig.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [MinimalDynamicConfig](./analytics-types.minimaldynamicconfig.md) - -## MinimalDynamicConfig interface - -Signature: - -```typescript -interface MinimalDynamicConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appId](./analytics-types.minimaldynamicconfig.appid.md) | string | | -| [measurementId](./analytics-types.minimaldynamicconfig.measurementid.md) | string | | - diff --git a/docs-exp/analytics-types.minimaldynamicconfig.measurementid.md b/docs-exp/analytics-types.minimaldynamicconfig.measurementid.md deleted file mode 100644 index c4942f2fba3..00000000000 --- a/docs-exp/analytics-types.minimaldynamicconfig.measurementid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [MinimalDynamicConfig](./analytics-types.minimaldynamicconfig.md) > [measurementId](./analytics-types.minimaldynamicconfig.measurementid.md) - -## MinimalDynamicConfig.measurementId property - -Signature: - -```typescript -measurementId: string; -``` diff --git a/docs-exp/analytics-types.promotion.creative_name.md b/docs-exp/analytics-types.promotion.creative_name.md deleted file mode 100644 index 6bf2e8713ce..00000000000 --- a/docs-exp/analytics-types.promotion.creative_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Promotion](./analytics-types.promotion.md) > [creative\_name](./analytics-types.promotion.creative_name.md) - -## Promotion.creative\_name property - -Signature: - -```typescript -creative_name?: string; -``` diff --git a/docs-exp/analytics-types.promotion.creative_slot.md b/docs-exp/analytics-types.promotion.creative_slot.md deleted file mode 100644 index ccf723086a5..00000000000 --- a/docs-exp/analytics-types.promotion.creative_slot.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Promotion](./analytics-types.promotion.md) > [creative\_slot](./analytics-types.promotion.creative_slot.md) - -## Promotion.creative\_slot property - -Signature: - -```typescript -creative_slot?: string; -``` diff --git a/docs-exp/analytics-types.promotion.id.md b/docs-exp/analytics-types.promotion.id.md deleted file mode 100644 index 10ef7a2aba9..00000000000 --- a/docs-exp/analytics-types.promotion.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Promotion](./analytics-types.promotion.md) > [id](./analytics-types.promotion.id.md) - -## Promotion.id property - -Signature: - -```typescript -id?: string; -``` diff --git a/docs-exp/analytics-types.promotion.md b/docs-exp/analytics-types.promotion.md deleted file mode 100644 index 3cccad83023..00000000000 --- a/docs-exp/analytics-types.promotion.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Promotion](./analytics-types.promotion.md) - -## Promotion interface - -> Warning: This API is now obsolete. -> -> Use Item instead. -> - -Signature: - -```typescript -export interface Promotion -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [creative\_name](./analytics-types.promotion.creative_name.md) | string | | -| [creative\_slot](./analytics-types.promotion.creative_slot.md) | string | | -| [id](./analytics-types.promotion.id.md) | string | | -| [name](./analytics-types.promotion.name.md) | string | | - diff --git a/docs-exp/analytics-types.promotion.name.md b/docs-exp/analytics-types.promotion.name.md deleted file mode 100644 index e898e528538..00000000000 --- a/docs-exp/analytics-types.promotion.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [Promotion](./analytics-types.promotion.md) > [name](./analytics-types.promotion.name.md) - -## Promotion.name property - -Signature: - -```typescript -name?: string; -``` diff --git a/docs-exp/analytics-types.settingsoptions.datalayername.md b/docs-exp/analytics-types.settingsoptions.datalayername.md deleted file mode 100644 index 827820ad3fa..00000000000 --- a/docs-exp/analytics-types.settingsoptions.datalayername.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [SettingsOptions](./analytics-types.settingsoptions.md) > [dataLayerName](./analytics-types.settingsoptions.datalayername.md) - -## SettingsOptions.dataLayerName property - -Sets custom name for `dataLayer` array used by gtag. - -Signature: - -```typescript -dataLayerName?: string; -``` diff --git a/docs-exp/analytics-types.settingsoptions.gtagname.md b/docs-exp/analytics-types.settingsoptions.gtagname.md deleted file mode 100644 index 18e5b78bf4c..00000000000 --- a/docs-exp/analytics-types.settingsoptions.gtagname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [SettingsOptions](./analytics-types.settingsoptions.md) > [gtagName](./analytics-types.settingsoptions.gtagname.md) - -## SettingsOptions.gtagName property - -Sets custom name for `gtag` function. - -Signature: - -```typescript -gtagName?: string; -``` diff --git a/docs-exp/analytics-types.settingsoptions.md b/docs-exp/analytics-types.settingsoptions.md deleted file mode 100644 index 39076e8ecc9..00000000000 --- a/docs-exp/analytics-types.settingsoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [SettingsOptions](./analytics-types.settingsoptions.md) - -## SettingsOptions interface - -Specifies custom options for your Firebase Analytics instance. You must set these before initializing `firebase.analytics()`. - -Signature: - -```typescript -export interface SettingsOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataLayerName](./analytics-types.settingsoptions.datalayername.md) | string | Sets custom name for dataLayer array used by gtag. | -| [gtagName](./analytics-types.settingsoptions.gtagname.md) | string | Sets custom name for gtag function. | - diff --git a/docs-exp/analytics-types.throttlemetadata.backoffcount.md b/docs-exp/analytics-types.throttlemetadata.backoffcount.md deleted file mode 100644 index 9d5d926853b..00000000000 --- a/docs-exp/analytics-types.throttlemetadata.backoffcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ThrottleMetadata](./analytics-types.throttlemetadata.md) > [backoffCount](./analytics-types.throttlemetadata.backoffcount.md) - -## ThrottleMetadata.backoffCount property - -Signature: - -```typescript -backoffCount: number; -``` diff --git a/docs-exp/analytics-types.throttlemetadata.md b/docs-exp/analytics-types.throttlemetadata.md deleted file mode 100644 index c519a84d0f5..00000000000 --- a/docs-exp/analytics-types.throttlemetadata.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ThrottleMetadata](./analytics-types.throttlemetadata.md) - -## ThrottleMetadata interface - -Encapsulates metadata concerning throttled fetch requests. - -Signature: - -```typescript -export interface ThrottleMetadata -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [backoffCount](./analytics-types.throttlemetadata.backoffcount.md) | number | | -| [throttleEndTimeMillis](./analytics-types.throttlemetadata.throttleendtimemillis.md) | number | | - diff --git a/docs-exp/analytics-types.throttlemetadata.throttleendtimemillis.md b/docs-exp/analytics-types.throttlemetadata.throttleendtimemillis.md deleted file mode 100644 index f1bdc53c468..00000000000 --- a/docs-exp/analytics-types.throttlemetadata.throttleendtimemillis.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/analytics-types](./analytics-types.md) > [ThrottleMetadata](./analytics-types.throttlemetadata.md) > [throttleEndTimeMillis](./analytics-types.throttlemetadata.throttleendtimemillis.md) - -## ThrottleMetadata.throttleEndTimeMillis property - -Signature: - -```typescript -throttleEndTimeMillis: number; -``` diff --git a/docs-exp/analytics.getanalytics.md b/docs-exp/analytics.getanalytics.md index 83b1dec430e..50b047be30d 100644 --- a/docs-exp/analytics.getanalytics.md +++ b/docs-exp/analytics.getanalytics.md @@ -9,7 +9,7 @@ Returns a Firebase Analytics instance for the given app. Signature: ```typescript -export declare function getAnalytics(app: FirebaseApp): Analytics; +export declare function getAnalytics(app?: FirebaseApp): Analytics; ``` ## Parameters diff --git a/docs-exp/app-types.firebaseapp.automaticdatacollectionenabled.md b/docs-exp/app-types.firebaseapp.automaticdatacollectionenabled.md deleted file mode 100644 index 6cca94e7bbc..00000000000 --- a/docs-exp/app-types.firebaseapp.automaticdatacollectionenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseApp](./app-types.firebaseapp.md) > [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md) - -## FirebaseApp.automaticDataCollectionEnabled property - -The settable config flag for GDPR opt-in/opt-out - -Signature: - -```typescript -automaticDataCollectionEnabled: boolean; -``` diff --git a/docs-exp/app-types.firebaseapp.md b/docs-exp/app-types.firebaseapp.md deleted file mode 100644 index ad464fd9f01..00000000000 --- a/docs-exp/app-types.firebaseapp.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseApp](./app-types.firebaseapp.md) - -## FirebaseApp interface - -A FirebaseApp holds the initialization information for a collection of services. - -Do not call this constructor directly. Instead, use [initializeApp()](./app.initializeapp.md) to create an app. - -Signature: - -```typescript -export interface FirebaseApp -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md) | boolean | The settable config flag for GDPR opt-in/opt-out | -| [name](./app-types.firebaseapp.name.md) | string | The (read-only) name for this app.The default app's name is "[DEFAULT]". | -| [options](./app-types.firebaseapp.options.md) | [FirebaseOptions](./app-types.firebaseoptions.md) | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md). | - diff --git a/docs-exp/app-types.firebaseapp.name.md b/docs-exp/app-types.firebaseapp.name.md deleted file mode 100644 index d2b830453a2..00000000000 --- a/docs-exp/app-types.firebaseapp.name.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseApp](./app-types.firebaseapp.md) > [name](./app-types.firebaseapp.name.md) - -## FirebaseApp.name property - -The (read-only) name for this app. - -The default app's name is `"[DEFAULT]"`. - -Signature: - -```typescript -readonly name: string; -``` - -## Example 1 - - -```javascript -// The default app's name is "[DEFAULT]" -const app = initializeApp(defaultAppConfig); -console.log(app.name); // "[DEFAULT]" - -``` - -## Example 2 - - -```javascript -// A named app's name is what you provide to initializeApp() -const otherApp = initializeApp(otherAppConfig, "other"); -console.log(otherApp.name); // "other" - -``` - diff --git a/docs-exp/app-types.firebaseapp.options.md b/docs-exp/app-types.firebaseapp.options.md deleted file mode 100644 index 56b8b4685c0..00000000000 --- a/docs-exp/app-types.firebaseapp.options.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseApp](./app-types.firebaseapp.md) > [options](./app-types.firebaseapp.options.md) - -## FirebaseApp.options property - -The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md). - -Signature: - -```typescript -readonly options: FirebaseOptions; -``` - -## Example - - -```javascript -const app = initializeApp(config); -console.log(app.options.databaseURL === config.databaseURL); // true - -``` - diff --git a/docs-exp/app-types.firebaseappconfig.automaticdatacollectionenabled.md b/docs-exp/app-types.firebaseappconfig.automaticdatacollectionenabled.md deleted file mode 100644 index 047db9a21fc..00000000000 --- a/docs-exp/app-types.firebaseappconfig.automaticdatacollectionenabled.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseAppConfig](./app-types.firebaseappconfig.md) > [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md) - -## FirebaseAppConfig.automaticDataCollectionEnabled property - -Signature: - -```typescript -automaticDataCollectionEnabled?: boolean; -``` diff --git a/docs-exp/app-types.firebaseappconfig.md b/docs-exp/app-types.firebaseappconfig.md deleted file mode 100644 index 2335ff6b387..00000000000 --- a/docs-exp/app-types.firebaseappconfig.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseAppConfig](./app-types.firebaseappconfig.md) - -## FirebaseAppConfig interface - - -Signature: - -```typescript -export interface FirebaseAppConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md) | boolean | | -| [name](./app-types.firebaseappconfig.name.md) | string | | - diff --git a/docs-exp/app-types.firebaseappconfig.name.md b/docs-exp/app-types.firebaseappconfig.name.md deleted file mode 100644 index be405e49548..00000000000 --- a/docs-exp/app-types.firebaseappconfig.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseAppConfig](./app-types.firebaseappconfig.md) > [name](./app-types.firebaseappconfig.name.md) - -## FirebaseAppConfig.name property - -Signature: - -```typescript -name?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.apikey.md b/docs-exp/app-types.firebaseoptions.apikey.md deleted file mode 100644 index e82438689f4..00000000000 --- a/docs-exp/app-types.firebaseoptions.apikey.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [apiKey](./app-types.firebaseoptions.apikey.md) - -## FirebaseOptions.apiKey property - -Signature: - -```typescript -apiKey?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.appid.md b/docs-exp/app-types.firebaseoptions.appid.md deleted file mode 100644 index 2903b82adc8..00000000000 --- a/docs-exp/app-types.firebaseoptions.appid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [appId](./app-types.firebaseoptions.appid.md) - -## FirebaseOptions.appId property - -Signature: - -```typescript -appId?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.authdomain.md b/docs-exp/app-types.firebaseoptions.authdomain.md deleted file mode 100644 index 99dc66c8755..00000000000 --- a/docs-exp/app-types.firebaseoptions.authdomain.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [authDomain](./app-types.firebaseoptions.authdomain.md) - -## FirebaseOptions.authDomain property - -Signature: - -```typescript -authDomain?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.databaseurl.md b/docs-exp/app-types.firebaseoptions.databaseurl.md deleted file mode 100644 index 025827f4d75..00000000000 --- a/docs-exp/app-types.firebaseoptions.databaseurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [databaseURL](./app-types.firebaseoptions.databaseurl.md) - -## FirebaseOptions.databaseURL property - -Signature: - -```typescript -databaseURL?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.md b/docs-exp/app-types.firebaseoptions.md deleted file mode 100644 index 8d14523f967..00000000000 --- a/docs-exp/app-types.firebaseoptions.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) - -## FirebaseOptions interface - - -Signature: - -```typescript -export interface FirebaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey](./app-types.firebaseoptions.apikey.md) | string | | -| [appId](./app-types.firebaseoptions.appid.md) | string | | -| [authDomain](./app-types.firebaseoptions.authdomain.md) | string | | -| [databaseURL](./app-types.firebaseoptions.databaseurl.md) | string | | -| [measurementId](./app-types.firebaseoptions.measurementid.md) | string | | -| [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md) | string | | -| [projectId](./app-types.firebaseoptions.projectid.md) | string | | -| [storageBucket](./app-types.firebaseoptions.storagebucket.md) | string | | - diff --git a/docs-exp/app-types.firebaseoptions.measurementid.md b/docs-exp/app-types.firebaseoptions.measurementid.md deleted file mode 100644 index 84ffb13d480..00000000000 --- a/docs-exp/app-types.firebaseoptions.measurementid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [measurementId](./app-types.firebaseoptions.measurementid.md) - -## FirebaseOptions.measurementId property - -Signature: - -```typescript -measurementId?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.messagingsenderid.md b/docs-exp/app-types.firebaseoptions.messagingsenderid.md deleted file mode 100644 index c70c539e8b1..00000000000 --- a/docs-exp/app-types.firebaseoptions.messagingsenderid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md) - -## FirebaseOptions.messagingSenderId property - -Signature: - -```typescript -messagingSenderId?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.projectid.md b/docs-exp/app-types.firebaseoptions.projectid.md deleted file mode 100644 index fb4449ea500..00000000000 --- a/docs-exp/app-types.firebaseoptions.projectid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [projectId](./app-types.firebaseoptions.projectid.md) - -## FirebaseOptions.projectId property - -Signature: - -```typescript -projectId?: string; -``` diff --git a/docs-exp/app-types.firebaseoptions.storagebucket.md b/docs-exp/app-types.firebaseoptions.storagebucket.md deleted file mode 100644 index 771767cf357..00000000000 --- a/docs-exp/app-types.firebaseoptions.storagebucket.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) > [FirebaseOptions](./app-types.firebaseoptions.md) > [storageBucket](./app-types.firebaseoptions.storagebucket.md) - -## FirebaseOptions.storageBucket property - -Signature: - -```typescript -storageBucket?: string; -``` diff --git a/docs-exp/app-types.md b/docs-exp/app-types.md deleted file mode 100644 index 43ed67b3467..00000000000 --- a/docs-exp/app-types.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@firebase/app-types](./app-types.md) - -## app-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [FirebaseApp](./app-types.firebaseapp.md) | A FirebaseApp holds the initialization information for a collection of services.Do not call this constructor directly. Instead, use [initializeApp()](./app.initializeapp.md) to create an app. | -| [FirebaseAppConfig](./app-types.firebaseappconfig.md) | | -| [FirebaseOptions](./app-types.firebaseoptions.md) | | - diff --git a/docs-exp/auth-types.actioncodeinfo.data.md b/docs-exp/auth-types.actioncodeinfo.data.md deleted file mode 100644 index 514aff61440..00000000000 --- a/docs-exp/auth-types.actioncodeinfo.data.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) > [data](./auth-types.actioncodeinfo.data.md) - -## ActionCodeInfo.data property - -The data associated with the action code. - -Signature: - -```typescript -data: { - email?: string | null; - multiFactorInfo?: MultiFactorInfo | null; - previousEmail?: string | null; - }; -``` - -## Remarks - -For the , , and actions, this object contains an email field with the address the email was sent to. - -For the action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field. - -For the action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field. - -For the action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. - diff --git a/docs-exp/auth-types.actioncodeinfo.md b/docs-exp/auth-types.actioncodeinfo.md deleted file mode 100644 index 1a987bc3059..00000000000 --- a/docs-exp/auth-types.actioncodeinfo.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) - -## ActionCodeInfo interface - -A response from [checkActionCode()](./auth.checkactioncode.md). - -Signature: - -```typescript -export interface ActionCodeInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. | -| [operation](./auth-types.actioncodeinfo.operation.md) | [ActionCodeOperation](./auth-types.actioncodeoperation.md) | The type of operation that generated the action code. | - diff --git a/docs-exp/auth-types.actioncodeinfo.operation.md b/docs-exp/auth-types.actioncodeinfo.operation.md deleted file mode 100644 index 9c138571107..00000000000 --- a/docs-exp/auth-types.actioncodeinfo.operation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) > [operation](./auth-types.actioncodeinfo.operation.md) - -## ActionCodeInfo.operation property - -The type of operation that generated the action code. - -Signature: - -```typescript -operation: ActionCodeOperation; -``` diff --git a/docs-exp/auth-types.actioncodeoperation.md b/docs-exp/auth-types.actioncodeoperation.md deleted file mode 100644 index 2d38c159f08..00000000000 --- a/docs-exp/auth-types.actioncodeoperation.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeOperation](./auth-types.actioncodeoperation.md) - -## ActionCodeOperation enum - -An enumeration of the possible email action types. - -Signature: - -```typescript -export const enum ActionCodeOperation -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EMAIL\_SIGNIN | 'EMAIL_SIGNIN' | The email link sign-in action. | -| PASSWORD\_RESET | 'PASSWORD_RESET' | The password reset action. | -| RECOVER\_EMAIL | 'RECOVER_EMAIL' | The email revocation action. | -| REVERT\_SECOND\_FACTOR\_ADDITION | 'REVERT_SECOND_FACTOR_ADDITION' | The revert second factor addition email action. | -| VERIFY\_AND\_CHANGE\_EMAIL | 'VERIFY_AND_CHANGE_EMAIL' | The revert second factor addition email action. | -| VERIFY\_EMAIL | 'VERIFY_EMAIL' | The email verification action. | - diff --git a/docs-exp/auth-types.actioncodesettings.android.md b/docs-exp/auth-types.actioncodesettings.android.md deleted file mode 100644 index 8333a391afa..00000000000 --- a/docs-exp/auth-types.actioncodesettings.android.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [android](./auth-types.actioncodesettings.android.md) - -## ActionCodeSettings.android property - -Sets the Android package name. - -Signature: - -```typescript -android?: { - installApp?: boolean; - minimumVersion?: string; - packageName: string; - }; -``` - -## Remarks - -This will try to open the link in an android app if it is installed. If `installApp` is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a `packageName`, an error is thrown explaining that the `packageName` must be provided in conjunction with this field. If `minimumVersion` is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. - diff --git a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md deleted file mode 100644 index bd8f3b53da1..00000000000 --- a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) - -## ActionCodeSettings.dynamicLinkDomain property - -When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). - -Signature: - -```typescript -dynamicLinkDomain?: string; -``` diff --git a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md deleted file mode 100644 index 436140614d0..00000000000 --- a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) - -## ActionCodeSettings.handleCodeInApp property - -When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. - -Signature: - -```typescript -handleCodeInApp?: boolean; -``` - -## Remarks - -In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. - diff --git a/docs-exp/auth-types.actioncodesettings.ios.md b/docs-exp/auth-types.actioncodesettings.ios.md deleted file mode 100644 index 3bd06cdedd9..00000000000 --- a/docs-exp/auth-types.actioncodesettings.ios.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [iOS](./auth-types.actioncodesettings.ios.md) - -## ActionCodeSettings.iOS property - -Sets the iOS bundle ID. - -Signature: - -```typescript -iOS?: { - bundleId: string; - }; -``` - -## Remarks - -This will try to open the link in an iOS app if it is installed. - -App installation is not supported for iOS. - diff --git a/docs-exp/auth-types.actioncodesettings.md b/docs-exp/auth-types.actioncodesettings.md deleted file mode 100644 index 4df4d05eec8..00000000000 --- a/docs-exp/auth-types.actioncodesettings.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) - -## ActionCodeSettings interface - -An interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. - -Signature: - -```typescript -export interface ActionCodeSettings -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. | -| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link). | -| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. | -| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. | -| [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL. | - diff --git a/docs-exp/auth-types.actioncodesettings.url.md b/docs-exp/auth-types.actioncodesettings.url.md deleted file mode 100644 index 3a0f2a88967..00000000000 --- a/docs-exp/auth-types.actioncodesettings.url.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [url](./auth-types.actioncodesettings.url.md) - -## ActionCodeSettings.url property - -Sets the link continue/state URL. - -Signature: - -```typescript -url: string; -``` - -## Remarks - -This has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link. - diff --git a/docs-exp/auth-types.actioncodeurl.apikey.md b/docs-exp/auth-types.actioncodeurl.apikey.md deleted file mode 100644 index 6984aa7faef..00000000000 --- a/docs-exp/auth-types.actioncodeurl.apikey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [apiKey](./auth-types.actioncodeurl.apikey.md) - -## ActionCodeURL.apiKey property - -The API key of the email action link. - -Signature: - -```typescript -readonly apiKey: string; -``` diff --git a/docs-exp/auth-types.actioncodeurl.code.md b/docs-exp/auth-types.actioncodeurl.code.md deleted file mode 100644 index df7dcf0d7e7..00000000000 --- a/docs-exp/auth-types.actioncodeurl.code.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [code](./auth-types.actioncodeurl.code.md) - -## ActionCodeURL.code property - -The action code of the email action link. - -Signature: - -```typescript -readonly code: string; -``` diff --git a/docs-exp/auth-types.actioncodeurl.continueurl.md b/docs-exp/auth-types.actioncodeurl.continueurl.md deleted file mode 100644 index d25785dbad3..00000000000 --- a/docs-exp/auth-types.actioncodeurl.continueurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [continueUrl](./auth-types.actioncodeurl.continueurl.md) - -## ActionCodeURL.continueUrl property - -The continue URL of the email action link. Null if not provided. - -Signature: - -```typescript -readonly continueUrl: string | null; -``` diff --git a/docs-exp/auth-types.actioncodeurl.languagecode.md b/docs-exp/auth-types.actioncodeurl.languagecode.md deleted file mode 100644 index 6ad17299693..00000000000 --- a/docs-exp/auth-types.actioncodeurl.languagecode.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [languageCode](./auth-types.actioncodeurl.languagecode.md) - -## ActionCodeURL.languageCode property - -The language code of the email action link. Null if not provided. - -Signature: - -```typescript -readonly languageCode: string | null; -``` diff --git a/docs-exp/auth-types.actioncodeurl.md b/docs-exp/auth-types.actioncodeurl.md deleted file mode 100644 index 0d793897c95..00000000000 --- a/docs-exp/auth-types.actioncodeurl.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) - -## ActionCodeURL class - -A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. - -Signature: - -```typescript -export abstract class ActionCodeURL -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | The API key of the email action link. | -| [code](./auth-types.actioncodeurl.code.md) | | string | The action code of the email action link. | -| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. | -| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. | -| [operation](./auth-types.actioncodeurl.operation.md) | | [ActionCodeOperation](./auth-types.actioncodeoperation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) | -| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static | Parses the email action link string and returns an [ActionCodeURL](./auth-types.actioncodeurl.md) if the link is valid, otherwise returns null. | - diff --git a/docs-exp/auth-types.actioncodeurl.operation.md b/docs-exp/auth-types.actioncodeurl.operation.md deleted file mode 100644 index 9b2723bb478..00000000000 --- a/docs-exp/auth-types.actioncodeurl.operation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [operation](./auth-types.actioncodeurl.operation.md) - -## ActionCodeURL.operation property - -The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) - -Signature: - -```typescript -readonly operation: ActionCodeOperation; -``` diff --git a/docs-exp/auth-types.actioncodeurl.parselink.md b/docs-exp/auth-types.actioncodeurl.parselink.md deleted file mode 100644 index d6045fb551a..00000000000 --- a/docs-exp/auth-types.actioncodeurl.parselink.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [parseLink](./auth-types.actioncodeurl.parselink.md) - -## ActionCodeURL.parseLink() method - -Parses the email action link string and returns an [ActionCodeURL](./auth-types.actioncodeurl.md) if the link is valid, otherwise returns null. - -Signature: - -```typescript -static parseLink(link: string): ActionCodeURL | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| link | string | The email action link string. | - -Returns: - -[ActionCodeURL](./auth-types.actioncodeurl.md) \| null - -The ActionCodeURL object, or null if the link is invalid. - diff --git a/docs-exp/auth-types.actioncodeurl.tenantid.md b/docs-exp/auth-types.actioncodeurl.tenantid.md deleted file mode 100644 index 06002ff16a4..00000000000 --- a/docs-exp/auth-types.actioncodeurl.tenantid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [tenantId](./auth-types.actioncodeurl.tenantid.md) - -## ActionCodeURL.tenantId property - -The tenant ID of the email action link. Null if the email action is from the parent project. - -Signature: - -```typescript -readonly tenantId: string | null; -``` diff --git a/docs-exp/auth-types.additionaluserinfo.isnewuser.md b/docs-exp/auth-types.additionaluserinfo.isnewuser.md deleted file mode 100644 index a29dfe61440..00000000000 --- a/docs-exp/auth-types.additionaluserinfo.isnewuser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) - -## AdditionalUserInfo.isNewUser property - -Whether the user is new (created via sign-up) or existing (authenticated using sign-in). - -Signature: - -```typescript -readonly isNewUser: boolean; -``` diff --git a/docs-exp/auth-types.additionaluserinfo.md b/docs-exp/auth-types.additionaluserinfo.md deleted file mode 100644 index b4a32e3fbad..00000000000 --- a/docs-exp/auth-types.additionaluserinfo.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) - -## AdditionalUserInfo interface - -A structure containing additional user information from a federated identity provider. - -Signature: - -```typescript -export interface AdditionalUserInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). | -| [profile](./auth-types.additionaluserinfo.profile.md) | Record<string, unknown> \| null | Map containing IDP-specific user data. | -| [providerId](./auth-types.additionaluserinfo.providerid.md) | string \| null | Identifier for the provider used to authenticate this user. | -| [username](./auth-types.additionaluserinfo.username.md) | string \| null | The username if the provider is GitHub or Twitter. | - diff --git a/docs-exp/auth-types.additionaluserinfo.profile.md b/docs-exp/auth-types.additionaluserinfo.profile.md deleted file mode 100644 index 5a20320173b..00000000000 --- a/docs-exp/auth-types.additionaluserinfo.profile.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [profile](./auth-types.additionaluserinfo.profile.md) - -## AdditionalUserInfo.profile property - -Map containing IDP-specific user data. - -Signature: - -```typescript -readonly profile: Record | null; -``` diff --git a/docs-exp/auth-types.additionaluserinfo.providerid.md b/docs-exp/auth-types.additionaluserinfo.providerid.md deleted file mode 100644 index 362350d8359..00000000000 --- a/docs-exp/auth-types.additionaluserinfo.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [providerId](./auth-types.additionaluserinfo.providerid.md) - -## AdditionalUserInfo.providerId property - -Identifier for the provider used to authenticate this user. - -Signature: - -```typescript -readonly providerId: string | null; -``` diff --git a/docs-exp/auth-types.additionaluserinfo.username.md b/docs-exp/auth-types.additionaluserinfo.username.md deleted file mode 100644 index 5f28757a6f9..00000000000 --- a/docs-exp/auth-types.additionaluserinfo.username.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [username](./auth-types.additionaluserinfo.username.md) - -## AdditionalUserInfo.username property - -The username if the provider is GitHub or Twitter. - -Signature: - -```typescript -readonly username?: string | null; -``` diff --git a/docs-exp/auth-types.applicationverifier.md b/docs-exp/auth-types.applicationverifier.md deleted file mode 100644 index c2230069796..00000000000 --- a/docs-exp/auth-types.applicationverifier.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) - -## ApplicationVerifier interface - -A verifier for domain verification and abuse prevention. - -Signature: - -```typescript -export interface ApplicationVerifier -``` - -## Remarks - -Currently, the only implementation is [RecaptchaVerifier](./auth.recaptchaverifier.md). - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./auth-types.applicationverifier.type.md) | string | Identifies the type of application verifier (e.g. "recaptcha"). | - -## Methods - -| Method | Description | -| --- | --- | -| [verify()](./auth-types.applicationverifier.verify.md) | Executes the verification process. | - diff --git a/docs-exp/auth-types.applicationverifier.type.md b/docs-exp/auth-types.applicationverifier.type.md deleted file mode 100644 index 04902982e5c..00000000000 --- a/docs-exp/auth-types.applicationverifier.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) > [type](./auth-types.applicationverifier.type.md) - -## ApplicationVerifier.type property - -Identifies the type of application verifier (e.g. "recaptcha"). - -Signature: - -```typescript -readonly type: string; -``` diff --git a/docs-exp/auth-types.applicationverifier.verify.md b/docs-exp/auth-types.applicationverifier.verify.md deleted file mode 100644 index 223a4856077..00000000000 --- a/docs-exp/auth-types.applicationverifier.verify.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) > [verify](./auth-types.applicationverifier.verify.md) - -## ApplicationVerifier.verify() method - -Executes the verification process. - -Signature: - -```typescript -verify(): Promise; -``` -Returns: - -Promise<string> - -A Promise for a token that can be used to assert the validity of a request. - diff --git a/docs-exp/auth-types.auth.config.md b/docs-exp/auth-types.auth.config.md deleted file mode 100644 index 6f7c340c83d..00000000000 --- a/docs-exp/auth-types.auth.config.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [config](./auth-types.auth.config.md) - -## Auth.config property - -The [Config](./auth-types.config.md) used to initialize this instance. - -Signature: - -```typescript -readonly config: Config; -``` diff --git a/docs-exp/auth-types.auth.currentuser.md b/docs-exp/auth-types.auth.currentuser.md deleted file mode 100644 index fb9dcea93ff..00000000000 --- a/docs-exp/auth-types.auth.currentuser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [currentUser](./auth-types.auth.currentuser.md) - -## Auth.currentUser property - -The currently signed-in user (or null). - -Signature: - -```typescript -readonly currentUser: User | null; -``` diff --git a/docs-exp/auth-types.auth.languagecode.md b/docs-exp/auth-types.auth.languagecode.md deleted file mode 100644 index 7923dce8990..00000000000 --- a/docs-exp/auth-types.auth.languagecode.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [languageCode](./auth-types.auth.languagecode.md) - -## Auth.languageCode property - -The Auth instance's language code. - -Signature: - -```typescript -languageCode: string | null; -``` - -## Remarks - -This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. - diff --git a/docs-exp/auth-types.auth.md b/docs-exp/auth-types.auth.md deleted file mode 100644 index ee9cff22c3d..00000000000 --- a/docs-exp/auth-types.auth.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) - -## Auth interface - -Interface representing Firebase Auth service. - -Signature: - -```typescript -export interface Auth -``` - -## Remarks - -See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | The [Config](./auth-types.config.md) used to initialize this instance. | -| [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | The currently signed-in user (or null). | -| [languageCode](./auth-types.auth.languagecode.md) | string \| null | The Auth instance's language code. | -| [name](./auth-types.auth.name.md) | string | The name of the app associated with the Auth service instance. | -| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The Auth instance's settings. | -| [tenantId](./auth-types.auth.tenantid.md) | string \| null | The Auth instance's tenant ID. | - -## Methods - -| Method | Description | -| --- | --- | -| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state. | -| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token. | -| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance. | -| [signOut()](./auth-types.auth.signout.md) | Signs out the current user. | -| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. | -| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. | -| [useEmulator(url, options)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. | - diff --git a/docs-exp/auth-types.auth.name.md b/docs-exp/auth-types.auth.name.md deleted file mode 100644 index 695a7a051be..00000000000 --- a/docs-exp/auth-types.auth.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [name](./auth-types.auth.name.md) - -## Auth.name property - -The name of the app associated with the Auth service instance. - -Signature: - -```typescript -readonly name: string; -``` diff --git a/docs-exp/auth-types.auth.onauthstatechanged.md b/docs-exp/auth-types.auth.onauthstatechanged.md deleted file mode 100644 index 35121adfc30..00000000000 --- a/docs-exp/auth-types.auth.onauthstatechanged.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [onAuthStateChanged](./auth-types.auth.onauthstatechanged.md) - -## Auth.onAuthStateChanged() method - -Adds an observer for changes to the user's sign-in state. - -Signature: - -```typescript -onAuthStateChanged( - nextOrObserver: NextOrObserver, - error?: ErrorFn, - completed?: CompleteFn - ): Unsubscribe; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md) \| null> | callback triggered on change. | -| error | ErrorFn | callback triggered on error. | -| completed | CompleteFn | callback triggered when observer is removed. | - -Returns: - -Unsubscribe - -## Remarks - -To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). - diff --git a/docs-exp/auth-types.auth.onidtokenchanged.md b/docs-exp/auth-types.auth.onidtokenchanged.md deleted file mode 100644 index 796a4768a6f..00000000000 --- a/docs-exp/auth-types.auth.onidtokenchanged.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [onIdTokenChanged](./auth-types.auth.onidtokenchanged.md) - -## Auth.onIdTokenChanged() method - -Adds an observer for changes to the signed-in user's ID token. - -Signature: - -```typescript -onIdTokenChanged( - nextOrObserver: NextOrObserver, - error?: ErrorFn, - completed?: CompleteFn - ): Unsubscribe; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md) \| null> | callback triggered on change. | -| error | ErrorFn | callback triggered on error. | -| completed | CompleteFn | callback triggered when observer is removed. | - -Returns: - -Unsubscribe - -## Remarks - -This includes sign-in, sign-out, and token refresh events. - diff --git a/docs-exp/auth-types.auth.setpersistence.md b/docs-exp/auth-types.auth.setpersistence.md deleted file mode 100644 index b39ab8c06c6..00000000000 --- a/docs-exp/auth-types.auth.setpersistence.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [setPersistence](./auth-types.auth.setpersistence.md) - -## Auth.setPersistence() method - -Changes the type of persistence on the Auth instance. - -Signature: - -```typescript -setPersistence(persistence: Persistence): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| persistence | [Persistence](./auth-types.persistence.md) | The [Persistence](./auth-types.persistence.md) to use. | - -Returns: - -Promise<void> - -## Remarks - -This will affect the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. - -This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. - -## Example - - -```javascript -auth.setPersistence(browserSessionPersistence); - -``` - diff --git a/docs-exp/auth-types.auth.settings.md b/docs-exp/auth-types.auth.settings.md deleted file mode 100644 index d415766a68d..00000000000 --- a/docs-exp/auth-types.auth.settings.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [settings](./auth-types.auth.settings.md) - -## Auth.settings property - -The Auth instance's settings. - -Signature: - -```typescript -readonly settings: AuthSettings; -``` - -## Remarks - -This is used to edit/read configuration related options such as app verification mode for phone authentication. - diff --git a/docs-exp/auth-types.auth.signout.md b/docs-exp/auth-types.auth.signout.md deleted file mode 100644 index 57bc6589146..00000000000 --- a/docs-exp/auth-types.auth.signout.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [signOut](./auth-types.auth.signout.md) - -## Auth.signOut() method - -Signs out the current user. - -Signature: - -```typescript -signOut(): Promise; -``` -Returns: - -Promise<void> - diff --git a/docs-exp/auth-types.auth.tenantid.md b/docs-exp/auth-types.auth.tenantid.md deleted file mode 100644 index 72c437f373b..00000000000 --- a/docs-exp/auth-types.auth.tenantid.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [tenantId](./auth-types.auth.tenantid.md) - -## Auth.tenantId property - -The Auth instance's tenant ID. - -Signature: - -```typescript -tenantId: string | null; -``` - -## Remarks - -This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. - -## Example - - -```javascript -// Set the tenant ID on Auth instance. -auth.tenantId = 'TENANT_PROJECT_ID'; - -// All future sign-in request now include tenant ID. -const result = await signInWithEmailAndPassword(auth, email, password); -// result.user.tenantId should be 'TENANT_PROJECT_ID'. - -``` - diff --git a/docs-exp/auth-types.auth.updatecurrentuser.md b/docs-exp/auth-types.auth.updatecurrentuser.md deleted file mode 100644 index 23dd544fcd1..00000000000 --- a/docs-exp/auth-types.auth.updatecurrentuser.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [updateCurrentUser](./auth-types.auth.updatecurrentuser.md) - -## Auth.updateCurrentUser() method - -Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. - -Signature: - -```typescript -updateCurrentUser(user: User | null): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| user | [User](./auth-types.user.md) \| null | The new [User](./auth-types.user.md). | - -Returns: - -Promise<void> - -## Remarks - -A new instance copy of the user provided will be made and set as currentUser. - -This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods. - -The operation fails with an error if the user to be updated belongs to a different Firebase project. - diff --git a/docs-exp/auth-types.auth.usedevicelanguage.md b/docs-exp/auth-types.auth.usedevicelanguage.md deleted file mode 100644 index d39ebe945c0..00000000000 --- a/docs-exp/auth-types.auth.usedevicelanguage.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [useDeviceLanguage](./auth-types.auth.usedevicelanguage.md) - -## Auth.useDeviceLanguage() method - -Sets the current language to the default device/browser preference. - -Signature: - -```typescript -useDeviceLanguage(): void; -``` -Returns: - -void - diff --git a/docs-exp/auth-types.auth.useemulator.md b/docs-exp/auth-types.auth.useemulator.md deleted file mode 100644 index c231c97a379..00000000000 --- a/docs-exp/auth-types.auth.useemulator.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [useEmulator](./auth-types.auth.useemulator.md) - -## Auth.useEmulator() method - -Modify this Auth instance to communicate with the Firebase Auth emulator. - -Signature: - -```typescript -useEmulator(url: string, options?: { disableWarnings: boolean }): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | The URL at which the emulator is running (eg, 'http://localhost:9099'). | -| options | { disableWarnings: boolean } | | - -Returns: - -void - -## Remarks - -This must be called synchronously immediately following the first call to [initializeAuth()](./auth.initializeauth.md). Do not use with production credentials as emulator traffic is not encrypted. - diff --git a/docs-exp/auth-types.authcredential.fromjson.md b/docs-exp/auth-types.authcredential.fromjson.md deleted file mode 100644 index 61a3e8ed00a..00000000000 --- a/docs-exp/auth-types.authcredential.fromjson.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [fromJSON](./auth-types.authcredential.fromjson.md) - -## AuthCredential.fromJSON() method - -Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). - -Signature: - -```typescript -static fromJSON(json: object | string): AuthCredential | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | - -Returns: - -[AuthCredential](./auth-types.authcredential.md) \| null - -If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. - diff --git a/docs-exp/auth-types.authcredential.md b/docs-exp/auth-types.authcredential.md deleted file mode 100644 index ae411daaa69..00000000000 --- a/docs-exp/auth-types.authcredential.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) - -## AuthCredential class - -Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). - -Signature: - -```typescript -export abstract class AuthCredential -``` - -## Remarks - -Implementations specify the details about each auth provider's credential requirements. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [providerId](./auth-types.authcredential.providerid.md) | | string | The authentication provider ID for the credential. | -| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | The authentication sign in method for the credential. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [fromJSON(json)](./auth-types.authcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | -| [toJSON()](./auth-types.authcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | - diff --git a/docs-exp/auth-types.authcredential.providerid.md b/docs-exp/auth-types.authcredential.providerid.md deleted file mode 100644 index 23fe69a5131..00000000000 --- a/docs-exp/auth-types.authcredential.providerid.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [providerId](./auth-types.authcredential.providerid.md) - -## AuthCredential.providerId property - -The authentication provider ID for the credential. - -Signature: - -```typescript -readonly providerId: string; -``` - -## Remarks - -For example, 'facebook.com', or 'google.com'. - diff --git a/docs-exp/auth-types.authcredential.signinmethod.md b/docs-exp/auth-types.authcredential.signinmethod.md deleted file mode 100644 index ed2cc5d7ab5..00000000000 --- a/docs-exp/auth-types.authcredential.signinmethod.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [signInMethod](./auth-types.authcredential.signinmethod.md) - -## AuthCredential.signInMethod property - -The authentication sign in method for the credential. - -Signature: - -```typescript -readonly signInMethod: string; -``` - -## Remarks - -For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth.fetchsigninmethodsforemail.md). - diff --git a/docs-exp/auth-types.authcredential.tojson.md b/docs-exp/auth-types.authcredential.tojson.md deleted file mode 100644 index a85af3ab78e..00000000000 --- a/docs-exp/auth-types.authcredential.tojson.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [toJSON](./auth-types.authcredential.tojson.md) - -## AuthCredential.toJSON() method - -Returns a JSON-serializable representation of this object. - -Signature: - -```typescript -toJSON(): object; -``` -Returns: - -object - -a JSON-serializable representation of this object. - diff --git a/docs-exp/auth-types.autherror.appname.md b/docs-exp/auth-types.autherror.appname.md deleted file mode 100644 index e81faf120a6..00000000000 --- a/docs-exp/auth-types.autherror.appname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [appName](./auth-types.autherror.appname.md) - -## AuthError.appName property - -The name of the Firebase App which triggered this error. - -Signature: - -```typescript -readonly appName: string; -``` diff --git a/docs-exp/auth-types.autherror.email.md b/docs-exp/auth-types.autherror.email.md deleted file mode 100644 index 2267e3f9aef..00000000000 --- a/docs-exp/auth-types.autherror.email.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [email](./auth-types.autherror.email.md) - -## AuthError.email property - -The email of the user's account, used for sign-in/linking. - -Signature: - -```typescript -readonly email?: string; -``` diff --git a/docs-exp/auth-types.autherror.md b/docs-exp/auth-types.autherror.md deleted file mode 100644 index 18ac24db8c4..00000000000 --- a/docs-exp/auth-types.autherror.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) - -## AuthError interface - -Interface for an Auth error. - -Signature: - -```typescript -export interface AuthError extends FirebaseError -``` -Extends: FirebaseError - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appName](./auth-types.autherror.appname.md) | string | The name of the Firebase App which triggered this error. | -| [email](./auth-types.autherror.email.md) | string | The email of the user's account, used for sign-in/linking. | -| [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account, used for sign-in/linking. | -| [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. | - diff --git a/docs-exp/auth-types.autherror.phonenumber.md b/docs-exp/auth-types.autherror.phonenumber.md deleted file mode 100644 index 8b8c41a0e7e..00000000000 --- a/docs-exp/auth-types.autherror.phonenumber.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [phoneNumber](./auth-types.autherror.phonenumber.md) - -## AuthError.phoneNumber property - -The phone number of the user's account, used for sign-in/linking. - -Signature: - -```typescript -readonly phoneNumber?: string; -``` diff --git a/docs-exp/auth-types.autherror.tenantid.md b/docs-exp/auth-types.autherror.tenantid.md deleted file mode 100644 index ac6e1735a45..00000000000 --- a/docs-exp/auth-types.autherror.tenantid.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [tenantid](./auth-types.autherror.tenantid.md) - -## AuthError.tenantid property - -The tenant ID being used for sign-in/linking. - -Signature: - -```typescript -readonly tenantid?: string; -``` - -## Remarks - -If you use [signInWithRedirect()](./auth.signinwithredirect.md) to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. - diff --git a/docs-exp/auth-types.autherrormap.md b/docs-exp/auth-types.autherrormap.md deleted file mode 100644 index 0cde0864c60..00000000000 --- a/docs-exp/auth-types.autherrormap.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthErrorMap](./auth-types.autherrormap.md) - -## AuthErrorMap interface - -A mapping of error codes to error messages. - - -While error messages are useful for debugging (providing verbose textual context around what went wrong), these strings take up a lot of space in the compiled code. When deploying code in production, using will save you roughly 10k compressed/gzipped over . You can select the error map during initialization: - -```javascript -initializeAuth(app, {errorMap: debugErrorMap}) - -``` -When initializing Auth, is default. - -Signature: - -```typescript -export interface AuthErrorMap -``` diff --git a/docs-exp/auth-types.authprovider.md b/docs-exp/auth-types.authprovider.md deleted file mode 100644 index 334599c9f78..00000000000 --- a/docs-exp/auth-types.authprovider.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthProvider](./auth-types.authprovider.md) - -## AuthProvider interface - -Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md). - -Signature: - -```typescript -export interface AuthProvider -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [providerId](./auth-types.authprovider.providerid.md) | string | Provider for which credentials can be constructed. | - diff --git a/docs-exp/auth-types.authprovider.providerid.md b/docs-exp/auth-types.authprovider.providerid.md deleted file mode 100644 index a66cf608028..00000000000 --- a/docs-exp/auth-types.authprovider.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthProvider](./auth-types.authprovider.md) > [providerId](./auth-types.authprovider.providerid.md) - -## AuthProvider.providerId property - -Provider for which credentials can be constructed. - -Signature: - -```typescript -readonly providerId: string; -``` diff --git a/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md b/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md deleted file mode 100644 index 6b7e06d62a8..00000000000 --- a/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthSettings](./auth-types.authsettings.md) > [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) - -## AuthSettings.appVerificationDisabledForTesting property - -When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests. - -In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console. - -The default value is false (app verification is enabled). - -Signature: - -```typescript -appVerificationDisabledForTesting: boolean; -``` diff --git a/docs-exp/auth-types.authsettings.md b/docs-exp/auth-types.authsettings.md deleted file mode 100644 index 7148b137ba7..00000000000 --- a/docs-exp/auth-types.authsettings.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthSettings](./auth-types.authsettings.md) - -## AuthSettings interface - -Interface representing an Auth instance's settings. - -Signature: - -```typescript -export interface AuthSettings -``` - -## Remarks - -Currently used for enabling/disabling app verification for phone Auth testing. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) | boolean | When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.The default value is false (app verification is enabled). | - diff --git a/docs-exp/auth-types.config.apihost.md b/docs-exp/auth-types.config.apihost.md deleted file mode 100644 index 106e5d2b67b..00000000000 --- a/docs-exp/auth-types.config.apihost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiHost](./auth-types.config.apihost.md) - -## Config.apiHost property - -The host at which the Firebase Auth backend is running. - -Signature: - -```typescript -apiHost: string; -``` diff --git a/docs-exp/auth-types.config.apikey.md b/docs-exp/auth-types.config.apikey.md deleted file mode 100644 index ca8e646361d..00000000000 --- a/docs-exp/auth-types.config.apikey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiKey](./auth-types.config.apikey.md) - -## Config.apiKey property - -The API Key used to communicate with the Firebase Auth backend. - -Signature: - -```typescript -apiKey: string; -``` diff --git a/docs-exp/auth-types.config.apischeme.md b/docs-exp/auth-types.config.apischeme.md deleted file mode 100644 index dc28a29abc4..00000000000 --- a/docs-exp/auth-types.config.apischeme.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiScheme](./auth-types.config.apischeme.md) - -## Config.apiScheme property - -The scheme used to communicate with the Firebase Auth backend. - -Signature: - -```typescript -apiScheme: string; -``` diff --git a/docs-exp/auth-types.config.authdomain.md b/docs-exp/auth-types.config.authdomain.md deleted file mode 100644 index fda7e1ff3e8..00000000000 --- a/docs-exp/auth-types.config.authdomain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [authDomain](./auth-types.config.authdomain.md) - -## Config.authDomain property - -The domain at which the web widgets are hosted (provided via Firebase Config). - -Signature: - -```typescript -authDomain?: string; -``` diff --git a/docs-exp/auth-types.config.md b/docs-exp/auth-types.config.md deleted file mode 100644 index 451c8833fc2..00000000000 --- a/docs-exp/auth-types.config.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) - -## Config interface - -Interface representing the Auth config. - -Signature: - -```typescript -export interface Config -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiHost](./auth-types.config.apihost.md) | string | The host at which the Firebase Auth backend is running. | -| [apiKey](./auth-types.config.apikey.md) | string | The API Key used to communicate with the Firebase Auth backend. | -| [apiScheme](./auth-types.config.apischeme.md) | string | The scheme used to communicate with the Firebase Auth backend. | -| [authDomain](./auth-types.config.authdomain.md) | string | The domain at which the web widgets are hosted (provided via Firebase Config). | -| [sdkClientVersion](./auth-types.config.sdkclientversion.md) | string | The SDK Client Version. | -| [tokenApiHost](./auth-types.config.tokenapihost.md) | string | The host at which the Secure Token API is running. | - diff --git a/docs-exp/auth-types.config.sdkclientversion.md b/docs-exp/auth-types.config.sdkclientversion.md deleted file mode 100644 index 29edfdba0f8..00000000000 --- a/docs-exp/auth-types.config.sdkclientversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [sdkClientVersion](./auth-types.config.sdkclientversion.md) - -## Config.sdkClientVersion property - -The SDK Client Version. - -Signature: - -```typescript -sdkClientVersion: string; -``` diff --git a/docs-exp/auth-types.config.tokenapihost.md b/docs-exp/auth-types.config.tokenapihost.md deleted file mode 100644 index f896fac07a0..00000000000 --- a/docs-exp/auth-types.config.tokenapihost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [tokenApiHost](./auth-types.config.tokenapihost.md) - -## Config.tokenApiHost property - -The host at which the Secure Token API is running. - -Signature: - -```typescript -tokenApiHost: string; -``` diff --git a/docs-exp/auth-types.confirmationresult.confirm.md b/docs-exp/auth-types.confirmationresult.confirm.md deleted file mode 100644 index 78292434837..00000000000 --- a/docs-exp/auth-types.confirmationresult.confirm.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) > [confirm](./auth-types.confirmationresult.confirm.md) - -## ConfirmationResult.confirm() method - -Finishes a phone number sign-in, link, or reauthentication. - -Signature: - -```typescript -confirm(verificationCode: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| verificationCode | string | The code that was sent to the user's mobile device. | - -Returns: - -Promise<[UserCredential](./auth-types.usercredential.md)> - -## Example - - -```javascript -const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); -// Obtain verificationCode from the user. -const userCredential = await confirmationResult.confirm(verificationCode); - -``` - diff --git a/docs-exp/auth-types.confirmationresult.md b/docs-exp/auth-types.confirmationresult.md deleted file mode 100644 index 276423f8e0b..00000000000 --- a/docs-exp/auth-types.confirmationresult.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) - -## ConfirmationResult interface - -A result from a phone number sign-in, link, or reauthenticate call. - -Signature: - -```typescript -export interface ConfirmationResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | The phone number authentication operation's verification ID. | - -## Methods - -| Method | Description | -| --- | --- | -| [confirm(verificationCode)](./auth-types.confirmationresult.confirm.md) | Finishes a phone number sign-in, link, or reauthentication. | - diff --git a/docs-exp/auth-types.confirmationresult.verificationid.md b/docs-exp/auth-types.confirmationresult.verificationid.md deleted file mode 100644 index e7f239dca8a..00000000000 --- a/docs-exp/auth-types.confirmationresult.verificationid.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) > [verificationId](./auth-types.confirmationresult.verificationid.md) - -## ConfirmationResult.verificationId property - -The phone number authentication operation's verification ID. - -Signature: - -```typescript -readonly verificationId: string; -``` - -## Remarks - -This can be used along with the verification code to initialize a [PhoneAuthCredential](./auth-types.phoneauthcredential.md). - diff --git a/docs-exp/auth-types.emailauthprovider.credential.md b/docs-exp/auth-types.emailauthprovider.credential.md deleted file mode 100644 index 8a2c22128e6..00000000000 --- a/docs-exp/auth-types.emailauthprovider.credential.md +++ /dev/null @@ -1,44 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [credential](./auth-types.emailauthprovider.credential.md) - -## EmailAuthProvider.credential() method - -Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. - -Signature: - -```typescript -static credential(email: string, password: string): AuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| email | string | Email address. | -| password | string | User account password. | - -Returns: - -[AuthCredential](./auth-types.authcredential.md) - -The auth provider credential. - -## Example 1 - - -```javascript -const authCredential = EmailAuthProvider.credential(email, password); -const userCredential = await signInWithCredential(auth, authCredential); - -``` - -## Example 2 - - -```javascript -const userCredential = await signInWithEmailAndPassword(auth, email, password); - -``` - diff --git a/docs-exp/auth-types.emailauthprovider.credentialwithlink.md b/docs-exp/auth-types.emailauthprovider.credentialwithlink.md deleted file mode 100644 index 4bc7ba2bc8d..00000000000 --- a/docs-exp/auth-types.emailauthprovider.credentialwithlink.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [credentialWithLink](./auth-types.emailauthprovider.credentialwithlink.md) - -## EmailAuthProvider.credentialWithLink() method - -Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. - -Signature: - -```typescript -static credentialWithLink( - auth: Auth, - email: string, - emailLink: string - ): AuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | [Auth](./auth-types.auth.md) | The Auth instance used to verify the link. | -| email | string | Email address. | -| emailLink | string | Sign-in email link. | - -Returns: - -[AuthCredential](./auth-types.authcredential.md) - -- The auth provider credential. - -## Example 1 - - -```javascript -const authCredential = EmailAuthProvider.credentialWithLink(auth, email, emailLink); -const userCredential = await signInWithCredential(auth, authCredential); - -``` - -## Example 2 - - -```javascript -await sendSignInLinkToEmail(auth, email); -// Obtain emailLink from user. -const userCredential = await signInWithEmailLink(auth, email, emailLink); - -``` - diff --git a/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md b/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md deleted file mode 100644 index ffbd4c920a1..00000000000 --- a/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_link_sign_in_method.md) - -## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD property - -Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). - -Signature: - -```typescript -static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod; -``` diff --git a/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md b/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md deleted file mode 100644 index 436ad010c43..00000000000 --- a/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_password_sign_in_method.md) - -## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD property - -Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). - -Signature: - -```typescript -static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod; -``` diff --git a/docs-exp/auth-types.emailauthprovider.md b/docs-exp/auth-types.emailauthprovider.md deleted file mode 100644 index 0aed67f1788..00000000000 --- a/docs-exp/auth-types.emailauthprovider.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) - -## EmailAuthProvider class - -Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). - -Signature: - -```typescript -export abstract class EmailAuthProvider implements AuthProvider -``` -Implements: [AuthProvider](./auth-types.authprovider.md) - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_link_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). | -| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_password_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). | -| [PROVIDER\_ID](./auth-types.emailauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | -| [providerId](./auth-types.emailauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [credential(email, password)](./auth-types.emailauthprovider.credential.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. | -| [credentialWithLink(auth, email, emailLink)](./auth-types.emailauthprovider.credentialwithlink.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. | - diff --git a/docs-exp/auth-types.emailauthprovider.provider_id.md b/docs-exp/auth-types.emailauthprovider.provider_id.md deleted file mode 100644 index a34b96cc0e6..00000000000 --- a/docs-exp/auth-types.emailauthprovider.provider_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [PROVIDER\_ID](./auth-types.emailauthprovider.provider_id.md) - -## EmailAuthProvider.PROVIDER\_ID property - -Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. - -Signature: - -```typescript -static readonly PROVIDER_ID: ProviderId; -``` diff --git a/docs-exp/auth-types.emailauthprovider.providerid.md b/docs-exp/auth-types.emailauthprovider.providerid.md deleted file mode 100644 index 28f28ec6d17..00000000000 --- a/docs-exp/auth-types.emailauthprovider.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [providerId](./auth-types.emailauthprovider.providerid.md) - -## EmailAuthProvider.providerId property - -Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. - -Signature: - -```typescript -readonly providerId: ProviderId; -``` diff --git a/docs-exp/auth-types.factorid.md b/docs-exp/auth-types.factorid.md deleted file mode 100644 index d33c885fd6f..00000000000 --- a/docs-exp/auth-types.factorid.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [FactorId](./auth-types.factorid.md) - -## FactorId enum - -An enum of factors that may be used for multifactor authentication. - -Signature: - -```typescript -export const enum FactorId -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PHONE | 'phone' | Phone as second factor | - diff --git a/docs-exp/auth-types.idtokenresult.authtime.md b/docs-exp/auth-types.idtokenresult.authtime.md deleted file mode 100644 index 075aa39fb38..00000000000 --- a/docs-exp/auth-types.idtokenresult.authtime.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [authTime](./auth-types.idtokenresult.authtime.md) - -## IdTokenResult.authTime property - -The authentication time formatted as a UTC string. - -Signature: - -```typescript -authTime: string; -``` - -## Remarks - -This is the time the user authenticated (signed in) and not the time the token was refreshed. - diff --git a/docs-exp/auth-types.idtokenresult.claims.md b/docs-exp/auth-types.idtokenresult.claims.md deleted file mode 100644 index 7e25e4d4ad8..00000000000 --- a/docs-exp/auth-types.idtokenresult.claims.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [claims](./auth-types.idtokenresult.claims.md) - -## IdTokenResult.claims property - -The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. - -Signature: - -```typescript -claims: ParsedToken; -``` diff --git a/docs-exp/auth-types.idtokenresult.expirationtime.md b/docs-exp/auth-types.idtokenresult.expirationtime.md deleted file mode 100644 index b3ef039be4a..00000000000 --- a/docs-exp/auth-types.idtokenresult.expirationtime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [expirationTime](./auth-types.idtokenresult.expirationtime.md) - -## IdTokenResult.expirationTime property - -The ID token expiration time formatted as a UTC string. - -Signature: - -```typescript -expirationTime: string; -``` diff --git a/docs-exp/auth-types.idtokenresult.issuedattime.md b/docs-exp/auth-types.idtokenresult.issuedattime.md deleted file mode 100644 index cfa4f7117cf..00000000000 --- a/docs-exp/auth-types.idtokenresult.issuedattime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) - -## IdTokenResult.issuedAtTime property - -The ID token issuance time formatted as a UTC string. - -Signature: - -```typescript -issuedAtTime: string; -``` diff --git a/docs-exp/auth-types.idtokenresult.md b/docs-exp/auth-types.idtokenresult.md deleted file mode 100644 index 1ac016498ca..00000000000 --- a/docs-exp/auth-types.idtokenresult.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) - -## IdTokenResult interface - -Interface representing ID token result obtained from [User.getIdTokenResult()](./auth-types.user.getidtokenresult.md). - -Signature: - -```typescript -export interface IdTokenResult -``` - -## Remarks - -It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims. - -Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authTime](./auth-types.idtokenresult.authtime.md) | string | The authentication time formatted as a UTC string. | -| [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. | -| [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | The ID token expiration time formatted as a UTC string. | -| [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | The ID token issuance time formatted as a UTC string. | -| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). | -| [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). | -| [token](./auth-types.idtokenresult.token.md) | string | The Firebase Auth ID token JWT string. | - diff --git a/docs-exp/auth-types.idtokenresult.signinprovider.md b/docs-exp/auth-types.idtokenresult.signinprovider.md deleted file mode 100644 index 09943105169..00000000000 --- a/docs-exp/auth-types.idtokenresult.signinprovider.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [signInProvider](./auth-types.idtokenresult.signinprovider.md) - -## IdTokenResult.signInProvider property - -The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). - -Signature: - -```typescript -signInProvider: string | null; -``` - -## Remarks - -Note, this does not map to provider IDs. - diff --git a/docs-exp/auth-types.idtokenresult.signinsecondfactor.md b/docs-exp/auth-types.idtokenresult.signinsecondfactor.md deleted file mode 100644 index d1ae55482dc..00000000000 --- a/docs-exp/auth-types.idtokenresult.signinsecondfactor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) - -## IdTokenResult.signInSecondFactor property - -The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). - -Signature: - -```typescript -signInSecondFactor: string | null; -``` diff --git a/docs-exp/auth-types.idtokenresult.token.md b/docs-exp/auth-types.idtokenresult.token.md deleted file mode 100644 index 1947e05d8f4..00000000000 --- a/docs-exp/auth-types.idtokenresult.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [token](./auth-types.idtokenresult.token.md) - -## IdTokenResult.token property - -The Firebase Auth ID token JWT string. - -Signature: - -```typescript -token: string; -``` diff --git a/docs-exp/auth-types.md b/docs-exp/auth-types.md deleted file mode 100644 index 840aee8b6c9..00000000000 --- a/docs-exp/auth-types.md +++ /dev/null @@ -1,77 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) - -## auth-types package - -## Classes - -| Class | Description | -| --- | --- | -| [ActionCodeURL](./auth-types.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. | -| [AuthCredential](./auth-types.authcredential.md) | Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). | -| [EmailAuthProvider](./auth-types.emailauthprovider.md) | Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). | -| [OAuthCredential](./auth-types.oauthcredential.md) | Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). | -| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). | -| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). | -| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). | -| [RecaptchaVerifier](./auth-types.recaptchaverifier.md) | An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [ActionCodeOperation](./auth-types.actioncodeoperation.md) | An enumeration of the possible email action types. | -| [FactorId](./auth-types.factorid.md) | An enum of factors that may be used for multifactor authentication. | -| [OperationType](./auth-types.operationtype.md) | Enumeration of supported operation types. | -| [ProviderId](./auth-types.providerid.md) | Enumeration of supported providers. | -| [SignInMethod](./auth-types.signinmethod.md) | Enumeration of supported sign-in methods. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | A response from [checkActionCode()](./auth.checkactioncode.md). | -| [ActionCodeSettings](./auth-types.actioncodesettings.md) | An interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. | -| [AdditionalUserInfo](./auth-types.additionaluserinfo.md) | A structure containing additional user information from a federated identity provider. | -| [ApplicationVerifier](./auth-types.applicationverifier.md) | A verifier for domain verification and abuse prevention. | -| [Auth](./auth-types.auth.md) | Interface representing Firebase Auth service. | -| [AuthError](./auth-types.autherror.md) | Interface for an Auth error. | -| [AuthErrorMap](./auth-types.autherrormap.md) | A mapping of error codes to error messages.While error messages are useful for debugging (providing verbose textual context around what went wrong), these strings take up a lot of space in the compiled code. When deploying code in production, using will save you roughly 10k compressed/gzipped over . You can select the error map during initialization: -```javascript -initializeAuth(app, {errorMap: debugErrorMap}) - -``` -When initializing Auth, is default. | -| [AuthProvider](./auth-types.authprovider.md) | Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md). | -| [AuthSettings](./auth-types.authsettings.md) | Interface representing an Auth instance's settings. | -| [Config](./auth-types.config.md) | Interface representing the Auth config. | -| [ConfirmationResult](./auth-types.confirmationresult.md) | A result from a phone number sign-in, link, or reauthenticate call. | -| [IdTokenResult](./auth-types.idtokenresult.md) | Interface representing ID token result obtained from [User.getIdTokenResult()](./auth-types.user.getidtokenresult.md). | -| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The base class for asserting ownership of a second factor. | -| [MultiFactorError](./auth-types.multifactorerror.md) | The error thrown when the user needs to provide a second factor to sign in successfully. | -| [MultiFactorInfo](./auth-types.multifactorinfo.md) | A structure containing the information of a second factor entity. | -| [MultiFactorResolver](./auth-types.multifactorresolver.md) | The class used to facilitate recovery from [MultiFactorError](./auth-types.multifactorerror.md) when a user needs to provide a second factor to sign in. | -| [MultiFactorSession](./auth-types.multifactorsession.md) | An interface defining the multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. | -| [MultiFactorUser](./auth-types.multifactoruser.md) | An interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). | -| [ParsedToken](./auth-types.parsedtoken.md) | Interface representing a parsed ID token. | -| [Persistence](./auth-types.persistence.md) | An interface covering the possible persistence mechanism types. | -| [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md). | -| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second factor. | -| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | Options used for signing-in with a second factor. | -| [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | Options used for single-factor sign-in. | -| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like [signInWithPopup()](./auth.signinwithpopup.md) or [signInWithRedirect()](./auth.signinwithredirect.md). | -| [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | Interface for a supplied AsyncStorage. | -| [User](./auth-types.user.md) | A user account. | -| [UserCredential](./auth-types.usercredential.md) | A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. | -| [UserInfo](./auth-types.userinfo.md) | User profile information, visible only to the Firebase project's apps. | -| [UserMetadata](./auth-types.usermetadata.md) | Interface representing a user's metadata. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [NextOrObserver](./auth-types.nextorobserver.md) | Type definition for an event callback. | -| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. | -| [UserProfile](./auth-types.userprofile.md) | User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md). | - diff --git a/docs-exp/auth-types.multifactorassertion.factorid.md b/docs-exp/auth-types.multifactorassertion.factorid.md deleted file mode 100644 index 447cbba2836..00000000000 --- a/docs-exp/auth-types.multifactorassertion.factorid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorAssertion](./auth-types.multifactorassertion.md) > [factorId](./auth-types.multifactorassertion.factorid.md) - -## MultiFactorAssertion.factorId property - -The identifier of the second factor. - -Signature: - -```typescript -readonly factorId: FactorId; -``` diff --git a/docs-exp/auth-types.multifactorassertion.md b/docs-exp/auth-types.multifactorassertion.md deleted file mode 100644 index 0fd6708f9bd..00000000000 --- a/docs-exp/auth-types.multifactorassertion.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorAssertion](./auth-types.multifactorassertion.md) - -## MultiFactorAssertion interface - -The base class for asserting ownership of a second factor. - -Signature: - -```typescript -export interface MultiFactorAssertion -``` - -## Remarks - -This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [factorId](./auth-types.multifactorassertion.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. | - diff --git a/docs-exp/auth-types.multifactorerror.md b/docs-exp/auth-types.multifactorerror.md deleted file mode 100644 index 3a6d39cf293..00000000000 --- a/docs-exp/auth-types.multifactorerror.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorError](./auth-types.multifactorerror.md) - -## MultiFactorError interface - -The error thrown when the user needs to provide a second factor to sign in successfully. - -Signature: - -```typescript -export interface MultiFactorError extends AuthError -``` -Extends: [AuthError](./auth-types.autherror.md) - -## Remarks - -The error code for this error is `auth/multi-factor-auth-required`. - -## Example - - -```javascript -let resolver; -let multiFactorHints; - -signInWithEmailAndPassword(auth, email, password) - .then((result) => { - // User signed in. No 2nd factor challenge is needed. - }) - .catch((error) => { - if (error.code == 'auth/multi-factor-auth-required') { - resolver = getMultiFactorResolver(auth, error); - multiFactorHints = resolver.hints; - } else { - // Handle other errors. - } - }); - -// Obtain a multiFactorAssertion by verifying the second factor. - -const userCredential = await resolver.resolveSignIn(multiFactorAssertion); - -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. | - diff --git a/docs-exp/auth-types.multifactorerror.operationtype.md b/docs-exp/auth-types.multifactorerror.operationtype.md deleted file mode 100644 index 194fe01bb90..00000000000 --- a/docs-exp/auth-types.multifactorerror.operationtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorError](./auth-types.multifactorerror.md) > [operationType](./auth-types.multifactorerror.operationtype.md) - -## MultiFactorError.operationType property - -The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. - -Signature: - -```typescript -readonly operationType: OperationType; -``` diff --git a/docs-exp/auth-types.multifactorinfo.displayname.md b/docs-exp/auth-types.multifactorinfo.displayname.md deleted file mode 100644 index 5501594b816..00000000000 --- a/docs-exp/auth-types.multifactorinfo.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [displayName](./auth-types.multifactorinfo.displayname.md) - -## MultiFactorInfo.displayName property - -The user friendly name of the current second factor. - -Signature: - -```typescript -readonly displayName?: string | null; -``` diff --git a/docs-exp/auth-types.multifactorinfo.enrollmenttime.md b/docs-exp/auth-types.multifactorinfo.enrollmenttime.md deleted file mode 100644 index 8bc3596ac22..00000000000 --- a/docs-exp/auth-types.multifactorinfo.enrollmenttime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) - -## MultiFactorInfo.enrollmentTime property - -The enrollment date of the second factor formatted as a UTC string. - -Signature: - -```typescript -readonly enrollmentTime: string; -``` diff --git a/docs-exp/auth-types.multifactorinfo.factorid.md b/docs-exp/auth-types.multifactorinfo.factorid.md deleted file mode 100644 index 05f66b14bf5..00000000000 --- a/docs-exp/auth-types.multifactorinfo.factorid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [factorId](./auth-types.multifactorinfo.factorid.md) - -## MultiFactorInfo.factorId property - -The identifier of the second factor. - -Signature: - -```typescript -readonly factorId: FactorId; -``` diff --git a/docs-exp/auth-types.multifactorinfo.md b/docs-exp/auth-types.multifactorinfo.md deleted file mode 100644 index f7c197fb528..00000000000 --- a/docs-exp/auth-types.multifactorinfo.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) - -## MultiFactorInfo interface - -A structure containing the information of a second factor entity. - -Signature: - -```typescript -export interface MultiFactorInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | The user friendly name of the current second factor. | -| [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | The enrollment date of the second factor formatted as a UTC string. | -| [factorId](./auth-types.multifactorinfo.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. | -| [uid](./auth-types.multifactorinfo.uid.md) | string | The multi-factor enrollment ID. | - diff --git a/docs-exp/auth-types.multifactorinfo.uid.md b/docs-exp/auth-types.multifactorinfo.uid.md deleted file mode 100644 index 58ba0a91783..00000000000 --- a/docs-exp/auth-types.multifactorinfo.uid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [uid](./auth-types.multifactorinfo.uid.md) - -## MultiFactorInfo.uid property - -The multi-factor enrollment ID. - -Signature: - -```typescript -readonly uid: string; -``` diff --git a/docs-exp/auth-types.multifactorresolver.hints.md b/docs-exp/auth-types.multifactorresolver.hints.md deleted file mode 100644 index 29c5a15f8bb..00000000000 --- a/docs-exp/auth-types.multifactorresolver.hints.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [hints](./auth-types.multifactorresolver.hints.md) - -## MultiFactorResolver.hints property - -The list of hints for the second factors needed to complete the sign-in for the current session. - -Signature: - -```typescript -readonly hints: MultiFactorInfo[]; -``` diff --git a/docs-exp/auth-types.multifactorresolver.md b/docs-exp/auth-types.multifactorresolver.md deleted file mode 100644 index 163f6896e36..00000000000 --- a/docs-exp/auth-types.multifactorresolver.md +++ /dev/null @@ -1,70 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) - -## MultiFactorResolver interface - -The class used to facilitate recovery from [MultiFactorError](./auth-types.multifactorerror.md) when a user needs to provide a second factor to sign in. - -Signature: - -```typescript -export interface MultiFactorResolver -``` - -## Example - - -```javascript -let resolver; -let multiFactorHints; - -signInWithEmailAndPassword(auth, email, password) - .then((result) => { - // User signed in. No 2nd factor challenge is needed. - }) - .catch((error) => { - if (error.code == 'auth/multi-factor-auth-required') { - resolver = getMultiFactorResolver(auth, error); - // Show UI to let user select second factor. - multiFactorHints = resolver.hints; - } else { - // Handle other errors. - } - }); - -// The enrolled second factors that can be used to complete -// sign-in are returned in the `MultiFactorResolver.hints` list. -// UI needs to be presented to allow the user to select a second factor -// from that list. - -const selectedHint = // ; selected from multiFactorHints -const phoneAuthProvider = new PhoneAuthProvider(auth); -const phoneInfoOptions = { - multiFactorHint: selectedHint, - session: resolver.session -}; -const verificationId = phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); -// Store `verificationId` and show UI to let user enter verification code. - -// UI to enter verification code and continue. -// Continue button click handler -const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); -const userCredential = await resolver.resolveSignIn(multiFactorAssertion); - -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hints](./auth-types.multifactorresolver.hints.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | The list of hints for the second factors needed to complete the sign-in for the current session. | -| [session](./auth-types.multifactorresolver.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The session identifier for the current sign-in flow, which can be used to complete the second factor sign-in. | - -## Methods - -| Method | Description | -| --- | --- | -| [resolveSignIn(assertion)](./auth-types.multifactorresolver.resolvesignin.md) | A helper function to help users complete sign in with a second factor using an [MultiFactorAssertion](./auth-types.multifactorassertion.md) confirming the user successfully completed the second factor challenge. | - diff --git a/docs-exp/auth-types.multifactorresolver.resolvesignin.md b/docs-exp/auth-types.multifactorresolver.resolvesignin.md deleted file mode 100644 index c2b085a3cd0..00000000000 --- a/docs-exp/auth-types.multifactorresolver.resolvesignin.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [resolveSignIn](./auth-types.multifactorresolver.resolvesignin.md) - -## MultiFactorResolver.resolveSignIn() method - -A helper function to help users complete sign in with a second factor using an [MultiFactorAssertion](./auth-types.multifactorassertion.md) confirming the user successfully completed the second factor challenge. - -Signature: - -```typescript -resolveSignIn(assertion: MultiFactorAssertion): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The multi-factor assertion to resolve sign-in with. | - -Returns: - -Promise<[UserCredential](./auth-types.usercredential.md)> - -The promise that resolves with the user credential object. - -## Example - - -```javascript -const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); -const userCredential = await resolver.resolveSignIn(multiFactorAssertion); - -``` - diff --git a/docs-exp/auth-types.multifactorresolver.session.md b/docs-exp/auth-types.multifactorresolver.session.md deleted file mode 100644 index 48755f69a18..00000000000 --- a/docs-exp/auth-types.multifactorresolver.session.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [session](./auth-types.multifactorresolver.session.md) - -## MultiFactorResolver.session property - -The session identifier for the current sign-in flow, which can be used to complete the second factor sign-in. - -Signature: - -```typescript -readonly session: MultiFactorSession; -``` diff --git a/docs-exp/auth-types.multifactorsession.md b/docs-exp/auth-types.multifactorsession.md deleted file mode 100644 index 8c348a7b6f0..00000000000 --- a/docs-exp/auth-types.multifactorsession.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorSession](./auth-types.multifactorsession.md) - -## MultiFactorSession interface - -An interface defining the multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. - -Signature: - -```typescript -export interface MultiFactorSession -``` diff --git a/docs-exp/auth-types.multifactoruser.enroll.md b/docs-exp/auth-types.multifactoruser.enroll.md deleted file mode 100644 index b75ed9ca9a3..00000000000 --- a/docs-exp/auth-types.multifactoruser.enroll.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [enroll](./auth-types.multifactoruser.enroll.md) - -## MultiFactorUser.enroll() method - -Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. - -Signature: - -```typescript -enroll( - assertion: MultiFactorAssertion, - displayName?: string | null - ): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The multi-factor assertion to enroll with. | -| displayName | string \| null | The display name of the second factor. | - -Returns: - -Promise<void> - -## Remarks - -On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. - -## Example - - -```javascript -const multiFactorUser = multiFactor(auth.currentUser); -const multiFactorSession = await multiFactorUser.getSession(); - -// Send verification code. -const phoneAuthProvider = new PhoneAuthProvider(auth); -const phoneInfoOptions = { - phoneNumber: phoneNumber, - session: multiFactorSession -}; -const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); - -// Obtain verification code from user. -const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); -await multiFactorUser.enroll(multiFactorAssertion); -// Second factor enrolled. - -``` - diff --git a/docs-exp/auth-types.multifactoruser.enrolledfactors.md b/docs-exp/auth-types.multifactoruser.enrolledfactors.md deleted file mode 100644 index 7919a1505b4..00000000000 --- a/docs-exp/auth-types.multifactoruser.enrolledfactors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) - -## MultiFactorUser.enrolledFactors property - -Returns a list of the user's enrolled second factors. - -Signature: - -```typescript -readonly enrolledFactors: MultiFactorInfo[]; -``` diff --git a/docs-exp/auth-types.multifactoruser.getsession.md b/docs-exp/auth-types.multifactoruser.getsession.md deleted file mode 100644 index 9944464e9eb..00000000000 --- a/docs-exp/auth-types.multifactoruser.getsession.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [getSession](./auth-types.multifactoruser.getsession.md) - -## MultiFactorUser.getSession() method - -Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor. - -Signature: - -```typescript -getSession(): Promise; -``` -Returns: - -Promise<[MultiFactorSession](./auth-types.multifactorsession.md)> - -The promise that resolves with the [MultiFactorSession](./auth-types.multifactorsession.md). - -## Example - - -```javascript -const multiFactorUser = multiFactor(auth.currentUser); -const multiFactorSession = await multiFactorUser.getSession(); - -// Send verification code. -const phoneAuthProvider = new PhoneAuthProvider(auth); -const phoneInfoOptions = { - phoneNumber: phoneNumber, - session: multiFactorSession -}; -const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); - -// Obtain verification code from user. -const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); -await multiFactorUser.enroll(multiFactorAssertion); - -``` - diff --git a/docs-exp/auth-types.multifactoruser.md b/docs-exp/auth-types.multifactoruser.md deleted file mode 100644 index 39c34813142..00000000000 --- a/docs-exp/auth-types.multifactoruser.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) - -## MultiFactorUser interface - -An interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). - -Signature: - -```typescript -export interface MultiFactorUser -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | Returns a list of the user's enrolled second factors. | - -## Methods - -| Method | Description | -| --- | --- | -| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. | -| [getSession()](./auth-types.multifactoruser.getsession.md) | Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor. | -| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | Unenrolls the specified second factor. | - diff --git a/docs-exp/auth-types.multifactoruser.unenroll.md b/docs-exp/auth-types.multifactoruser.unenroll.md deleted file mode 100644 index 4ebbee84a86..00000000000 --- a/docs-exp/auth-types.multifactoruser.unenroll.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [unenroll](./auth-types.multifactoruser.unenroll.md) - -## MultiFactorUser.unenroll() method - -Unenrolls the specified second factor. - -Signature: - -```typescript -unenroll(option: MultiFactorInfo | string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| option | [MultiFactorInfo](./auth-types.multifactorinfo.md) \| string | The multi-factor option to unenroll. | - -Returns: - -Promise<void> - -- A promise which resolves when the unenroll operation is complete. - -## Remarks - -To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. - -## Example - - -```javascript -const multiFactorUser = multiFactor(auth.currentUser); -// Present user the option to choose which factor to unenroll. -await multiFactorUser.unenroll(multiFactorUser.enrolledFactors[i]) - -``` - diff --git a/docs-exp/auth-types.nextorobserver.md b/docs-exp/auth-types.nextorobserver.md deleted file mode 100644 index 8671703ca9d..00000000000 --- a/docs-exp/auth-types.nextorobserver.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [NextOrObserver](./auth-types.nextorobserver.md) - -## NextOrObserver type - -Type definition for an event callback. - -Signature: - -```typescript -export type NextOrObserver = NextFn | Observer; -``` diff --git a/docs-exp/auth-types.oauthcredential.accesstoken.md b/docs-exp/auth-types.oauthcredential.accesstoken.md deleted file mode 100644 index 51dfa8b6135..00000000000 --- a/docs-exp/auth-types.oauthcredential.accesstoken.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [accessToken](./auth-types.oauthcredential.accesstoken.md) - -## OAuthCredential.accessToken property - -The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as `facebook.com`, `twitter.com`, etc. - -Signature: - -```typescript -readonly accessToken?: string; -``` diff --git a/docs-exp/auth-types.oauthcredential.fromjson.md b/docs-exp/auth-types.oauthcredential.fromjson.md deleted file mode 100644 index 2b2869abf23..00000000000 --- a/docs-exp/auth-types.oauthcredential.fromjson.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [fromJSON](./auth-types.oauthcredential.fromjson.md) - -## OAuthCredential.fromJSON() method - -Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). - -Signature: - -```typescript -static fromJSON(json: object | string): OAuthCredential | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| json | object \| string | Input can be either Object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | - -Returns: - -[OAuthCredential](./auth-types.oauthcredential.md) \| null - -If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. - diff --git a/docs-exp/auth-types.oauthcredential.idtoken.md b/docs-exp/auth-types.oauthcredential.idtoken.md deleted file mode 100644 index 5f2bf89aee4..00000000000 --- a/docs-exp/auth-types.oauthcredential.idtoken.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [idToken](./auth-types.oauthcredential.idtoken.md) - -## OAuthCredential.idToken property - -The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as `google.com`. - -Signature: - -```typescript -readonly idToken?: string; -``` diff --git a/docs-exp/auth-types.oauthcredential.md b/docs-exp/auth-types.oauthcredential.md deleted file mode 100644 index 70b4a908c54..00000000000 --- a/docs-exp/auth-types.oauthcredential.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) - -## OAuthCredential class - -Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). - -Signature: - -```typescript -export abstract class OAuthCredential extends AuthCredential -``` -Extends: [AuthCredential](./auth-types.authcredential.md) - -## Remarks - -Implementations specify the details about each auth provider's credential requirements. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as facebook.com, twitter.com, etc. | -| [idToken](./auth-types.oauthcredential.idtoken.md) | | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as google.com. | -| [secret](./auth-types.oauthcredential.secret.md) | | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as twitter.com. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [fromJSON(json)](./auth-types.oauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | - diff --git a/docs-exp/auth-types.oauthcredential.secret.md b/docs-exp/auth-types.oauthcredential.secret.md deleted file mode 100644 index 830e5a8e2d0..00000000000 --- a/docs-exp/auth-types.oauthcredential.secret.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [secret](./auth-types.oauthcredential.secret.md) - -## OAuthCredential.secret property - -The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as `twitter.com`. - -Signature: - -```typescript -readonly secret?: string; -``` diff --git a/docs-exp/auth-types.operationtype.md b/docs-exp/auth-types.operationtype.md deleted file mode 100644 index 94bc09443a2..00000000000 --- a/docs-exp/auth-types.operationtype.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OperationType](./auth-types.operationtype.md) - -## OperationType enum - -Enumeration of supported operation types. - -Signature: - -```typescript -export const enum OperationType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| LINK | 'link' | Operation involving linking an additional provider to an already signed-in user. | -| REAUTHENTICATE | 'reauthenticate' | Operation involving using a provider to reauthenticate an already signed-in user. | -| SIGN\_IN | 'signIn' | Operation involving signing in a user. | - diff --git a/docs-exp/auth-types.parsedtoken.auth_time.md b/docs-exp/auth-types.parsedtoken.auth_time.md deleted file mode 100644 index 5be5afa1fcb..00000000000 --- a/docs-exp/auth-types.parsedtoken.auth_time.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [auth\_time](./auth-types.parsedtoken.auth_time.md) - -## ParsedToken.auth\_time property - -Time at which authentication was performed. - -Signature: - -```typescript -'auth_time'?: string; -``` diff --git a/docs-exp/auth-types.parsedtoken.exp.md b/docs-exp/auth-types.parsedtoken.exp.md deleted file mode 100644 index 1526e1198ad..00000000000 --- a/docs-exp/auth-types.parsedtoken.exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [exp](./auth-types.parsedtoken.exp.md) - -## ParsedToken.exp property - -Expiration time of the token. - -Signature: - -```typescript -'exp'?: string; -``` diff --git a/docs-exp/auth-types.parsedtoken.firebase.md b/docs-exp/auth-types.parsedtoken.firebase.md deleted file mode 100644 index 189d10ba64e..00000000000 --- a/docs-exp/auth-types.parsedtoken.firebase.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [firebase](./auth-types.parsedtoken.firebase.md) - -## ParsedToken.firebase property - -Firebase specific claims, containing the provider(s) used to authenticate the user. - -Signature: - -```typescript -'firebase'?: { - 'sign_in_provider'?: string; - 'sign_in_second_factor'?: string; - }; -``` diff --git a/docs-exp/auth-types.parsedtoken.iat.md b/docs-exp/auth-types.parsedtoken.iat.md deleted file mode 100644 index c480bacc989..00000000000 --- a/docs-exp/auth-types.parsedtoken.iat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [iat](./auth-types.parsedtoken.iat.md) - -## ParsedToken.iat property - -Issuance time of the token. - -Signature: - -```typescript -'iat'?: string; -``` diff --git a/docs-exp/auth-types.parsedtoken.md b/docs-exp/auth-types.parsedtoken.md deleted file mode 100644 index 5e12f27b315..00000000000 --- a/docs-exp/auth-types.parsedtoken.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) - -## ParsedToken interface - -Interface representing a parsed ID token. - -Signature: - -```typescript -export interface ParsedToken -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [auth\_time](./auth-types.parsedtoken.auth_time.md) | string | Time at which authentication was performed. | -| [exp](./auth-types.parsedtoken.exp.md) | string | Expiration time of the token. | -| [firebase](./auth-types.parsedtoken.firebase.md) | { 'sign\_in\_provider'?: string; 'sign\_in\_second\_factor'?: string; } | Firebase specific claims, containing the provider(s) used to authenticate the user. | -| [iat](./auth-types.parsedtoken.iat.md) | string | Issuance time of the token. | -| [sub](./auth-types.parsedtoken.sub.md) | string | UID of the user. | - diff --git a/docs-exp/auth-types.parsedtoken.sub.md b/docs-exp/auth-types.parsedtoken.sub.md deleted file mode 100644 index 262a05c5d4c..00000000000 --- a/docs-exp/auth-types.parsedtoken.sub.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [sub](./auth-types.parsedtoken.sub.md) - -## ParsedToken.sub property - -UID of the user. - -Signature: - -```typescript -'sub'?: string; -``` diff --git a/docs-exp/auth-types.persistence.md b/docs-exp/auth-types.persistence.md deleted file mode 100644 index fec7826628d..00000000000 --- a/docs-exp/auth-types.persistence.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Persistence](./auth-types.persistence.md) - -## Persistence interface - -An interface covering the possible persistence mechanism types. - -Signature: - -```typescript -export interface Persistence -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | Type of Persistence. - 'SESSION' is used for temporary persistence such as sessionStorage. - 'LOCAL' is used for long term persistence such as localStorage or IndexedDB. - 'NONE' is used for in-memory, or no persistence. | - diff --git a/docs-exp/auth-types.persistence.type.md b/docs-exp/auth-types.persistence.type.md deleted file mode 100644 index 3cc1085d46f..00000000000 --- a/docs-exp/auth-types.persistence.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Persistence](./auth-types.persistence.md) > [type](./auth-types.persistence.type.md) - -## Persistence.type property - -Type of Persistence. - 'SESSION' is used for temporary persistence such as `sessionStorage`. - 'LOCAL' is used for long term persistence such as `localStorage` or `IndexedDB`. - 'NONE' is used for in-memory, or no persistence. - -Signature: - -```typescript -readonly type: 'SESSION' | 'LOCAL' | 'NONE'; -``` diff --git a/docs-exp/auth-types.phoneauthcredential.fromjson.md b/docs-exp/auth-types.phoneauthcredential.fromjson.md deleted file mode 100644 index fd42af97868..00000000000 --- a/docs-exp/auth-types.phoneauthcredential.fromjson.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) > [fromJSON](./auth-types.phoneauthcredential.fromjson.md) - -## PhoneAuthCredential.fromJSON() method - -Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). - -Signature: - -```typescript -static fromJSON(json: object | string): PhoneAuthCredential | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | - -Returns: - -[PhoneAuthCredential](./auth-types.phoneauthcredential.md) \| null - -If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. - diff --git a/docs-exp/auth-types.phoneauthcredential.md b/docs-exp/auth-types.phoneauthcredential.md deleted file mode 100644 index d7e4f42f556..00000000000 --- a/docs-exp/auth-types.phoneauthcredential.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) - -## PhoneAuthCredential class - -Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). - -Signature: - -```typescript -export abstract class PhoneAuthCredential extends AuthCredential -``` -Extends: [AuthCredential](./auth-types.authcredential.md) - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [fromJSON(json)](./auth-types.phoneauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | -| [toJSON()](./auth-types.phoneauthcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | - diff --git a/docs-exp/auth-types.phoneauthcredential.tojson.md b/docs-exp/auth-types.phoneauthcredential.tojson.md deleted file mode 100644 index 7b457ea9b80..00000000000 --- a/docs-exp/auth-types.phoneauthcredential.tojson.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) > [toJSON](./auth-types.phoneauthcredential.tojson.md) - -## PhoneAuthCredential.toJSON() method - -Returns a JSON-serializable representation of this object. - -Signature: - -```typescript -toJSON(): object; -``` -Returns: - -object - -a JSON-serializable representation of this object. - diff --git a/docs-exp/auth-types.phoneauthprovider._constructor_.md b/docs-exp/auth-types.phoneauthprovider._constructor_.md deleted file mode 100644 index 5f572453c30..00000000000 --- a/docs-exp/auth-types.phoneauthprovider._constructor_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [(constructor)](./auth-types.phoneauthprovider._constructor_.md) - -## PhoneAuthProvider.(constructor) - -Constructs a new instance of the `PhoneAuthProvider` class - -Signature: - -```typescript -constructor(auth?: Auth | null); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | [Auth](./auth-types.auth.md) \| null | The Firebase Auth instance in which sign-ins should occur. | - -## Remarks - -Uses the default Auth instance if unspecified. - diff --git a/docs-exp/auth-types.phoneauthprovider.credential.md b/docs-exp/auth-types.phoneauthprovider.credential.md deleted file mode 100644 index 572ff97605b..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.credential.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [credential](./auth-types.phoneauthprovider.credential.md) - -## PhoneAuthProvider.credential() method - -Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. - -Signature: - -```typescript -static credential( - verificationId: string, - verificationCode: string - ): AuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| verificationId | string | The verification ID returned from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md). | -| verificationCode | string | The verification code sent to the user's mobile device. | - -Returns: - -[AuthCredential](./auth-types.authcredential.md) - -The auth provider credential. - -## Example 1 - - -```javascript -const provider = new PhoneAuthProvider(auth); -const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier); -// Obtain verificationCode from the user. -const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const userCredential = signInWithCredential(auth, authCredential); - -``` - -## Example 2 - -An alternative flow is provided using the `signInWithPhoneNumber` method. - -```javascript -const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); -// Obtain verificationCode from the user. -const userCredential = await confirmationResult.confirm(verificationCode); - -``` - diff --git a/docs-exp/auth-types.phoneauthprovider.md b/docs-exp/auth-types.phoneauthprovider.md deleted file mode 100644 index 0ce8396e19c..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.md +++ /dev/null @@ -1,50 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) - -## PhoneAuthProvider class - -Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). - -Signature: - -```typescript -export class PhoneAuthProvider implements AuthProvider -``` -Implements: [AuthProvider](./auth-types.authprovider.md) - -## Example - - -```javascript -// 'recaptcha-container' is the ID of an element in the DOM. -const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); -const provider = new PhoneAuthProvider(auth); -const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); -// Obtain the verificationCode from the user. -const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const userCredential = await signInWithCredential(auth, phoneCredential); - -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(auth)](./auth-types.phoneauthprovider._constructor_.md) | | Constructs a new instance of the PhoneAuthProvider class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [PHONE\_SIGN\_IN\_METHOD](./auth-types.phoneauthprovider.phone_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). | -| [PROVIDER\_ID](./auth-types.phoneauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | -| [providerId](./auth-types.phoneauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. | -| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | Starts a phone number authentication flow by sending a verification code to the given phone number. | - diff --git a/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md b/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md deleted file mode 100644 index b3f8a844518..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [PHONE\_SIGN\_IN\_METHOD](./auth-types.phoneauthprovider.phone_sign_in_method.md) - -## PhoneAuthProvider.PHONE\_SIGN\_IN\_METHOD property - -Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). - -Signature: - -```typescript -static readonly PHONE_SIGN_IN_METHOD: SignInMethod; -``` diff --git a/docs-exp/auth-types.phoneauthprovider.provider_id.md b/docs-exp/auth-types.phoneauthprovider.provider_id.md deleted file mode 100644 index 2e767a1dcc1..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.provider_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [PROVIDER\_ID](./auth-types.phoneauthprovider.provider_id.md) - -## PhoneAuthProvider.PROVIDER\_ID property - -Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). - -Signature: - -```typescript -static readonly PROVIDER_ID: ProviderId; -``` diff --git a/docs-exp/auth-types.phoneauthprovider.providerid.md b/docs-exp/auth-types.phoneauthprovider.providerid.md deleted file mode 100644 index 87fee5e4e1b..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [providerId](./auth-types.phoneauthprovider.providerid.md) - -## PhoneAuthProvider.providerId property - -Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). - -Signature: - -```typescript -readonly providerId: ProviderId; -``` diff --git a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md deleted file mode 100644 index 2bbf0155d30..00000000000 --- a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [verifyPhoneNumber](./auth-types.phoneauthprovider.verifyphonenumber.md) - -## PhoneAuthProvider.verifyPhoneNumber() method - -Starts a phone number authentication flow by sending a verification code to the given phone number. - -Signature: - -```typescript -verifyPhoneNumber( - phoneInfoOptions: PhoneInfoOptions | string, - applicationVerifier: ApplicationVerifier - ): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| phoneInfoOptions | [PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | The user's [PhoneInfoOptions](./auth-types.phoneinfooptions.md). The phone number should be in E.164 format (e.g. +16505550101). | -| applicationVerifier | [ApplicationVerifier](./auth-types.applicationverifier.md) | For abuse prevention, this method also requires a [ApplicationVerifier](./auth-types.applicationverifier.md). This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth-types.recaptchaverifier.md). | - -Returns: - -Promise<string> - -A Promise for a verification ID that can be passed to [PhoneAuthProvider.credential()](./auth.phoneauthprovider.credential.md) to identify this flow.. - -## Example 1 - - -```javascript -const provider = new PhoneAuthProvider(auth); -const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier); -// Obtain verificationCode from the user. -const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); -const userCredential = await signInWithCredential(auth, authCredential); - -``` - -## Example 2 - -An alternative flow is provided using the `signInWithPhoneNumber` method. - -```javascript -const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); -// Obtain verificationCode from the user. -const userCredential = confirmationResult.confirm(verificationCode); - -``` - diff --git a/docs-exp/auth-types.phoneinfooptions.md b/docs-exp/auth-types.phoneinfooptions.md deleted file mode 100644 index 43558a22866..00000000000 --- a/docs-exp/auth-types.phoneinfooptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneInfoOptions](./auth-types.phoneinfooptions.md) - -## PhoneInfoOptions type - -The information required to verify the ownership of a phone number. - -Signature: - -```typescript -export type PhoneInfoOptions = - | PhoneSingleFactorInfoOptions - | PhoneMultiFactorEnrollInfoOptions - | PhoneMultiFactorSignInInfoOptions; -``` -References: [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md), [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md), [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) - -## Remarks - -The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. - diff --git a/docs-exp/auth-types.phonemultifactorassertion.md b/docs-exp/auth-types.phonemultifactorassertion.md deleted file mode 100644 index 57ae9731875..00000000000 --- a/docs-exp/auth-types.phonemultifactorassertion.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) - -## PhoneMultiFactorAssertion interface - -The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md). - -Signature: - -```typescript -export interface PhoneMultiFactorAssertion extends MultiFactorAssertion -``` -Extends: [MultiFactorAssertion](./auth-types.multifactorassertion.md) - diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.md deleted file mode 100644 index 75d8fe0a63f..00000000000 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) - -## PhoneMultiFactorEnrollInfoOptions interface - -Options used for enrolling a second factor. - -Signature: - -```typescript -export interface PhoneMultiFactorEnrollInfoOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) | string | Phone number to send a verification code to. | -| [session](./auth-types.phonemultifactorenrollinfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorUser.getSession()](./auth-types.multifactoruser.getsession.md). | - diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md deleted file mode 100644 index 79b6353dd74..00000000000 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) > [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) - -## PhoneMultiFactorEnrollInfoOptions.phoneNumber property - -Phone number to send a verification code to. - -Signature: - -```typescript -phoneNumber: string; -``` diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md deleted file mode 100644 index 12ffa79b846..00000000000 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) > [session](./auth-types.phonemultifactorenrollinfooptions.session.md) - -## PhoneMultiFactorEnrollInfoOptions.session property - -The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorUser.getSession()](./auth-types.multifactoruser.getsession.md). - -Signature: - -```typescript -session: MultiFactorSession; -``` diff --git a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md deleted file mode 100644 index bb0b8715d95..00000000000 --- a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) > [assertion](./auth-types.phonemultifactorgenerator.assertion.md) - -## PhoneMultiFactorGenerator.assertion() method - -Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. - -Signature: - -```typescript -static assertion( - phoneAuthCredential: PhoneAuthCredential - ): PhoneMultiFactorAssertion; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | A credential provided by [PhoneAuthProvider.credential()](./auth.phoneauthprovider.credential.md). | - -Returns: - -[PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) - -A [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) which can be used with [MultiFactorResolver.resolveSignIn()](./auth-types.multifactorresolver.resolvesignin.md) - diff --git a/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md b/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md deleted file mode 100644 index f95635dc72a..00000000000 --- a/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) > [FACTOR\_ID](./auth-types.phonemultifactorgenerator.factor_id.md) - -## PhoneMultiFactorGenerator.FACTOR\_ID property - -The identifier of the phone second factor: [ProviderId.PHONE](./auth-types.providerid.phone.md). - -Signature: - -```typescript -static FACTOR_ID: ProviderId; -``` diff --git a/docs-exp/auth-types.phonemultifactorgenerator.md b/docs-exp/auth-types.phonemultifactorgenerator.md deleted file mode 100644 index b1a891467c8..00000000000 --- a/docs-exp/auth-types.phonemultifactorgenerator.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) - -## PhoneMultiFactorGenerator class - -Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). - -Signature: - -```typescript -export abstract class PhoneMultiFactorGenerator -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [FACTOR\_ID](./auth-types.phonemultifactorgenerator.factor_id.md) | static | [ProviderId](./auth-types.providerid.md) | The identifier of the phone second factor: [ProviderId.PHONE](./auth-types.providerid.phone.md). | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [assertion(phoneAuthCredential)](./auth-types.phonemultifactorgenerator.assertion.md) | static | Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. | - diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.md deleted file mode 100644 index b6d627cfd4b..00000000000 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) - -## PhoneMultiFactorSignInInfoOptions interface - -Options used for signing-in with a second factor. - -Signature: - -```typescript -export interface PhoneMultiFactorSignInInfoOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md) | The [MultiFactorInfo](./auth-types.multifactorinfo.md) obtained via [MultiFactorResolver.hints](./auth-types.multifactorresolver.hints.md).One of multiFactorHint or multiFactorUid is required. | -| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | The uid of the second factor.One of multiFactorHint or multiFactorUid is required. | -| [session](./auth-types.phonemultifactorsignininfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorResolver.session](./auth-types.multifactorresolver.session.md). | - diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md deleted file mode 100644 index 9224ca91ed4..00000000000 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) - -## PhoneMultiFactorSignInInfoOptions.multiFactorHint property - -The [MultiFactorInfo](./auth-types.multifactorinfo.md) obtained via [MultiFactorResolver.hints](./auth-types.multifactorresolver.hints.md). - -One of `multiFactorHint` or `multiFactorUid` is required. - -Signature: - -```typescript -multiFactorHint?: MultiFactorInfo; -``` diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md deleted file mode 100644 index 690d97a442d..00000000000 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) - -## PhoneMultiFactorSignInInfoOptions.multiFactorUid property - -The uid of the second factor. - -One of `multiFactorHint` or `multiFactorUid` is required. - -Signature: - -```typescript -multiFactorUid?: string; -``` diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md deleted file mode 100644 index 4d30851de0b..00000000000 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [session](./auth-types.phonemultifactorsignininfooptions.session.md) - -## PhoneMultiFactorSignInInfoOptions.session property - -The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorResolver.session](./auth-types.multifactorresolver.session.md). - -Signature: - -```typescript -session: MultiFactorSession; -``` diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.md b/docs-exp/auth-types.phonesinglefactorinfooptions.md deleted file mode 100644 index fc4612d2d74..00000000000 --- a/docs-exp/auth-types.phonesinglefactorinfooptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) - -## PhoneSingleFactorInfoOptions interface - -Options used for single-factor sign-in. - -Signature: - -```typescript -export interface PhoneSingleFactorInfoOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) | string | Phone number to send a verification code to. | - diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md b/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md deleted file mode 100644 index a7fb6242833..00000000000 --- a/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) > [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) - -## PhoneSingleFactorInfoOptions.phoneNumber property - -Phone number to send a verification code to. - -Signature: - -```typescript -phoneNumber: string; -``` diff --git a/docs-exp/auth-types.popupredirectresolver.md b/docs-exp/auth-types.popupredirectresolver.md deleted file mode 100644 index cf02603d8a5..00000000000 --- a/docs-exp/auth-types.popupredirectresolver.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PopupRedirectResolver](./auth-types.popupredirectresolver.md) - -## PopupRedirectResolver interface - -A resolver used for handling DOM specific operations like [signInWithPopup()](./auth.signinwithpopup.md) or [signInWithRedirect()](./auth.signinwithredirect.md). - -Signature: - -```typescript -export interface PopupRedirectResolver -``` diff --git a/docs-exp/auth-types.providerid.md b/docs-exp/auth-types.providerid.md deleted file mode 100644 index 4119aadd9de..00000000000 --- a/docs-exp/auth-types.providerid.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ProviderId](./auth-types.providerid.md) - -## ProviderId enum - -Enumeration of supported providers. - -Signature: - -```typescript -export const enum ProviderId -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ANONYMOUS | 'anonymous' | | -| CUSTOM | 'custom' | | -| FACEBOOK | 'facebook.com' | | -| FIREBASE | 'firebase' | | -| GITHUB | 'github.com' | | -| GOOGLE | 'google.com' | | -| PASSWORD | 'password' | | -| PHONE | 'phone' | | -| TWITTER | 'twitter.com' | | - diff --git a/docs-exp/auth-types.reactnativeasyncstorage.getitem.md b/docs-exp/auth-types.reactnativeasyncstorage.getitem.md deleted file mode 100644 index 6eb2028d14c..00000000000 --- a/docs-exp/auth-types.reactnativeasyncstorage.getitem.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [getItem](./auth-types.reactnativeasyncstorage.getitem.md) - -## ReactNativeAsyncStorage.getItem() method - -Retrieve an item from storage. - -Signature: - -```typescript -getItem(key: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | storage key. | - -Returns: - -Promise<string \| null> - diff --git a/docs-exp/auth-types.reactnativeasyncstorage.md b/docs-exp/auth-types.reactnativeasyncstorage.md deleted file mode 100644 index 5393b3910b5..00000000000 --- a/docs-exp/auth-types.reactnativeasyncstorage.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) - -## ReactNativeAsyncStorage interface - -Interface for a supplied AsyncStorage. - -Signature: - -```typescript -export interface ReactNativeAsyncStorage -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getItem(key)](./auth-types.reactnativeasyncstorage.getitem.md) | Retrieve an item from storage. | -| [removeItem(key)](./auth-types.reactnativeasyncstorage.removeitem.md) | Remove an item from storage. | -| [setItem(key, value)](./auth-types.reactnativeasyncstorage.setitem.md) | Persist an item in storage. | - diff --git a/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md b/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md deleted file mode 100644 index ddaa392cf9f..00000000000 --- a/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [removeItem](./auth-types.reactnativeasyncstorage.removeitem.md) - -## ReactNativeAsyncStorage.removeItem() method - -Remove an item from storage. - -Signature: - -```typescript -removeItem(key: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | storage key. | - -Returns: - -Promise<void> - diff --git a/docs-exp/auth-types.reactnativeasyncstorage.setitem.md b/docs-exp/auth-types.reactnativeasyncstorage.setitem.md deleted file mode 100644 index d7b228616cd..00000000000 --- a/docs-exp/auth-types.reactnativeasyncstorage.setitem.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [setItem](./auth-types.reactnativeasyncstorage.setitem.md) - -## ReactNativeAsyncStorage.setItem() method - -Persist an item in storage. - -Signature: - -```typescript -setItem(key: string, value: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | storage key. | -| value | string | storage value. | - -Returns: - -Promise<void> - diff --git a/docs-exp/auth-types.recaptchaverifier._constructor_.md b/docs-exp/auth-types.recaptchaverifier._constructor_.md deleted file mode 100644 index d58af83f20a..00000000000 --- a/docs-exp/auth-types.recaptchaverifier._constructor_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [(constructor)](./auth-types.recaptchaverifier._constructor_.md) - -## RecaptchaVerifier.(constructor) - -Constructs a new instance of the `RecaptchaVerifier` class - -Signature: - -```typescript -constructor( - container: any | string, - parameters?: Object | null, - auth?: Auth | null - ); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| container | any \| string | | -| parameters | Object \| null | | -| auth | [Auth](./auth-types.auth.md) \| null | | - diff --git a/docs-exp/auth-types.recaptchaverifier.clear.md b/docs-exp/auth-types.recaptchaverifier.clear.md deleted file mode 100644 index e25d32ae7b5..00000000000 --- a/docs-exp/auth-types.recaptchaverifier.clear.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [clear](./auth-types.recaptchaverifier.clear.md) - -## RecaptchaVerifier.clear() method - -Clears the reCAPTCHA widget from the page and destroys the instance. - -Signature: - -```typescript -clear(): void; -``` -Returns: - -void - diff --git a/docs-exp/auth-types.recaptchaverifier.md b/docs-exp/auth-types.recaptchaverifier.md deleted file mode 100644 index 073a13ff84c..00000000000 --- a/docs-exp/auth-types.recaptchaverifier.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) - -## RecaptchaVerifier class - -An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. - -Signature: - -```typescript -export abstract class RecaptchaVerifier implements ApplicationVerifier -``` -Implements: [ApplicationVerifier](./auth-types.applicationverifier.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(container, parameters, auth)](./auth-types.recaptchaverifier._constructor_.md) | | Constructs a new instance of the RecaptchaVerifier class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./auth-types.recaptchaverifier.type.md) | | string | The application verifier type. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [clear()](./auth-types.recaptchaverifier.clear.md) | | Clears the reCAPTCHA widget from the page and destroys the instance. | -| [render()](./auth-types.recaptchaverifier.render.md) | | Renders the reCAPTCHA widget on the page. | -| [verify()](./auth-types.recaptchaverifier.verify.md) | | Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. | - diff --git a/docs-exp/auth-types.recaptchaverifier.render.md b/docs-exp/auth-types.recaptchaverifier.render.md deleted file mode 100644 index 5cbfa0b6be2..00000000000 --- a/docs-exp/auth-types.recaptchaverifier.render.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [render](./auth-types.recaptchaverifier.render.md) - -## RecaptchaVerifier.render() method - -Renders the reCAPTCHA widget on the page. - -Signature: - -```typescript -render(): Promise; -``` -Returns: - -Promise<number> - -A Promise that resolves with the reCAPTCHA widget ID. - diff --git a/docs-exp/auth-types.recaptchaverifier.type.md b/docs-exp/auth-types.recaptchaverifier.type.md deleted file mode 100644 index 7e56581e6d7..00000000000 --- a/docs-exp/auth-types.recaptchaverifier.type.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [type](./auth-types.recaptchaverifier.type.md) - -## RecaptchaVerifier.type property - -The application verifier type. - -Signature: - -```typescript -readonly type: string; -``` - -## Remarks - -For a reCAPTCHA verifier, this is 'recaptcha'. - diff --git a/docs-exp/auth-types.recaptchaverifier.verify.md b/docs-exp/auth-types.recaptchaverifier.verify.md deleted file mode 100644 index 7977ae388f7..00000000000 --- a/docs-exp/auth-types.recaptchaverifier.verify.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [verify](./auth-types.recaptchaverifier.verify.md) - -## RecaptchaVerifier.verify() method - -Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. - -Signature: - -```typescript -verify(): Promise; -``` -Returns: - -Promise<string> - -A Promise for the reCAPTCHA token. - diff --git a/docs-exp/auth-types.signinmethod.md b/docs-exp/auth-types.signinmethod.md deleted file mode 100644 index a4707f54161..00000000000 --- a/docs-exp/auth-types.signinmethod.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [SignInMethod](./auth-types.signinmethod.md) - -## SignInMethod enum - -Enumeration of supported sign-in methods. - -Signature: - -```typescript -export const enum SignInMethod -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ANONYMOUS | 'anonymous' | | -| EMAIL\_LINK | 'emailLink' | | -| EMAIL\_PASSWORD | 'password' | | -| FACEBOOK | 'facebook.com' | | -| GITHUB | 'github.com' | | -| GOOGLE | 'google.com' | | -| PHONE | 'phone' | | -| TWITTER | 'twitter.com' | | - diff --git a/docs-exp/auth-types.user.delete.md b/docs-exp/auth-types.user.delete.md deleted file mode 100644 index ad5c586cf13..00000000000 --- a/docs-exp/auth-types.user.delete.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [delete](./auth-types.user.delete.md) - -## User.delete() method - -Deletes and signs out the user. - -Signature: - -```typescript -delete(): Promise; -``` -Returns: - -Promise<void> - -## Remarks - -Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like [reauthenticateWithCredential()](./auth.reauthenticatewithcredential.md). - diff --git a/docs-exp/auth-types.user.emailverified.md b/docs-exp/auth-types.user.emailverified.md deleted file mode 100644 index c6499e8f0b4..00000000000 --- a/docs-exp/auth-types.user.emailverified.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [emailVerified](./auth-types.user.emailverified.md) - -## User.emailVerified property - -Whether the email has been verified with [sendEmailVerification()](./auth.sendemailverification.md) and [applyActionCode()](./auth.applyactioncode.md). - -Signature: - -```typescript -readonly emailVerified: boolean; -``` diff --git a/docs-exp/auth-types.user.getidtoken.md b/docs-exp/auth-types.user.getidtoken.md deleted file mode 100644 index e70cad9db9b..00000000000 --- a/docs-exp/auth-types.user.getidtoken.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [getIdToken](./auth-types.user.getidtoken.md) - -## User.getIdToken() method - -Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. - -Signature: - -```typescript -getIdToken(forceRefresh?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| forceRefresh | boolean | Force refresh regardless of token expiration. | - -Returns: - -Promise<string> - -## Remarks - -Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. - diff --git a/docs-exp/auth-types.user.getidtokenresult.md b/docs-exp/auth-types.user.getidtokenresult.md deleted file mode 100644 index 3ea0209cd23..00000000000 --- a/docs-exp/auth-types.user.getidtokenresult.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [getIdTokenResult](./auth-types.user.getidtokenresult.md) - -## User.getIdTokenResult() method - -Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. - -Signature: - -```typescript -getIdTokenResult(forceRefresh?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| forceRefresh | boolean | Force refresh regardless of token expiration. | - -Returns: - -Promise<[IdTokenResult](./auth-types.idtokenresult.md)> - -## Remarks - -Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. - diff --git a/docs-exp/auth-types.user.isanonymous.md b/docs-exp/auth-types.user.isanonymous.md deleted file mode 100644 index 7d5a6700b35..00000000000 --- a/docs-exp/auth-types.user.isanonymous.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [isAnonymous](./auth-types.user.isanonymous.md) - -## User.isAnonymous property - -Whether the user is authenticated using the provider. - -Signature: - -```typescript -readonly isAnonymous: boolean; -``` diff --git a/docs-exp/auth-types.user.md b/docs-exp/auth-types.user.md deleted file mode 100644 index c3a3a8a8546..00000000000 --- a/docs-exp/auth-types.user.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) - -## User interface - -A user account. - -Signature: - -```typescript -export interface User extends UserInfo -``` -Extends: [UserInfo](./auth-types.userinfo.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [emailVerified](./auth-types.user.emailverified.md) | boolean | Whether the email has been verified with [sendEmailVerification()](./auth.sendemailverification.md) and [applyActionCode()](./auth.applyactioncode.md). | -| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | Whether the user is authenticated using the provider. | -| [metadata](./auth-types.user.metadata.md) | [UserMetadata](./auth-types.usermetadata.md) | Additional metadata around user creation and sign-in times. | -| [providerData](./auth-types.user.providerdata.md) | [UserInfo](./auth-types.userinfo.md)\[\] | Additional per provider such as displayName and profile information. | -| [refreshToken](./auth-types.user.refreshtoken.md) | string | Refresh token used to reauthenticate the user. Avoid using this directly and prefer [User.getIdToken()](./auth-types.user.getidtoken.md) to refresh the ID token instead. | -| [tenantId](./auth-types.user.tenantid.md) | string \| null | The user's tenant ID. | - -## Methods - -| Method | Description | -| --- | --- | -| [delete()](./auth-types.user.delete.md) | Deletes and signs out the user. | -| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. | -| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. | -| [reload()](./auth-types.user.reload.md) | Refreshes the user, if signed in. | -| [toJSON()](./auth-types.user.tojson.md) | Returns a JSON-serializable representation of this object. | - diff --git a/docs-exp/auth-types.user.metadata.md b/docs-exp/auth-types.user.metadata.md deleted file mode 100644 index a7829f2fe04..00000000000 --- a/docs-exp/auth-types.user.metadata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [metadata](./auth-types.user.metadata.md) - -## User.metadata property - -Additional metadata around user creation and sign-in times. - -Signature: - -```typescript -readonly metadata: UserMetadata; -``` diff --git a/docs-exp/auth-types.user.providerdata.md b/docs-exp/auth-types.user.providerdata.md deleted file mode 100644 index e0f43210ec2..00000000000 --- a/docs-exp/auth-types.user.providerdata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [providerData](./auth-types.user.providerdata.md) - -## User.providerData property - -Additional per provider such as displayName and profile information. - -Signature: - -```typescript -readonly providerData: UserInfo[]; -``` diff --git a/docs-exp/auth-types.user.refreshtoken.md b/docs-exp/auth-types.user.refreshtoken.md deleted file mode 100644 index 9eca76e15a7..00000000000 --- a/docs-exp/auth-types.user.refreshtoken.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [refreshToken](./auth-types.user.refreshtoken.md) - -## User.refreshToken property - -Refresh token used to reauthenticate the user. Avoid using this directly and prefer [User.getIdToken()](./auth-types.user.getidtoken.md) to refresh the ID token instead. - -Signature: - -```typescript -readonly refreshToken: string; -``` diff --git a/docs-exp/auth-types.user.reload.md b/docs-exp/auth-types.user.reload.md deleted file mode 100644 index 4e231909ae9..00000000000 --- a/docs-exp/auth-types.user.reload.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [reload](./auth-types.user.reload.md) - -## User.reload() method - -Refreshes the user, if signed in. - -Signature: - -```typescript -reload(): Promise; -``` -Returns: - -Promise<void> - diff --git a/docs-exp/auth-types.user.tenantid.md b/docs-exp/auth-types.user.tenantid.md deleted file mode 100644 index 1447a4ca45c..00000000000 --- a/docs-exp/auth-types.user.tenantid.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [tenantId](./auth-types.user.tenantid.md) - -## User.tenantId property - -The user's tenant ID. - -Signature: - -```typescript -readonly tenantId: string | null; -``` - -## Remarks - -This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. - -## Example - - -```javascript -// Set the tenant ID on Auth instance. -auth.tenantId = 'TENANT_PROJECT_ID'; - -// All future sign-in request now include tenant ID. -const result = await signInWithEmailAndPassword(auth, email, password); -// result.user.tenantId should be 'TENANT_PROJECT_ID'. - -``` - diff --git a/docs-exp/auth-types.user.tojson.md b/docs-exp/auth-types.user.tojson.md deleted file mode 100644 index a5ca14bac91..00000000000 --- a/docs-exp/auth-types.user.tojson.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [toJSON](./auth-types.user.tojson.md) - -## User.toJSON() method - -Returns a JSON-serializable representation of this object. - -Signature: - -```typescript -toJSON(): object; -``` -Returns: - -object - -A JSON-serializable representation of this object. - diff --git a/docs-exp/auth-types.usercredential.md b/docs-exp/auth-types.usercredential.md deleted file mode 100644 index b4a56fff151..00000000000 --- a/docs-exp/auth-types.usercredential.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) - -## UserCredential interface - -A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. - -Signature: - -```typescript -export interface UserCredential -``` - -## Remarks - -`operationType` could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [operationType](./auth-types.usercredential.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation which was used to authenticate the user (such as sign-in or link). | -| [providerId](./auth-types.usercredential.providerid.md) | string \| null | The provider which was used to authenticate the user. | -| [user](./auth-types.usercredential.user.md) | [User](./auth-types.user.md) | The user authenticated by this credential. | - diff --git a/docs-exp/auth-types.usercredential.operationtype.md b/docs-exp/auth-types.usercredential.operationtype.md deleted file mode 100644 index a083cd7624f..00000000000 --- a/docs-exp/auth-types.usercredential.operationtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [operationType](./auth-types.usercredential.operationtype.md) - -## UserCredential.operationType property - -The type of operation which was used to authenticate the user (such as sign-in or link). - -Signature: - -```typescript -operationType: OperationType; -``` diff --git a/docs-exp/auth-types.usercredential.providerid.md b/docs-exp/auth-types.usercredential.providerid.md deleted file mode 100644 index 680c109d75e..00000000000 --- a/docs-exp/auth-types.usercredential.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [providerId](./auth-types.usercredential.providerid.md) - -## UserCredential.providerId property - -The provider which was used to authenticate the user. - -Signature: - -```typescript -providerId: string | null; -``` diff --git a/docs-exp/auth-types.usercredential.user.md b/docs-exp/auth-types.usercredential.user.md deleted file mode 100644 index 4e0556e5bb3..00000000000 --- a/docs-exp/auth-types.usercredential.user.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [user](./auth-types.usercredential.user.md) - -## UserCredential.user property - -The user authenticated by this credential. - -Signature: - -```typescript -user: User; -``` diff --git a/docs-exp/auth-types.userinfo.displayname.md b/docs-exp/auth-types.userinfo.displayname.md deleted file mode 100644 index a45ec5c965d..00000000000 --- a/docs-exp/auth-types.userinfo.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [displayName](./auth-types.userinfo.displayname.md) - -## UserInfo.displayName property - -The display name of the user. - -Signature: - -```typescript -readonly displayName: string | null; -``` diff --git a/docs-exp/auth-types.userinfo.email.md b/docs-exp/auth-types.userinfo.email.md deleted file mode 100644 index ad5fdaa4274..00000000000 --- a/docs-exp/auth-types.userinfo.email.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [email](./auth-types.userinfo.email.md) - -## UserInfo.email property - -The email of the user. - -Signature: - -```typescript -readonly email: string | null; -``` diff --git a/docs-exp/auth-types.userinfo.md b/docs-exp/auth-types.userinfo.md deleted file mode 100644 index 27cf7386dd3..00000000000 --- a/docs-exp/auth-types.userinfo.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) - -## UserInfo interface - -User profile information, visible only to the Firebase project's apps. - -Signature: - -```typescript -export interface UserInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./auth-types.userinfo.displayname.md) | string \| null | The display name of the user. | -| [email](./auth-types.userinfo.email.md) | string \| null | The email of the user. | -| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. | -| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | The profile photo URL of the user. | -| [providerId](./auth-types.userinfo.providerid.md) | string | The provider used to authenticate the user. | -| [uid](./auth-types.userinfo.uid.md) | string | The user's unique ID, scoped to the project. | - diff --git a/docs-exp/auth-types.userinfo.phonenumber.md b/docs-exp/auth-types.userinfo.phonenumber.md deleted file mode 100644 index 777a5f22f1b..00000000000 --- a/docs-exp/auth-types.userinfo.phonenumber.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [phoneNumber](./auth-types.userinfo.phonenumber.md) - -## UserInfo.phoneNumber property - -The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. - -Signature: - -```typescript -readonly phoneNumber: string | null; -``` - -## Remarks - -This is null if the user has no phone credential linked to the account. - diff --git a/docs-exp/auth-types.userinfo.photourl.md b/docs-exp/auth-types.userinfo.photourl.md deleted file mode 100644 index 149aaa71ae1..00000000000 --- a/docs-exp/auth-types.userinfo.photourl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [photoURL](./auth-types.userinfo.photourl.md) - -## UserInfo.photoURL property - -The profile photo URL of the user. - -Signature: - -```typescript -readonly photoURL: string | null; -``` diff --git a/docs-exp/auth-types.userinfo.providerid.md b/docs-exp/auth-types.userinfo.providerid.md deleted file mode 100644 index a8d7a633d36..00000000000 --- a/docs-exp/auth-types.userinfo.providerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [providerId](./auth-types.userinfo.providerid.md) - -## UserInfo.providerId property - -The provider used to authenticate the user. - -Signature: - -```typescript -readonly providerId: string; -``` diff --git a/docs-exp/auth-types.userinfo.uid.md b/docs-exp/auth-types.userinfo.uid.md deleted file mode 100644 index 1d6b3e31cf5..00000000000 --- a/docs-exp/auth-types.userinfo.uid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [uid](./auth-types.userinfo.uid.md) - -## UserInfo.uid property - -The user's unique ID, scoped to the project. - -Signature: - -```typescript -readonly uid: string; -``` diff --git a/docs-exp/auth-types.usermetadata.creationtime.md b/docs-exp/auth-types.usermetadata.creationtime.md deleted file mode 100644 index 1a4413c0979..00000000000 --- a/docs-exp/auth-types.usermetadata.creationtime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) > [creationTime](./auth-types.usermetadata.creationtime.md) - -## UserMetadata.creationTime property - -Time the user was created. - -Signature: - -```typescript -readonly creationTime?: string; -``` diff --git a/docs-exp/auth-types.usermetadata.lastsignintime.md b/docs-exp/auth-types.usermetadata.lastsignintime.md deleted file mode 100644 index 501abcb0de9..00000000000 --- a/docs-exp/auth-types.usermetadata.lastsignintime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) > [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) - -## UserMetadata.lastSignInTime property - -Time the user last signed in. - -Signature: - -```typescript -readonly lastSignInTime?: string; -``` diff --git a/docs-exp/auth-types.usermetadata.md b/docs-exp/auth-types.usermetadata.md deleted file mode 100644 index 1015735260e..00000000000 --- a/docs-exp/auth-types.usermetadata.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) - -## UserMetadata interface - -Interface representing a user's metadata. - -Signature: - -```typescript -export interface UserMetadata -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [creationTime](./auth-types.usermetadata.creationtime.md) | string | Time the user was created. | -| [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) | string | Time the user last signed in. | - diff --git a/docs-exp/auth-types.userprofile.md b/docs-exp/auth-types.userprofile.md deleted file mode 100644 index 6dbb9562406..00000000000 --- a/docs-exp/auth-types.userprofile.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserProfile](./auth-types.userprofile.md) - -## UserProfile type - -User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md). - -Signature: - -```typescript -export type UserProfile = Record; -``` diff --git a/docs-exp/auth.getauth.md b/docs-exp/auth.getauth.md index 11db2053e5d..ae80e78ac8d 100644 --- a/docs-exp/auth.getauth.md +++ b/docs-exp/auth.getauth.md @@ -9,7 +9,7 @@ Initializes an Auth instance with platform specific default dependencies. Signature: ```typescript -export declare function getAuth(app: FirebaseApp): Auth; +export declare function getAuth(app?: FirebaseApp): Auth; ``` ## Parameters diff --git a/docs-exp/auth.phoneauthcredential.fromjson.md b/docs-exp/auth.phoneauthcredential.fromjson.md index 4615426d59d..f08184cdab3 100644 --- a/docs-exp/auth.phoneauthcredential.fromjson.md +++ b/docs-exp/auth.phoneauthcredential.fromjson.md @@ -4,6 +4,7 @@ ## PhoneAuthCredential.fromJSON() method +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth.authcredential.md). Signature: @@ -15,9 +16,11 @@ static fromJSON(json: object | string): PhoneAuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | object \| string | | +| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [PhoneAuthCredential](./auth.phoneauthcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth.authcredential.md), null is returned. + diff --git a/docs-exp/auth.phoneauthcredential.md b/docs-exp/auth.phoneauthcredential.md index 26746ebc62d..afddcb6f27f 100644 --- a/docs-exp/auth.phoneauthcredential.md +++ b/docs-exp/auth.phoneauthcredential.md @@ -17,6 +17,6 @@ export declare class PhoneAuthCredential extends AuthCredential | Method | Modifiers | Description | | --- | --- | --- | -| [fromJSON(json)](./auth.phoneauthcredential.fromjson.md) | static | | +| [fromJSON(json)](./auth.phoneauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth.authcredential.md). | | [toJSON()](./auth.phoneauthcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth.sendsigninlinktoemail.md b/docs-exp/auth.sendsigninlinktoemail.md index 8cdcbf10881..aedcac4c45f 100644 --- a/docs-exp/auth.sendsigninlinktoemail.md +++ b/docs-exp/auth.sendsigninlinktoemail.md @@ -9,7 +9,7 @@ Sends a sign-in email link to the user with the specified email. Signature: ```typescript -export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise; +export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise; ``` ## Parameters diff --git a/docs-exp/firestore_.arrayunion.md b/docs-exp/firestore_.arrayunion.md index d2741f3abe4..c6d82fa4552 100644 --- a/docs-exp/firestore_.arrayunion.md +++ b/docs-exp/firestore_.arrayunion.md @@ -4,7 +4,7 @@ ## arrayUnion() function -Returns a special value that can be used with or that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. +Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. Signature: diff --git a/docs-exp/firestore_.deletefield.md b/docs-exp/firestore_.deletefield.md index c0f9523ddf5..e67aaff600d 100644 --- a/docs-exp/firestore_.deletefield.md +++ b/docs-exp/firestore_.deletefield.md @@ -4,7 +4,7 @@ ## deleteField() function -Returns a sentinel for use with or with `{merge: true}` to mark a field for deletion. +Returns a sentinel for use with [updateDoc()](./firestore_lite.updatedoc.md) or [setDoc()](./firestore_lite.setdoc.md) with `{merge: true}` to mark a field for deletion. Signature: diff --git a/docs-exp/firestore_.documentdata.md b/docs-exp/firestore_.documentdata.md index d8ee2bf7b16..1f4c5b3354e 100644 --- a/docs-exp/firestore_.documentdata.md +++ b/docs-exp/firestore_.documentdata.md @@ -4,7 +4,7 @@ ## DocumentData interface -Document data (for use with ) consists of fields mapped to values. +Document data (for use with [setDoc()](./firestore_lite.setdoc.md)) consists of fields mapped to values. Signature: diff --git a/docs-exp/firestore_.documentreference.md b/docs-exp/firestore_.documentreference.md index 2c4f52604a3..e499b76272e 100644 --- a/docs-exp/firestore_.documentreference.md +++ b/docs-exp/firestore_.documentreference.md @@ -26,6 +26,6 @@ export declare class DocumentReference | Method | Modifiers | Description | | --- | --- | --- | -| [withConverter(converter)](./firestore_.documentreference.withconverter.md) | | Applies a custom data converter to this DocumentReference, allowing you to use your own custom model objects with Firestore. When you call , [getDoc()](./firestore_.getdoc.md), etc. with the returned DocumentReference instance, the provided converter will convert between Firestore data and your custom type U.Passing in null as the converter parameter removes the current converter. | +| [withConverter(converter)](./firestore_.documentreference.withconverter.md) | | Applies a custom data converter to this DocumentReference, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.setdoc.md), [getDoc()](./firestore_lite.getdoc.md), etc. with the returned DocumentReference instance, the provided converter will convert between Firestore data and your custom type U.Passing in null as the converter parameter removes the current converter. | | [withConverter(converter)](./firestore_.documentreference.withconverter_1.md) | | | diff --git a/docs-exp/firestore_.documentreference.withconverter.md b/docs-exp/firestore_.documentreference.withconverter.md index 2d565717f3c..1c5d4dc97b7 100644 --- a/docs-exp/firestore_.documentreference.withconverter.md +++ b/docs-exp/firestore_.documentreference.withconverter.md @@ -4,7 +4,7 @@ ## DocumentReference.withConverter() method -Applies a custom data converter to this `DocumentReference`, allowing you to use your own custom model objects with Firestore. When you call , [getDoc()](./firestore_.getdoc.md), etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data and your custom type `U`. +Applies a custom data converter to this `DocumentReference`, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.setdoc.md), [getDoc()](./firestore_lite.getdoc.md), etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data and your custom type `U`. Passing in `null` as the converter parameter removes the current converter. diff --git a/docs-exp/firestore_.firestoredataconverter.md b/docs-exp/firestore_.firestoredataconverter.md index 2b270868d34..290184f5b99 100644 --- a/docs-exp/firestore_.firestoredataconverter.md +++ b/docs-exp/firestore_.firestoredataconverter.md @@ -58,5 +58,5 @@ if (post !== undefined) { | --- | --- | | [fromFirestore(snapshot, options)](./firestore_.firestoredataconverter.fromfirestore.md) | Called by the Firestore SDK to convert Firestore data into an object of type T. You can access your data by calling: snapshot.data(options). | | [toFirestore(modelObject)](./firestore_.firestoredataconverter.tofirestore.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain JavaScript object (suitable for writing directly to the Firestore database). To use set() with merge and mergeFields, toFirestore() must be defined with Partial<T>. | -| [toFirestore(modelObject, options)](./firestore_.firestoredataconverter.tofirestore_1.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain JavaScript object (suitable for writing directly to the Firestore database). Used with , and with merge:true or mergeFields. | +| [toFirestore(modelObject, options)](./firestore_.firestoredataconverter.tofirestore_1.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain JavaScript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_.setdoc.md), and with merge:true or mergeFields. | diff --git a/docs-exp/firestore_.firestoredataconverter.tofirestore_1.md b/docs-exp/firestore_.firestoredataconverter.tofirestore_1.md index d4085afbf36..37f471ff472 100644 --- a/docs-exp/firestore_.firestoredataconverter.tofirestore_1.md +++ b/docs-exp/firestore_.firestoredataconverter.tofirestore_1.md @@ -4,7 +4,7 @@ ## FirestoreDataConverter.toFirestore() method -Called by the Firestore SDK to convert a custom model object of type `T` into a plain JavaScript object (suitable for writing directly to the Firestore database). Used with , and with `merge:true` or `mergeFields`. +Called by the Firestore SDK to convert a custom model object of type `T` into a plain JavaScript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_.setdoc.md), and with `merge:true` or `mergeFields`. Signature: diff --git a/docs-exp/firestore_.getfirestore.md b/docs-exp/firestore_.getfirestore.md index f564a9945f8..2eaf8176b8e 100644 --- a/docs-exp/firestore_.getfirestore.md +++ b/docs-exp/firestore_.getfirestore.md @@ -4,19 +4,19 @@ ## getFirestore() function -Returns the existing instance of Firestore that is associated with the provided . If no instance exists, initializes a new instance with default settings. +Returns the existing instance of Firestore that is associated with the provided [FirebaseApp](./app.firebaseapp.md). If no instance exists, initializes a new instance with default settings. Signature: ```typescript -export declare function getFirestore(app: FirebaseApp): FirebaseFirestore; +export declare function getFirestore(app?: FirebaseApp): FirebaseFirestore; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| app | [FirebaseApp](./app.firebaseapp.md) | The instance that the returned Firestore instance is associated with. | +| app | [FirebaseApp](./app.firebaseapp.md) | The [FirebaseApp](./app.firebaseapp.md) instance that the returned Firestore instance is associated with. | Returns: diff --git a/docs-exp/firestore_.increment.md b/docs-exp/firestore_.increment.md index dd08c464080..508e89f0e39 100644 --- a/docs-exp/firestore_.increment.md +++ b/docs-exp/firestore_.increment.md @@ -4,7 +4,7 @@ ## increment() function -Returns a special value that can be used with or that tells the server to increment the field's current value by the given value. +Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to increment the field's current value by the given value. If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1. diff --git a/docs-exp/firestore_.initializefirestore.md b/docs-exp/firestore_.initializefirestore.md index bf7496ee1dc..b2b6d12dbf7 100644 --- a/docs-exp/firestore_.initializefirestore.md +++ b/docs-exp/firestore_.initializefirestore.md @@ -16,7 +16,7 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Settings | Parameter | Type | Description | | --- | --- | --- | -| app | [FirebaseApp](./app.firebaseapp.md) | The with which the Firestore instance will be associated. | +| app | [FirebaseApp](./app.firebaseapp.md) | The [FirebaseApp](./app.firebaseapp.md) with which the Firestore instance will be associated. | | settings | [Settings](./firestore_.settings.md) | A settings object to configure the Firestore instance. | Returns: diff --git a/docs-exp/firestore_.loadbundle.md b/docs-exp/firestore_.loadbundle.md index eabbaf77366..51c94014025 100644 --- a/docs-exp/firestore_.loadbundle.md +++ b/docs-exp/firestore_.loadbundle.md @@ -17,9 +17,11 @@ export declare function loadBundle(firestore: FirebaseFirestore, bundleData: Rea | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | The Firestore instance to load bundles for for. | -| bundleData | ReadableStream<Uint8Array> \| ArrayBuffer \| string | An object representing the bundle to be loaded. Valid objects are ArrayBuffer, ReadableStream<Uint8Array> or string. A LoadBundleTask object, which notifies callers with progress updates, and completion or error events. It can be used as a Promise<LoadBundleTaskProgress>. | +| bundleData | ReadableStream<Uint8Array> \| ArrayBuffer \| string | An object representing the bundle to be loaded. Valid objects are ArrayBuffer, ReadableStream<Uint8Array> or string. | Returns: [LoadBundleTask](./firestore_.loadbundletask.md) +A `LoadBundleTask` object, which notifies callers with progress updates, and completion or error events. It can be used as a `Promise`. + diff --git a/docs-exp/firestore_.md b/docs-exp/firestore_.md index 116355035df..584319060aa 100644 --- a/docs-exp/firestore_.md +++ b/docs-exp/firestore_.md @@ -19,13 +19,13 @@ | [GeoPoint](./firestore_.geopoint.md) | An immutable object representing a geographic location in Firestore. The location is represented as latitude/longitude pair.Latitude values are in the range of \[-90, 90\]. Longitude values are in the range of \[-180, 180\]. | | [LoadBundleTask](./firestore_.loadbundletask.md) | Represents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.The API is compatible with Promise<LoadBundleTaskProgress>. | | [Query](./firestore_.query.md) | A Query refers to a Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering. | -| [QueryConstraint](./firestore_.queryconstraint.md) | A QueryConstraint is used to narrow the set of documents returned by a Firestore query. QueryConstraints are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), , , , , [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this QueryConstraint. | +| [QueryConstraint](./firestore_.queryconstraint.md) | A QueryConstraint is used to narrow the set of documents returned by a Firestore query. QueryConstraints are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), [startAt()](./firestore_.startat.md), [startAfter()](./firestore_.startafter.md), , [endAt()](./firestore_.endat.md), [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this QueryConstraint. | | [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md) | A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with .data() or .get(<field>) to get a specific field.A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot. Since query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'. | | [QuerySnapshot](./firestore_.querysnapshot.md) | A QuerySnapshot contains zero or more DocumentSnapshot objects representing the results of a query. The documents can be accessed as an array via the docs property or enumerated using the forEach method. The number of documents can be determined via the empty and size properties. | | [SnapshotMetadata](./firestore_.snapshotmetadata.md) | Metadata about a snapshot, describing the state of the snapshot. | | [Timestamp](./firestore_.timestamp.md) | A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.For examples and further specifications, refer to the [Timestamp definition](https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto). | | [Transaction](./firestore_.transaction.md) | A reference to a transaction.The Transaction object passed to a transaction's updateFunction provides the methods to read and write data within the transaction context. See [runTransaction()](./firestore_.runtransaction.md). | -| [WriteBatch](./firestore_.writebatch.md) | A write batch, used to perform multiple writes as a single atomic unit.A WriteBatch object can be acquired by calling [writeBatch()](./firestore_.writebatch.md). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until is called. | +| [WriteBatch](./firestore_.writebatch.md) | A write batch, used to perform multiple writes as a single atomic unit.A WriteBatch object can be acquired by calling [writeBatch()](./firestore_.writebatch.md). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until [WriteBatch.commit()](./firestore_.writebatch.commit.md) is called. | ## Functions @@ -33,14 +33,14 @@ | --- | --- | | [addDoc(reference, data)](./firestore_.adddoc.md) | Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically. | | [arrayRemove(elements)](./firestore_.arrayremove.md) | Returns a special value that can be used with [setDoc()](./firestore_.setdoc.md) or that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array. | -| [arrayUnion(elements)](./firestore_.arrayunion.md) | Returns a special value that can be used with or that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. | +| [arrayUnion(elements)](./firestore_.arrayunion.md) | Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. | | [clearIndexedDbPersistence(firestore)](./firestore_.clearindexeddbpersistence.md) | Clears the persistent storage. This includes pending writes and cached documents.Must be called while the Firestore instance is not started (after the app is terminated or when the app is first initialized). On startup, this function must be called before other functions (other than [initializeFirestore()](./firestore_.initializefirestore.md) or [getFirestore()](./firestore_.getfirestore.md))). If the Firestore instance is still running, the promise will be rejected with the error code of failed-precondition.Note: clearIndexedDbPersistence() is primarily intended to help write reliable tests that use Cloud Firestore. It uses an efficient mechanism for dropping existing data but does not attempt to securely overwrite or otherwise make cached data unrecoverable. For applications that are sensitive to the disclosure of cached data in between user sessions, we strongly recommend not enabling persistence at all. | | [collection(firestore, path, pathSegments)](./firestore_.collection.md) | Gets a CollectionReference instance that refers to the collection at the specified absolute path. | | [collection(reference, path, pathSegments)](./firestore_.collection_1.md) | Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path. | | [collection(reference, path, pathSegments)](./firestore_.collection_2.md) | Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path. | | [collectionGroup(firestore, collectionId)](./firestore_.collectiongroup.md) | Creates and returns a new Query instance that includes all documents in the database that are contained in a collection or subcollection with the given collectionId. | | [deleteDoc(reference)](./firestore_.deletedoc.md) | Deletes the document referred to by the specified DocumentReference. | -| [deleteField()](./firestore_.deletefield.md) | Returns a sentinel for use with or with {merge: true} to mark a field for deletion. | +| [deleteField()](./firestore_.deletefield.md) | Returns a sentinel for use with [updateDoc()](./firestore_lite.updatedoc.md) or [setDoc()](./firestore_lite.setdoc.md) with {merge: true} to mark a field for deletion. | | [disableNetwork(firestore)](./firestore_.disablenetwork.md) | Disables network usage for this instance. It can be re-enabled via [enableNetwork()](./firestore_.enablenetwork.md). While the network is disabled, any snapshot listeners, getDoc() or getDocs() calls will return results from cache, and any write operations will be queued until the network is restored. | | [doc(firestore, path, pathSegments)](./firestore_.doc.md) | Gets a DocumentReference instance that refers to the document at the specified abosulute path. | | [doc(reference, path, pathSegments)](./firestore_.doc_1.md) | Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference. | @@ -59,8 +59,8 @@ | [getDocs(query)](./firestore_.getdocs.md) | Executes the query and returns the results as a QuerySnapshot.Note: getDocs() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return cached data or fail if you are offline and the server cannot be reached. To specify this behavior, invoke [getDocsFromCache()](./firestore_.getdocsfromcache.md) or [getDocsFromServer()](./firestore_.getdocsfromserver.md). | | [getDocsFromCache(query)](./firestore_.getdocsfromcache.md) | Executes the query and returns the results as a QuerySnapshot from cache. Returns an error if the document is not currently cached. | | [getDocsFromServer(query)](./firestore_.getdocsfromserver.md) | Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available. | -| [getFirestore(app)](./firestore_.getfirestore.md) | Returns the existing instance of Firestore that is associated with the provided . If no instance exists, initializes a new instance with default settings. | -| [increment(n)](./firestore_.increment.md) | Returns a special value that can be used with or that tells the server to increment the field's current value by the given value.If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.If the current field value is not of type number, or if the field does not yet exist, the transformation sets the field to the given value. | +| [getFirestore(app)](./firestore_.getfirestore.md) | Returns the existing instance of Firestore that is associated with the provided [FirebaseApp](./app.firebaseapp.md). If no instance exists, initializes a new instance with default settings. | +| [increment(n)](./firestore_.increment.md) | Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to increment the field's current value by the given value.If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.If the current field value is not of type number, or if the field does not yet exist, the transformation sets the field to the given value. | | [initializeFirestore(app, settings)](./firestore_.initializefirestore.md) | Initializes a new instance of Cloud Firestore with the provided settings. Can only be called before any other function, including [getFirestore()](./firestore_.getfirestore.md). If the custom settings are empty, this function is equivalent to calling [getFirestore()](./firestore_.getfirestore.md). | | [limit(limit)](./firestore_.limit.md) | Creates a QueryConstraint that only returns the first matching documents. | | [limitToLast(limit)](./firestore_.limittolast.md) | Creates a QueryConstraint that only returns the last matching documents.You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution. | @@ -81,7 +81,7 @@ | [queryEqual(left, right)](./firestore_.queryequal.md) | Returns true if the provided queries point to the same collection and apply the same constraints. | | [refEqual(left, right)](./firestore_.refequal.md) | Returns true if the provided references are equal. | | [runTransaction(firestore, updateFunction)](./firestore_.runtransaction.md) | Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, Cloud Firestore retries the updateFunction. If it fails to commit after 5 attempts, the transaction fails.The maximum number of writes allowed in a single transaction is 500. | -| [serverTimestamp()](./firestore_.servertimestamp.md) | Returns a sentinel used with or to include a server-generated timestamp in the written data. | +| [serverTimestamp()](./firestore_.servertimestamp.md) | Returns a sentinel used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) to include a server-generated timestamp in the written data. | | [setDoc(reference, data)](./firestore_.setdoc.md) | Writes to the document referred to by this DocumentReference. If the document does not yet exist, it will be created. | | [setDoc(reference, data, options)](./firestore_.setdoc_1.md) | Writes to the document referred to by the specified DocumentReference. If the document does not yet exist, it will be created. If you provide merge or mergeFields, the provided data can be merged into an existing document. | | [setLogLevel(logLevel)](./firestore_.setloglevel.md) | Sets the verbosity of Cloud Firestore logs (debug, error, or silent). | @@ -103,15 +103,15 @@ | Interface | Description | | --- | --- | | [DocumentChange](./firestore_.documentchange.md) | A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred. | -| [DocumentData](./firestore_.documentdata.md) | Document data (for use with ) consists of fields mapped to values. | +| [DocumentData](./firestore_.documentdata.md) | Document data (for use with [setDoc()](./firestore_lite.setdoc.md)) consists of fields mapped to values. | | [FirestoreDataConverter](./firestore_.firestoredataconverter.md) | Converter used by withConverter() to transform user objects of type T into Firestore data.Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. | | [LoadBundleTaskProgress](./firestore_.loadbundletaskprogress.md) | Represents a progress update or a final state from loading bundles. | | [PersistenceSettings](./firestore_.persistencesettings.md) | | | [Settings](./firestore_.settings.md) | | -| [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md) | An options object that can be passed to and to control which types of changes to include in the result set. | +| [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md) | An options object that can be passed to [onSnapshot()](./firestore_.onsnapshot.md) and [QuerySnapshot.docChanges()](./firestore_.querysnapshot.docchanges.md) to control which types of changes to include in the result set. | | [SnapshotOptions](./firestore_.snapshotoptions.md) | Options that configure how data is retrieved from a DocumentSnapshot (for example the desired behavior for server timestamps that have not yet been set to their final value). | | [Unsubscribe](./firestore_.unsubscribe.md) | | -| [UpdateData](./firestore_.updatedata.md) | Update data (for use with ) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. | +| [UpdateData](./firestore_.updatedata.md) | Update data (for use with [updateDoc()](./firestore_lite.updatedoc.md)) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. | ## Variables @@ -127,7 +127,7 @@ | [FirestoreErrorCode](./firestore_.firestoreerrorcode.md) | The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdPossible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation. | | [OrderByDirection](./firestore_.orderbydirection.md) | The direction of a [orderBy()](./firestore_.orderby.md) clause is specified as 'desc' or 'asc' (descending or ascending). | | [QueryConstraintType](./firestore_.queryconstrainttype.md) | Describes the different query constraints available in this SDK. | -| [SetOptions](./firestore_.setoptions.md) | An options object that configures the behavior of , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true. | +| [SetOptions](./firestore_.setoptions.md) | An options object that configures the behavior of [setDoc()](./firestore_lite.setdoc.md), and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true. | | [TaskState](./firestore_.taskstate.md) | Represents the state of bundle loading tasks.Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported. | | [WhereFilterOp](./firestore_.wherefilterop.md) | Filter conditions in a [where()](./firestore_.where.md) clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'. | diff --git a/docs-exp/firestore_.queryconstraint.md b/docs-exp/firestore_.queryconstraint.md index 4447d19fa2d..2c68715ada1 100644 --- a/docs-exp/firestore_.queryconstraint.md +++ b/docs-exp/firestore_.queryconstraint.md @@ -4,7 +4,7 @@ ## QueryConstraint class -A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`s are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), , , , , [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this `QueryConstraint`. +A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`s are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), [startAt()](./firestore_.startat.md), [startAfter()](./firestore_.startafter.md), , [endAt()](./firestore_.endat.md), [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this `QueryConstraint`. Signature: diff --git a/docs-exp/firestore_.servertimestamp.md b/docs-exp/firestore_.servertimestamp.md index 2583d7fbc4e..a8a2cad6fe1 100644 --- a/docs-exp/firestore_.servertimestamp.md +++ b/docs-exp/firestore_.servertimestamp.md @@ -4,7 +4,7 @@ ## serverTimestamp() function -Returns a sentinel used with or to include a server-generated timestamp in the written data. +Returns a sentinel used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) to include a server-generated timestamp in the written data. Signature: diff --git a/docs-exp/firestore_.setoptions.md b/docs-exp/firestore_.setoptions.md index 46287018770..ed202a37092 100644 --- a/docs-exp/firestore_.setoptions.md +++ b/docs-exp/firestore_.setoptions.md @@ -4,7 +4,7 @@ ## SetOptions type -An options object that configures the behavior of , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a `SetOptions` with `merge: true`. +An options object that configures the behavior of [setDoc()](./firestore_lite.setdoc.md), and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a `SetOptions` with `merge: true`. Signature: diff --git a/docs-exp/firestore_.snapshotlistenoptions.md b/docs-exp/firestore_.snapshotlistenoptions.md index b1139e2994c..da0296ef016 100644 --- a/docs-exp/firestore_.snapshotlistenoptions.md +++ b/docs-exp/firestore_.snapshotlistenoptions.md @@ -4,7 +4,7 @@ ## SnapshotListenOptions interface -An options object that can be passed to and to control which types of changes to include in the result set. +An options object that can be passed to [onSnapshot()](./firestore_.onsnapshot.md) and [QuerySnapshot.docChanges()](./firestore_.querysnapshot.docchanges.md) to control which types of changes to include in the result set. Signature: diff --git a/docs-exp/firestore_.updatedata.md b/docs-exp/firestore_.updatedata.md index 7c6fcd5ce05..0692316956a 100644 --- a/docs-exp/firestore_.updatedata.md +++ b/docs-exp/firestore_.updatedata.md @@ -4,7 +4,7 @@ ## UpdateData interface -Update data (for use with ) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. +Update data (for use with [updateDoc()](./firestore_lite.updatedoc.md)) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. Signature: diff --git a/docs-exp/firestore_lite.arrayunion.md b/docs-exp/firestore_lite.arrayunion.md index fab16671f49..84d0bc3a4cd 100644 --- a/docs-exp/firestore_lite.arrayunion.md +++ b/docs-exp/firestore_lite.arrayunion.md @@ -4,7 +4,7 @@ ## arrayUnion() function -Returns a special value that can be used with or that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. +Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. Signature: diff --git a/docs-exp/firestore_lite.deletefield.md b/docs-exp/firestore_lite.deletefield.md index 9a80de63f66..9a53217105a 100644 --- a/docs-exp/firestore_lite.deletefield.md +++ b/docs-exp/firestore_lite.deletefield.md @@ -4,7 +4,7 @@ ## deleteField() function -Returns a sentinel for use with or with `{merge: true}` to mark a field for deletion. +Returns a sentinel for use with [updateDoc()](./firestore_lite.updatedoc.md) or [setDoc()](./firestore_lite.setdoc.md) with `{merge: true}` to mark a field for deletion. Signature: diff --git a/docs-exp/firestore_lite.documentdata.md b/docs-exp/firestore_lite.documentdata.md index b6ce683e971..0fc78ea3209 100644 --- a/docs-exp/firestore_lite.documentdata.md +++ b/docs-exp/firestore_lite.documentdata.md @@ -4,7 +4,7 @@ ## DocumentData interface -Document data (for use with ) consists of fields mapped to values. +Document data (for use with [setDoc()](./firestore_lite.setdoc.md)) consists of fields mapped to values. Signature: diff --git a/docs-exp/firestore_lite.documentreference.md b/docs-exp/firestore_lite.documentreference.md index 51d2246cdb0..2abf7daab56 100644 --- a/docs-exp/firestore_lite.documentreference.md +++ b/docs-exp/firestore_lite.documentreference.md @@ -26,6 +26,6 @@ export declare class DocumentReference | Method | Modifiers | Description | | --- | --- | --- | -| [withConverter(converter)](./firestore_lite.documentreference.withconverter.md) | | Applies a custom data converter to this DocumentReference, allowing you to use your own custom model objects with Firestore. When you call , [getDoc()](./firestore_.getdoc.md), etc. with the returned DocumentReference instance, the provided converter will convert between Firestore data and your custom type U.Passing in null as the converter parameter removes the current converter. | +| [withConverter(converter)](./firestore_lite.documentreference.withconverter.md) | | Applies a custom data converter to this DocumentReference, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.setdoc.md), [getDoc()](./firestore_lite.getdoc.md), etc. with the returned DocumentReference instance, the provided converter will convert between Firestore data and your custom type U.Passing in null as the converter parameter removes the current converter. | | [withConverter(converter)](./firestore_lite.documentreference.withconverter_1.md) | | | diff --git a/docs-exp/firestore_lite.documentreference.withconverter.md b/docs-exp/firestore_lite.documentreference.withconverter.md index 95531089576..adbc84259e9 100644 --- a/docs-exp/firestore_lite.documentreference.withconverter.md +++ b/docs-exp/firestore_lite.documentreference.withconverter.md @@ -4,7 +4,7 @@ ## DocumentReference.withConverter() method -Applies a custom data converter to this `DocumentReference`, allowing you to use your own custom model objects with Firestore. When you call , [getDoc()](./firestore_.getdoc.md), etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data and your custom type `U`. +Applies a custom data converter to this `DocumentReference`, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.setdoc.md), [getDoc()](./firestore_lite.getdoc.md), etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data and your custom type `U`. Passing in `null` as the converter parameter removes the current converter. diff --git a/docs-exp/firestore_lite.firebasefirestore.app.md b/docs-exp/firestore_lite.firebasefirestore.app.md index 03cf9c80671..4ee70296343 100644 --- a/docs-exp/firestore_lite.firebasefirestore.app.md +++ b/docs-exp/firestore_lite.firebasefirestore.app.md @@ -4,7 +4,7 @@ ## FirebaseFirestore.app property -The associated with this `Firestore` service instance. +The [FirebaseApp](./app.firebaseapp.md) associated with this `Firestore` service instance. Signature: diff --git a/docs-exp/firestore_lite.firebasefirestore.md b/docs-exp/firestore_lite.firebasefirestore.md index 2dad1bbccb4..a3d61816599 100644 --- a/docs-exp/firestore_lite.firebasefirestore.md +++ b/docs-exp/firestore_lite.firebasefirestore.md @@ -18,7 +18,7 @@ export declare class FirebaseFirestore | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [app](./firestore_lite.firebasefirestore.app.md) | | [FirebaseApp](./app.firebaseapp.md) | The associated with this Firestore service instance. | +| [app](./firestore_lite.firebasefirestore.app.md) | | [FirebaseApp](./app.firebaseapp.md) | The [FirebaseApp](./app.firebaseapp.md) associated with this Firestore service instance. | ## Methods diff --git a/docs-exp/firestore_lite.firestoredataconverter.md b/docs-exp/firestore_lite.firestoredataconverter.md index 987ec2e4553..cd789b60727 100644 --- a/docs-exp/firestore_lite.firestoredataconverter.md +++ b/docs-exp/firestore_lite.firestoredataconverter.md @@ -54,6 +54,6 @@ if (post !== undefined) { | Method | Description | | --- | --- | | [fromFirestore(snapshot)](./firestore_lite.firestoredataconverter.fromfirestore.md) | Called by the Firestore SDK to convert Firestore data into an object of type T. You can access your data by calling: snapshot.data(). | -| [toFirestore(modelObject)](./firestore_lite.firestoredataconverter.tofirestore.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain Javascript object (suitable for writing directly to the Firestore database). Used with , and . | -| [toFirestore(modelObject, options)](./firestore_lite.firestoredataconverter.tofirestore_1.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain Javascript object (suitable for writing directly to the Firestore database). Used with , and with merge:true or mergeFields. | +| [toFirestore(modelObject)](./firestore_lite.firestoredataconverter.tofirestore.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain Javascript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_lite.setdoc.md), and . | +| [toFirestore(modelObject, options)](./firestore_lite.firestoredataconverter.tofirestore_1.md) | Called by the Firestore SDK to convert a custom model object of type T into a plain Javascript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_lite.setdoc.md), and with merge:true or mergeFields. | diff --git a/docs-exp/firestore_lite.firestoredataconverter.tofirestore.md b/docs-exp/firestore_lite.firestoredataconverter.tofirestore.md index ce94c420ad8..3e56de060e4 100644 --- a/docs-exp/firestore_lite.firestoredataconverter.tofirestore.md +++ b/docs-exp/firestore_lite.firestoredataconverter.tofirestore.md @@ -4,7 +4,7 @@ ## FirestoreDataConverter.toFirestore() method -Called by the Firestore SDK to convert a custom model object of type `T` into a plain Javascript object (suitable for writing directly to the Firestore database). Used with , and . +Called by the Firestore SDK to convert a custom model object of type `T` into a plain Javascript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_lite.setdoc.md), and . Signature: diff --git a/docs-exp/firestore_lite.firestoredataconverter.tofirestore_1.md b/docs-exp/firestore_lite.firestoredataconverter.tofirestore_1.md index e060f5ae025..93dc0f83d54 100644 --- a/docs-exp/firestore_lite.firestoredataconverter.tofirestore_1.md +++ b/docs-exp/firestore_lite.firestoredataconverter.tofirestore_1.md @@ -4,7 +4,7 @@ ## FirestoreDataConverter.toFirestore() method -Called by the Firestore SDK to convert a custom model object of type `T` into a plain Javascript object (suitable for writing directly to the Firestore database). Used with , and with `merge:true` or `mergeFields`. +Called by the Firestore SDK to convert a custom model object of type `T` into a plain Javascript object (suitable for writing directly to the Firestore database). Used with [setDoc()](./firestore_lite.setdoc.md), and with `merge:true` or `mergeFields`. Signature: diff --git a/docs-exp/firestore_lite.getfirestore.md b/docs-exp/firestore_lite.getfirestore.md index 01952be73af..2351b56201b 100644 --- a/docs-exp/firestore_lite.getfirestore.md +++ b/docs-exp/firestore_lite.getfirestore.md @@ -4,19 +4,19 @@ ## getFirestore() function -Returns the existing instance of Firestore that is associated with the provided . If no instance exists, initializes a new instance with default settings. +Returns the existing instance of Firestore that is associated with the provided [FirebaseApp](./app.firebaseapp.md). If no instance exists, initializes a new instance with default settings. Signature: ```typescript -export declare function getFirestore(app: FirebaseApp): FirebaseFirestore; +export declare function getFirestore(app?: FirebaseApp): FirebaseFirestore; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| app | [FirebaseApp](./app.firebaseapp.md) | The instance that the returned Firestore instance is associated with. | +| app | [FirebaseApp](./app.firebaseapp.md) | The [FirebaseApp](./app.firebaseapp.md) instance that the returned Firestore instance is associated with. | Returns: diff --git a/docs-exp/firestore_lite.increment.md b/docs-exp/firestore_lite.increment.md index 0f3c57dc377..a1aaf24bfe2 100644 --- a/docs-exp/firestore_lite.increment.md +++ b/docs-exp/firestore_lite.increment.md @@ -4,7 +4,7 @@ ## increment() function -Returns a special value that can be used with or that tells the server to increment the field's current value by the given value. +Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to increment the field's current value by the given value. If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1. diff --git a/docs-exp/firestore_lite.initializefirestore.md b/docs-exp/firestore_lite.initializefirestore.md index 51919651681..9f144753b0b 100644 --- a/docs-exp/firestore_lite.initializefirestore.md +++ b/docs-exp/firestore_lite.initializefirestore.md @@ -16,7 +16,7 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Settings | Parameter | Type | Description | | --- | --- | --- | -| app | [FirebaseApp](./app.firebaseapp.md) | The with which the Firestore instance will be associated. | +| app | [FirebaseApp](./app.firebaseapp.md) | The [FirebaseApp](./app.firebaseapp.md) with which the Firestore instance will be associated. | | settings | [Settings](./firestore_lite.settings.md) | A settings object to configure the Firestore instance. | Returns: diff --git a/docs-exp/firestore_lite.md b/docs-exp/firestore_lite.md index 83075705c2b..f00306754d9 100644 --- a/docs-exp/firestore_lite.md +++ b/docs-exp/firestore_lite.md @@ -18,12 +18,12 @@ | [FirestoreError](./firestore_lite.firestoreerror.md) | An error returned by a Firestore operation. | | [GeoPoint](./firestore_lite.geopoint.md) | An immutable object representing a geographic location in Firestore. The location is represented as latitude/longitude pair.Latitude values are in the range of \[-90, 90\]. Longitude values are in the range of \[-180, 180\]. | | [Query](./firestore_lite.query.md) | A Query refers to a Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering. | -| [QueryConstraint](./firestore_lite.queryconstraint.md) | A QueryConstraint is used to narrow the set of documents returned by a Firestore query. QueryConstraints are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), , , , , [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this QueryConstraint. | +| [QueryConstraint](./firestore_lite.queryconstraint.md) | A QueryConstraint is used to narrow the set of documents returned by a Firestore query. QueryConstraints are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), [startAt()](./firestore_.startat.md), [startAfter()](./firestore_.startafter.md), , [endAt()](./firestore_.endat.md), [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this QueryConstraint. | | [QueryDocumentSnapshot](./firestore_lite.querydocumentsnapshot.md) | A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with .data() or .get(<field>) to get a specific field.A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot. Since query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'. | | [QuerySnapshot](./firestore_lite.querysnapshot.md) | A QuerySnapshot contains zero or more DocumentSnapshot objects representing the results of a query. The documents can be accessed as an array via the docs property or enumerated using the forEach method. The number of documents can be determined via the empty and size properties. | | [Timestamp](./firestore_lite.timestamp.md) | A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.For examples and further specifications, refer to the [Timestamp definition](https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto). | | [Transaction](./firestore_lite.transaction.md) | A reference to a transaction.The Transaction object passed to a transaction's updateFunction provides the methods to read and write data within the transaction context. See [runTransaction()](./firestore_.runtransaction.md). | -| [WriteBatch](./firestore_lite.writebatch.md) | A write batch, used to perform multiple writes as a single atomic unit.A WriteBatch object can be acquired by calling [writeBatch()](./firestore_.writebatch.md). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until is called. | +| [WriteBatch](./firestore_lite.writebatch.md) | A write batch, used to perform multiple writes as a single atomic unit.A WriteBatch object can be acquired by calling [writeBatch()](./firestore_.writebatch.md). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until [WriteBatch.commit()](./firestore_.writebatch.commit.md) is called. | ## Functions @@ -31,13 +31,13 @@ | --- | --- | | [addDoc(reference, data)](./firestore_lite.adddoc.md) | Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.The result of this write will only be reflected in document reads that occur after the returned Promise resolves. If the client is offline, the write fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK. | | [arrayRemove(elements)](./firestore_lite.arrayremove.md) | Returns a special value that can be used with [setDoc()](./firestore_.setdoc.md) or that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array. | -| [arrayUnion(elements)](./firestore_lite.arrayunion.md) | Returns a special value that can be used with or that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. | +| [arrayUnion(elements)](./firestore_lite.arrayunion.md) | Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements. | | [collection(firestore, path, pathSegments)](./firestore_lite.collection.md) | Gets a CollectionReference instance that refers to the collection at the specified absolute path. | | [collection(reference, path, pathSegments)](./firestore_lite.collection_1.md) | Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path. | | [collection(reference, path, pathSegments)](./firestore_lite.collection_2.md) | Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path. | | [collectionGroup(firestore, collectionId)](./firestore_lite.collectiongroup.md) | Creates and returns a new Query instance that includes all documents in the database that are contained in a collection or subcollection with the given collectionId. | | [deleteDoc(reference)](./firestore_lite.deletedoc.md) | Deletes the document referred to by the specified DocumentReference.The deletion will only be reflected in document reads that occur after the returned Promise resolves. If the client is offline, the delete fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK. | -| [deleteField()](./firestore_lite.deletefield.md) | Returns a sentinel for use with or with {merge: true} to mark a field for deletion. | +| [deleteField()](./firestore_lite.deletefield.md) | Returns a sentinel for use with [updateDoc()](./firestore_lite.updatedoc.md) or [setDoc()](./firestore_lite.setdoc.md) with {merge: true} to mark a field for deletion. | | [doc(firestore, path, pathSegments)](./firestore_lite.doc.md) | Gets a DocumentReference instance that refers to the document at the specified abosulute path. | | [doc(reference, path, pathSegments)](./firestore_lite.doc_1.md) | Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference. | | [doc(reference, path, pathSegments)](./firestore_lite.doc_2.md) | Gets a DocumentReference instance that refers to a document within reference at the specified relative path. | @@ -48,8 +48,8 @@ | [endBefore(fieldValues)](./firestore_lite.endbefore_1.md) | Creates a QueryConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query. | | [getDoc(reference)](./firestore_lite.getdoc.md) | Reads the document referred to by the specified document reference.All documents are directly fetched from the server, even if the document was previously read or modified. Recent modifications are only reflected in the retrieved DocumentSnapshot if they have already been applied by the backend. If the client is offline, the read fails. If you like to use caching or see local modifications, please use the full Firestore SDK. | | [getDocs(query)](./firestore_lite.getdocs.md) | Executes the query and returns the results as a [QuerySnapshot](./firestore_.querysnapshot.md).All queries are executed directly by the server, even if the the query was previously executed. Recent modifications are only reflected in the retrieved results if they have already been applied by the backend. If the client is offline, the operation fails. To see previously cached result and local modifications, use the full Firestore SDK. | -| [getFirestore(app)](./firestore_lite.getfirestore.md) | Returns the existing instance of Firestore that is associated with the provided . If no instance exists, initializes a new instance with default settings. | -| [increment(n)](./firestore_lite.increment.md) | Returns a special value that can be used with or that tells the server to increment the field's current value by the given value.If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.If the current field value is not of type number, or if the field does not yet exist, the transformation sets the field to the given value. | +| [getFirestore(app)](./firestore_lite.getfirestore.md) | Returns the existing instance of Firestore that is associated with the provided [FirebaseApp](./app.firebaseapp.md). If no instance exists, initializes a new instance with default settings. | +| [increment(n)](./firestore_lite.increment.md) | Returns a special value that can be used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) that tells the server to increment the field's current value by the given value.If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range (Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.If the current field value is not of type number, or if the field does not yet exist, the transformation sets the field to the given value. | | [initializeFirestore(app, settings)](./firestore_lite.initializefirestore.md) | Initializes a new instance of Cloud Firestore with the provided settings. Can only be called before any other functions, including [getFirestore()](./firestore_.getfirestore.md). If the custom settings are empty, this function is equivalent to calling [getFirestore()](./firestore_.getfirestore.md). | | [limit(limit)](./firestore_lite.limit.md) | Creates a QueryConstraint that only returns the first matching documents. | | [limitToLast(limit)](./firestore_lite.limittolast.md) | Creates a QueryConstraint that only returns the last matching documents.You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution. | @@ -58,7 +58,7 @@ | [queryEqual(left, right)](./firestore_lite.queryequal.md) | Returns true if the provided queries point to the same collection and apply the same constraints. | | [refEqual(left, right)](./firestore_lite.refequal.md) | Returns true if the provided references are equal. | | [runTransaction(firestore, updateFunction)](./firestore_lite.runtransaction.md) | Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, Cloud Firestore retries the updateFunction. If it fails to commit after 5 attempts, the transaction fails.The maximum number of writes allowed in a single transaction is 500. | -| [serverTimestamp()](./firestore_lite.servertimestamp.md) | Returns a sentinel used with or to include a server-generated timestamp in the written data. | +| [serverTimestamp()](./firestore_lite.servertimestamp.md) | Returns a sentinel used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) to include a server-generated timestamp in the written data. | | [setDoc(reference, data)](./firestore_lite.setdoc.md) | Writes to the document referred to by the specified DocumentReference. If the document does not yet exist, it will be created.The result of this write will only be reflected in document reads that occur after the returned Promise resolves. If the client is offline, the write fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK. | | [setDoc(reference, data, options)](./firestore_lite.setdoc_1.md) | Writes to the document referred to by the specified DocumentReference. If the document does not yet exist, it will be created. If you provide merge or mergeFields, the provided data can be merged into an existing document.The result of this write will only be reflected in document reads that occur after the returned Promise resolves. If the client is offline, the write fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK. | | [setLogLevel(logLevel)](./firestore_lite.setloglevel.md) | Sets the verbosity of Cloud Firestore logs (debug, error, or silent). | @@ -78,10 +78,10 @@ | Interface | Description | | --- | --- | -| [DocumentData](./firestore_lite.documentdata.md) | Document data (for use with ) consists of fields mapped to values. | +| [DocumentData](./firestore_lite.documentdata.md) | Document data (for use with [setDoc()](./firestore_lite.setdoc.md)) consists of fields mapped to values. | | [FirestoreDataConverter](./firestore_lite.firestoredataconverter.md) | Converter used by withConverter() to transform user objects of type T into Firestore data.Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore. | | [Settings](./firestore_lite.settings.md) | | -| [UpdateData](./firestore_lite.updatedata.md) | Update data (for use with ) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. | +| [UpdateData](./firestore_lite.updatedata.md) | Update data (for use with [updateDoc()](./firestore_lite.updatedoc.md)) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. | ## Type Aliases @@ -90,6 +90,6 @@ | [FirestoreErrorCode](./firestore_lite.firestoreerrorcode.md) | The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdPossible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation. | | [OrderByDirection](./firestore_lite.orderbydirection.md) | The direction of a [orderBy()](./firestore_.orderby.md) clause is specified as 'desc' or 'asc' (descending or ascending). | | [QueryConstraintType](./firestore_lite.queryconstrainttype.md) | Describes the different query constraints available in this SDK. | -| [SetOptions](./firestore_lite.setoptions.md) | An options object that configures the behavior of , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true. | +| [SetOptions](./firestore_lite.setoptions.md) | An options object that configures the behavior of [setDoc()](./firestore_lite.setdoc.md), and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true. | | [WhereFilterOp](./firestore_lite.wherefilterop.md) | Filter conditions in a [where()](./firestore_.where.md) clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'. | diff --git a/docs-exp/firestore_lite.queryconstraint.md b/docs-exp/firestore_lite.queryconstraint.md index 41aba06a4bb..de5afd9da99 100644 --- a/docs-exp/firestore_lite.queryconstraint.md +++ b/docs-exp/firestore_lite.queryconstraint.md @@ -4,7 +4,7 @@ ## QueryConstraint class -A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`s are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), , , , , [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this `QueryConstraint`. +A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`s are created by invoking [where()](./firestore_.where.md), [orderBy()](./firestore_.orderby.md), [startAt()](./firestore_.startat.md), [startAfter()](./firestore_.startafter.md), , [endAt()](./firestore_.endat.md), [limit()](./firestore_.limit.md) or [limitToLast()](./firestore_.limittolast.md) and can then be passed to [query()](./firestore_.query.md) to create a new query instance that also contains this `QueryConstraint`. Signature: diff --git a/docs-exp/firestore_lite.servertimestamp.md b/docs-exp/firestore_lite.servertimestamp.md index da1cd413eb7..448814b4739 100644 --- a/docs-exp/firestore_lite.servertimestamp.md +++ b/docs-exp/firestore_lite.servertimestamp.md @@ -4,7 +4,7 @@ ## serverTimestamp() function -Returns a sentinel used with or to include a server-generated timestamp in the written data. +Returns a sentinel used with [setDoc()](./firestore_lite.setdoc.md) or [updateDoc()](./firestore_lite.updatedoc.md) to include a server-generated timestamp in the written data. Signature: diff --git a/docs-exp/firestore_lite.setoptions.md b/docs-exp/firestore_lite.setoptions.md index 8403a57a517..4edf1b45ef2 100644 --- a/docs-exp/firestore_lite.setoptions.md +++ b/docs-exp/firestore_lite.setoptions.md @@ -4,7 +4,7 @@ ## SetOptions type -An options object that configures the behavior of , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a `SetOptions` with `merge: true`. +An options object that configures the behavior of [setDoc()](./firestore_lite.setdoc.md), and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a `SetOptions` with `merge: true`. Signature: diff --git a/docs-exp/firestore_lite.updatedata.md b/docs-exp/firestore_lite.updatedata.md index 47dbfc0c000..76447f6cb07 100644 --- a/docs-exp/firestore_lite.updatedata.md +++ b/docs-exp/firestore_lite.updatedata.md @@ -4,7 +4,7 @@ ## UpdateData interface -Update data (for use with ) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. +Update data (for use with [updateDoc()](./firestore_lite.updatedoc.md)) consists of field paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. Signature: diff --git a/docs-exp/functions-compat.md b/docs-exp/functions-compat.md deleted file mode 100644 index 32e29fb2b3a..00000000000 --- a/docs-exp/functions-compat.md +++ /dev/null @@ -1,6 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-compat](./functions-compat.md) - -## functions-compat package - diff --git a/docs-exp/functions-types.functions.app.md b/docs-exp/functions-types.functions.app.md deleted file mode 100644 index 1016d2cc059..00000000000 --- a/docs-exp/functions-types.functions.app.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [Functions](./functions-types.functions.md) > [app](./functions-types.functions.app.md) - -## Functions.app property - -The FirebaseApp this Functions instance is associated with. - -Signature: - -```typescript -app: FirebaseApp; -``` diff --git a/docs-exp/functions-types.functions.customdomain.md b/docs-exp/functions-types.functions.customdomain.md deleted file mode 100644 index 70cb1d47151..00000000000 --- a/docs-exp/functions-types.functions.customdomain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [Functions](./functions-types.functions.md) > [customDomain](./functions-types.functions.customdomain.md) - -## Functions.customDomain property - -A custom domain hosting the callable Cloud Functions. ex: https://mydomain.com - -Signature: - -```typescript -customDomain: string | null; -``` diff --git a/docs-exp/functions-types.functions.md b/docs-exp/functions-types.functions.md deleted file mode 100644 index ae59c5b0d3d..00000000000 --- a/docs-exp/functions-types.functions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [Functions](./functions-types.functions.md) - -## Functions interface - -`Functions` represents a Functions instance, and is a required argument for all Functions operations. - -Signature: - -```typescript -export interface Functions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [app](./functions-types.functions.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | The FirebaseApp this Functions instance is associated with. | -| [customDomain](./functions-types.functions.customdomain.md) | string \| null | A custom domain hosting the callable Cloud Functions. ex: https://mydomain.com | -| [region](./functions-types.functions.region.md) | string | The region the callable Cloud Functions are located in. Default is us-central-1. | - diff --git a/docs-exp/functions-types.functions.region.md b/docs-exp/functions-types.functions.region.md deleted file mode 100644 index 5b76aa4101c..00000000000 --- a/docs-exp/functions-types.functions.region.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [Functions](./functions-types.functions.md) > [region](./functions-types.functions.region.md) - -## Functions.region property - -The region the callable Cloud Functions are located in. Default is `us-central-1`. - -Signature: - -```typescript -region: string; -``` diff --git a/docs-exp/functions-types.functionserror.code.md b/docs-exp/functions-types.functionserror.code.md deleted file mode 100644 index a1219c39ec3..00000000000 --- a/docs-exp/functions-types.functionserror.code.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [FunctionsError](./functions-types.functionserror.md) > [code](./functions-types.functionserror.code.md) - -## FunctionsError.code property - -A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto. - -Signature: - -```typescript -readonly code: FunctionsErrorCode; -``` diff --git a/docs-exp/functions-types.functionserror.details.md b/docs-exp/functions-types.functionserror.details.md deleted file mode 100644 index 4cb5b48be99..00000000000 --- a/docs-exp/functions-types.functionserror.details.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [FunctionsError](./functions-types.functionserror.md) > [details](./functions-types.functionserror.details.md) - -## FunctionsError.details property - -Extra data to be converted to JSON and included in the error response. - -Signature: - -```typescript -readonly details?: any; -``` diff --git a/docs-exp/functions-types.functionserror.md b/docs-exp/functions-types.functionserror.md deleted file mode 100644 index 1b5aaf9d124..00000000000 --- a/docs-exp/functions-types.functionserror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [FunctionsError](./functions-types.functionserror.md) - -## FunctionsError interface - -Signature: - -```typescript -export interface FunctionsError extends FirebaseError -``` -Extends: FirebaseError - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [code](./functions-types.functionserror.code.md) | [FunctionsErrorCode](./functions-types.functionserrorcode.md) | A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto. | -| [details](./functions-types.functionserror.details.md) | any | Extra data to be converted to JSON and included in the error response. | - diff --git a/docs-exp/functions-types.functionserrorcode.md b/docs-exp/functions-types.functionserrorcode.md deleted file mode 100644 index fc5915e5d19..00000000000 --- a/docs-exp/functions-types.functionserrorcode.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [FunctionsErrorCode](./functions-types.functionserrorcode.md) - -## FunctionsErrorCode type - -The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md - -Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation. - -Signature: - -```typescript -export type FunctionsErrorCode = - | 'ok' - | 'cancelled' - | 'unknown' - | 'invalid-argument' - | 'deadline-exceeded' - | 'not-found' - | 'already-exists' - | 'permission-denied' - | 'resource-exhausted' - | 'failed-precondition' - | 'aborted' - | 'out-of-range' - | 'unimplemented' - | 'internal' - | 'unavailable' - | 'data-loss' - | 'unauthenticated'; -``` diff --git a/docs-exp/functions-types.httpscallable.md b/docs-exp/functions-types.httpscallable.md deleted file mode 100644 index 7982ac778d0..00000000000 --- a/docs-exp/functions-types.httpscallable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [HttpsCallable](./functions-types.httpscallable.md) - -## HttpsCallable interface - -An HttpsCallable is a reference to a "callable" http trigger in Google Cloud Functions. - -Signature: - -```typescript -export interface HttpsCallable -``` diff --git a/docs-exp/functions-types.httpscallableoptions.md b/docs-exp/functions-types.httpscallableoptions.md deleted file mode 100644 index a311f432db5..00000000000 --- a/docs-exp/functions-types.httpscallableoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [HttpsCallableOptions](./functions-types.httpscallableoptions.md) - -## HttpsCallableOptions interface - -HttpsCallableOptions specify metadata about how calls should be executed. - -Signature: - -```typescript -export interface HttpsCallableOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [timeout](./functions-types.httpscallableoptions.timeout.md) | number | | - diff --git a/docs-exp/functions-types.httpscallableoptions.timeout.md b/docs-exp/functions-types.httpscallableoptions.timeout.md deleted file mode 100644 index bef0266c3ca..00000000000 --- a/docs-exp/functions-types.httpscallableoptions.timeout.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [HttpsCallableOptions](./functions-types.httpscallableoptions.md) > [timeout](./functions-types.httpscallableoptions.timeout.md) - -## HttpsCallableOptions.timeout property - -Signature: - -```typescript -timeout?: number; -``` diff --git a/docs-exp/functions-types.httpscallableresult.data.md b/docs-exp/functions-types.httpscallableresult.data.md deleted file mode 100644 index 5795095831a..00000000000 --- a/docs-exp/functions-types.httpscallableresult.data.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [HttpsCallableResult](./functions-types.httpscallableresult.md) > [data](./functions-types.httpscallableresult.data.md) - -## HttpsCallableResult.data property - -Signature: - -```typescript -readonly data: any; -``` diff --git a/docs-exp/functions-types.httpscallableresult.md b/docs-exp/functions-types.httpscallableresult.md deleted file mode 100644 index d8afa7988cd..00000000000 --- a/docs-exp/functions-types.httpscallableresult.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) > [HttpsCallableResult](./functions-types.httpscallableresult.md) - -## HttpsCallableResult interface - -An HttpsCallableResult wraps a single result from a function call. - -Signature: - -```typescript -export interface HttpsCallableResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](./functions-types.httpscallableresult.data.md) | any | | - diff --git a/docs-exp/functions-types.md b/docs-exp/functions-types.md deleted file mode 100644 index 6e596d5f512..00000000000 --- a/docs-exp/functions-types.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/functions-types](./functions-types.md) - -## functions-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [Functions](./functions-types.functions.md) | Functions represents a Functions instance, and is a required argument for all Functions operations. | -| [FunctionsError](./functions-types.functionserror.md) | | -| [HttpsCallable](./functions-types.httpscallable.md) | An HttpsCallable is a reference to a "callable" http trigger in Google Cloud Functions. | -| [HttpsCallableOptions](./functions-types.httpscallableoptions.md) | HttpsCallableOptions specify metadata about how calls should be executed. | -| [HttpsCallableResult](./functions-types.httpscallableresult.md) | An HttpsCallableResult wraps a single result from a function call. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [FunctionsErrorCode](./functions-types.functionserrorcode.md) | The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdPossible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation. | - diff --git a/docs-exp/functions.getfunctions.md b/docs-exp/functions.getfunctions.md index 916875e4a23..2e78abc7879 100644 --- a/docs-exp/functions.getfunctions.md +++ b/docs-exp/functions.getfunctions.md @@ -9,7 +9,7 @@ Returns a Functions instance for the given app. Signature: ```typescript -export declare function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): Functions; +export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions; ``` ## Parameters diff --git a/docs-exp/index.md b/docs-exp/index.md index fe36bbe3a0a..7ebc3480b07 100644 --- a/docs-exp/index.md +++ b/docs-exp/index.md @@ -9,23 +9,14 @@ | Package | Description | | --- | --- | | [@firebase/analytics](./analytics.md) | | -| [@firebase/analytics-types](./analytics-types.md) | | | [@firebase/app](./app.md) | Firebase App | -| [@firebase/app-types](./app-types.md) | | | [@firebase/auth](./auth.md) | | -| [@firebase/auth-types](./auth-types.md) | | | [@firebase/database](./database.md) | | | [@firebase/firestore](./firestore.md) | | | [@firebase/functions](./functions.md) | | -| [@firebase/functions-compat](./functions-compat.md) | | -| [@firebase/functions-types](./functions-types.md) | | | [@firebase/installations](./installations.md) | | -| [@firebase/installations-types](./installations-types.md) | | | [@firebase/messaging](./messaging.md) | | | [@firebase/performance](./performance.md) | | -| [@firebase/performance-types](./performance-types.md) | | | [@firebase/remote-config](./remote-config.md) | | -| [@firebase/remote-config-types](./remote-config-types.md) | | | [@firebase/storage](./storage.md) | | -| [@firebase/storage-types](./storage-types.md) | | diff --git a/docs-exp/installations-types.firebaseinstallations.md b/docs-exp/installations-types.firebaseinstallations.md deleted file mode 100644 index 3f0a2450c9e..00000000000 --- a/docs-exp/installations-types.firebaseinstallations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/installations-types](./installations-types.md) > [FirebaseInstallations](./installations-types.firebaseinstallations.md) - -## FirebaseInstallations interface - -Public interface of the FirebaseInstallations SDK. - -Signature: - -```typescript -export interface FirebaseInstallations -``` diff --git a/docs-exp/installations-types.md b/docs-exp/installations-types.md deleted file mode 100644 index 19584ef24d6..00000000000 --- a/docs-exp/installations-types.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [@firebase/installations-types](./installations-types.md) - -## installations-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [FirebaseInstallations](./installations-types.firebaseinstallations.md) | Public interface of the FirebaseInstallations SDK. | - diff --git a/docs-exp/installations.getinstallations.md b/docs-exp/installations.getinstallations.md index 88c09f14e8d..717d6b2bce8 100644 --- a/docs-exp/installations.getinstallations.md +++ b/docs-exp/installations.getinstallations.md @@ -9,7 +9,7 @@ Returns an instance of FirebaseInstallations associated with the given FirebaseA Signature: ```typescript -export declare function getInstallations(app: FirebaseApp): FirebaseInstallations; +export declare function getInstallations(app?: FirebaseApp): FirebaseInstallations; ``` ## Parameters diff --git a/docs-exp/messaging.getmessaging.md b/docs-exp/messaging.getmessaging.md index 7f5a9b36806..fc97e6c990e 100644 --- a/docs-exp/messaging.getmessaging.md +++ b/docs-exp/messaging.getmessaging.md @@ -9,7 +9,7 @@ Retrieves a firebase messaging instance. Signature: ```typescript -export declare function getMessaging(app: FirebaseApp): FirebaseMessaging; +export declare function getMessaging(app?: FirebaseApp): FirebaseMessaging; ``` ## Parameters diff --git a/docs-exp/performance-types.firebaseperformance.datacollectionenabled.md b/docs-exp/performance-types.firebaseperformance.datacollectionenabled.md deleted file mode 100644 index bf9e5a9814d..00000000000 --- a/docs-exp/performance-types.firebaseperformance.datacollectionenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [FirebasePerformance](./performance-types.firebaseperformance.md) > [dataCollectionEnabled](./performance-types.firebaseperformance.datacollectionenabled.md) - -## FirebasePerformance.dataCollectionEnabled property - -Controls the logging of custom traces. - -Signature: - -```typescript -dataCollectionEnabled: boolean; -``` diff --git a/docs-exp/performance-types.firebaseperformance.instrumentationenabled.md b/docs-exp/performance-types.firebaseperformance.instrumentationenabled.md deleted file mode 100644 index 5b1234028bf..00000000000 --- a/docs-exp/performance-types.firebaseperformance.instrumentationenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [FirebasePerformance](./performance-types.firebaseperformance.md) > [instrumentationEnabled](./performance-types.firebaseperformance.instrumentationenabled.md) - -## FirebasePerformance.instrumentationEnabled property - -Controls the logging of automatic traces and HTTP/S network monitoring. - -Signature: - -```typescript -instrumentationEnabled: boolean; -``` diff --git a/docs-exp/performance-types.firebaseperformance.md b/docs-exp/performance-types.firebaseperformance.md deleted file mode 100644 index 56b4b75d18b..00000000000 --- a/docs-exp/performance-types.firebaseperformance.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [FirebasePerformance](./performance-types.firebaseperformance.md) - -## FirebasePerformance interface - - -Signature: - -```typescript -export interface FirebasePerformance -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataCollectionEnabled](./performance-types.firebaseperformance.datacollectionenabled.md) | boolean | Controls the logging of custom traces. | -| [instrumentationEnabled](./performance-types.firebaseperformance.instrumentationenabled.md) | boolean | Controls the logging of automatic traces and HTTP/S network monitoring. | - diff --git a/docs-exp/performance-types.md b/docs-exp/performance-types.md deleted file mode 100644 index 0e570e39f94..00000000000 --- a/docs-exp/performance-types.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) - -## performance-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [FirebasePerformance](./performance-types.firebaseperformance.md) | | -| [PerformanceSettings](./performance-types.performancesettings.md) | | -| [PerformanceTrace](./performance-types.performancetrace.md) | | - diff --git a/docs-exp/performance-types.performancesettings.datacollectionenabled.md b/docs-exp/performance-types.performancesettings.datacollectionenabled.md deleted file mode 100644 index 3d9cc2cfa81..00000000000 --- a/docs-exp/performance-types.performancesettings.datacollectionenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceSettings](./performance-types.performancesettings.md) > [dataCollectionEnabled](./performance-types.performancesettings.datacollectionenabled.md) - -## PerformanceSettings.dataCollectionEnabled property - -Whether to collect custom events. - -Signature: - -```typescript -dataCollectionEnabled?: boolean; -``` diff --git a/docs-exp/performance-types.performancesettings.instrumentationenabled.md b/docs-exp/performance-types.performancesettings.instrumentationenabled.md deleted file mode 100644 index 9e662d62719..00000000000 --- a/docs-exp/performance-types.performancesettings.instrumentationenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceSettings](./performance-types.performancesettings.md) > [instrumentationEnabled](./performance-types.performancesettings.instrumentationenabled.md) - -## PerformanceSettings.instrumentationEnabled property - -Whether to collect out of the box events. - -Signature: - -```typescript -instrumentationEnabled?: boolean; -``` diff --git a/docs-exp/performance-types.performancesettings.md b/docs-exp/performance-types.performancesettings.md deleted file mode 100644 index 818c0ff0135..00000000000 --- a/docs-exp/performance-types.performancesettings.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceSettings](./performance-types.performancesettings.md) - -## PerformanceSettings interface - - -Signature: - -```typescript -export interface PerformanceSettings -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataCollectionEnabled](./performance-types.performancesettings.datacollectionenabled.md) | boolean | Whether to collect custom events. | -| [instrumentationEnabled](./performance-types.performancesettings.instrumentationenabled.md) | boolean | Whether to collect out of the box events. | - diff --git a/docs-exp/performance-types.performancetrace.getattribute.md b/docs-exp/performance-types.performancetrace.getattribute.md deleted file mode 100644 index 446cf18bd89..00000000000 --- a/docs-exp/performance-types.performancetrace.getattribute.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [getAttribute](./performance-types.performancetrace.getattribute.md) - -## PerformanceTrace.getAttribute() method - -Retrieves the value which a custom attribute is set to. - -Signature: - -```typescript -getAttribute(attr: string): string | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| attr | string | Name of the custom attribute. | - -Returns: - -string \| undefined - diff --git a/docs-exp/performance-types.performancetrace.getattributes.md b/docs-exp/performance-types.performancetrace.getattributes.md deleted file mode 100644 index 881b4432146..00000000000 --- a/docs-exp/performance-types.performancetrace.getattributes.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [getAttributes](./performance-types.performancetrace.getattributes.md) - -## PerformanceTrace.getAttributes() method - -Returns a map of all custom attributes of a trace instance. - -Signature: - -```typescript -getAttributes(): { [key: string]: string }; -``` -Returns: - -{ \[key: string\]: string } - diff --git a/docs-exp/performance-types.performancetrace.getmetric.md b/docs-exp/performance-types.performancetrace.getmetric.md deleted file mode 100644 index 1637633b959..00000000000 --- a/docs-exp/performance-types.performancetrace.getmetric.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [getMetric](./performance-types.performancetrace.getmetric.md) - -## PerformanceTrace.getMetric() method - -Returns the value of the custom metric by that name. If a custom metric with that name does not exist will return zero. - -Signature: - -```typescript -getMetric(metricName: string): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| metricName | string | Name of the custom metric. | - -Returns: - -number - diff --git a/docs-exp/performance-types.performancetrace.incrementmetric.md b/docs-exp/performance-types.performancetrace.incrementmetric.md deleted file mode 100644 index 94644031e3b..00000000000 --- a/docs-exp/performance-types.performancetrace.incrementmetric.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [incrementMetric](./performance-types.performancetrace.incrementmetric.md) - -## PerformanceTrace.incrementMetric() method - -Adds to the value of a custom metric. If a custom metric with the provided name does not exist, it creates one with that name and the value equal to the given number. The value will be floored down to an integer. - -Signature: - -```typescript -incrementMetric(metricName: string, num?: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| metricName | string | The name of the custom metric. | -| num | number | The number to be added to the value of the custom metric. If not provided, it uses a default value of one. | - -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.md b/docs-exp/performance-types.performancetrace.md deleted file mode 100644 index 8aee6d4b9d3..00000000000 --- a/docs-exp/performance-types.performancetrace.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) - -## PerformanceTrace interface - - -Signature: - -```typescript -export interface PerformanceTrace -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getAttribute(attr)](./performance-types.performancetrace.getattribute.md) | Retrieves the value which a custom attribute is set to. | -| [getAttributes()](./performance-types.performancetrace.getattributes.md) | Returns a map of all custom attributes of a trace instance. | -| [getMetric(metricName)](./performance-types.performancetrace.getmetric.md) | Returns the value of the custom metric by that name. If a custom metric with that name does not exist will return zero. | -| [incrementMetric(metricName, num)](./performance-types.performancetrace.incrementmetric.md) | Adds to the value of a custom metric. If a custom metric with the provided name does not exist, it creates one with that name and the value equal to the given number. The value will be floored down to an integer. | -| [putAttribute(attr, value)](./performance-types.performancetrace.putattribute.md) | Set a custom attribute of a trace to a certain value. | -| [putMetric(metricName, num)](./performance-types.performancetrace.putmetric.md) | Sets the value of the specified custom metric to the given number regardless of whether a metric with that name already exists on the trace instance or not. The value will be floored down to an integer. | -| [record(startTime, duration, options)](./performance-types.performancetrace.record.md) | Records a trace from given parameters. This provides a direct way to use trace without a need to start/stop. This is useful for use cases in which the trace cannot directly be used (e.g. if the duration was captured before the Performance SDK was loaded). | -| [removeAttribute(attr)](./performance-types.performancetrace.removeattribute.md) | Removes the specified custom attribute from a trace instance. | -| [start()](./performance-types.performancetrace.start.md) | Starts the timing for the trace instance. | -| [stop()](./performance-types.performancetrace.stop.md) | Stops the timing of the trace instance and logs the data of the instance. | - diff --git a/docs-exp/performance-types.performancetrace.putattribute.md b/docs-exp/performance-types.performancetrace.putattribute.md deleted file mode 100644 index 1ca92e74305..00000000000 --- a/docs-exp/performance-types.performancetrace.putattribute.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [putAttribute](./performance-types.performancetrace.putattribute.md) - -## PerformanceTrace.putAttribute() method - -Set a custom attribute of a trace to a certain value. - -Signature: - -```typescript -putAttribute(attr: string, value: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| attr | string | Name of the custom attribute. | -| value | string | Value of the custom attribute. | - -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.putmetric.md b/docs-exp/performance-types.performancetrace.putmetric.md deleted file mode 100644 index 382d5995fff..00000000000 --- a/docs-exp/performance-types.performancetrace.putmetric.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [putMetric](./performance-types.performancetrace.putmetric.md) - -## PerformanceTrace.putMetric() method - -Sets the value of the specified custom metric to the given number regardless of whether a metric with that name already exists on the trace instance or not. The value will be floored down to an integer. - -Signature: - -```typescript -putMetric(metricName: string, num: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| metricName | string | Name of the custom metric. | -| num | number | Value to of the custom metric. | - -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.record.md b/docs-exp/performance-types.performancetrace.record.md deleted file mode 100644 index e0db9fceeb9..00000000000 --- a/docs-exp/performance-types.performancetrace.record.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [record](./performance-types.performancetrace.record.md) - -## PerformanceTrace.record() method - -Records a trace from given parameters. This provides a direct way to use trace without a need to start/stop. This is useful for use cases in which the trace cannot directly be used (e.g. if the duration was captured before the Performance SDK was loaded). - -Signature: - -```typescript -record( - startTime: number, - duration: number, - options?: { - metrics?: { [key: string]: number }; - attributes?: { [key: string]: string }; - } - ): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| startTime | number | trace start time since epoch in millisec. | -| duration | number | The duraction of the trace in millisec. | -| options | { metrics?: { \[key: string\]: number }; attributes?: { \[key: string\]: string }; } | An object which can optionally hold maps of custom metrics and custom attributes. | - -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.removeattribute.md b/docs-exp/performance-types.performancetrace.removeattribute.md deleted file mode 100644 index fe780253110..00000000000 --- a/docs-exp/performance-types.performancetrace.removeattribute.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [removeAttribute](./performance-types.performancetrace.removeattribute.md) - -## PerformanceTrace.removeAttribute() method - -Removes the specified custom attribute from a trace instance. - -Signature: - -```typescript -removeAttribute(attr: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| attr | string | Name of the custom attribute. | - -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.start.md b/docs-exp/performance-types.performancetrace.start.md deleted file mode 100644 index ad3a01a29a3..00000000000 --- a/docs-exp/performance-types.performancetrace.start.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [start](./performance-types.performancetrace.start.md) - -## PerformanceTrace.start() method - -Starts the timing for the trace instance. - -Signature: - -```typescript -start(): void; -``` -Returns: - -void - diff --git a/docs-exp/performance-types.performancetrace.stop.md b/docs-exp/performance-types.performancetrace.stop.md deleted file mode 100644 index a4e2ed2f5d0..00000000000 --- a/docs-exp/performance-types.performancetrace.stop.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance-types](./performance-types.md) > [PerformanceTrace](./performance-types.performancetrace.md) > [stop](./performance-types.performancetrace.stop.md) - -## PerformanceTrace.stop() method - -Stops the timing of the trace instance and logs the data of the instance. - -Signature: - -```typescript -stop(): void; -``` -Returns: - -void - diff --git a/docs-exp/performance.getperformance.md b/docs-exp/performance.getperformance.md index 114bbc62f50..a9adcf5e5a7 100644 --- a/docs-exp/performance.getperformance.md +++ b/docs-exp/performance.getperformance.md @@ -9,7 +9,7 @@ Returns a FirebasePerformance instance for the given app. Signature: ```typescript -export declare function getPerformance(app: FirebaseApp): FirebasePerformance; +export declare function getPerformance(app?: FirebaseApp): FirebasePerformance; ``` ## Parameters diff --git a/docs-exp/remote-config-types.fetchstatus.md b/docs-exp/remote-config-types.fetchstatus.md deleted file mode 100644 index 6ed61d1b661..00000000000 --- a/docs-exp/remote-config-types.fetchstatus.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [FetchStatus](./remote-config-types.fetchstatus.md) - -## FetchStatus type - -Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server. - -
  • "no-fetch-yet" indicates the [RemoteConfig](./remote-config-types.remoteconfig.md) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.
  • "success" indicates the last attempt succeeded.
  • "failure" indicates the last attempt failed.
  • "throttle" indicates the last attempt was rate-limited.
- -Signature: - -```typescript -export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle'; -``` diff --git a/docs-exp/remote-config-types.loglevel.md b/docs-exp/remote-config-types.loglevel.md deleted file mode 100644 index 60cec26a76a..00000000000 --- a/docs-exp/remote-config-types.loglevel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [LogLevel](./remote-config-types.loglevel.md) - -## LogLevel type - -Defines levels of Remote Config logging. - -Signature: - -```typescript -export type LogLevel = 'debug' | 'error' | 'silent'; -``` diff --git a/docs-exp/remote-config-types.md b/docs-exp/remote-config-types.md deleted file mode 100644 index 5ebb2cd3480..00000000000 --- a/docs-exp/remote-config-types.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) - -## remote-config-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [RemoteConfig](./remote-config-types.remoteconfig.md) | The Firebase Remote Config service interface. | -| [Settings](./remote-config-types.settings.md) | Defines configuration options for the Remote Config SDK. | -| [Value](./remote-config-types.value.md) | Wraps a value with metadata and type-safe getters. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [FetchStatus](./remote-config-types.fetchstatus.md) | Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
  • "no-fetch-yet" indicates the [RemoteConfig](./remote-config-types.remoteconfig.md) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.
  • "success" indicates the last attempt succeeded.
  • "failure" indicates the last attempt failed.
  • "throttle" indicates the last attempt was rate-limited.
| -| [LogLevel](./remote-config-types.loglevel.md) | Defines levels of Remote Config logging. | -| [ValueSource](./remote-config-types.valuesource.md) | Indicates the source of a value.
  • "static" indicates the value was defined by a static constant.
  • "default" indicates the value was defined by default config.
  • "remote" indicates the value was defined by fetched config.
| - diff --git a/docs-exp/remote-config-types.remoteconfig.defaultconfig.md b/docs-exp/remote-config-types.remoteconfig.defaultconfig.md deleted file mode 100644 index 3d4beb37995..00000000000 --- a/docs-exp/remote-config-types.remoteconfig.defaultconfig.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [defaultConfig](./remote-config-types.remoteconfig.defaultconfig.md) - -## RemoteConfig.defaultConfig property - -Object containing default values for conigs. - -Signature: - -```typescript -defaultConfig: { [key: string]: string | number | boolean }; -``` diff --git a/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md b/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md deleted file mode 100644 index c1290ee7142..00000000000 --- a/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [fetchTimeMillis](./remote-config-types.remoteconfig.fetchtimemillis.md) - -## RemoteConfig.fetchTimeMillis property - -The Unix timestamp in milliseconds of the last successful fetch, or negative one if the [RemoteConfig](./remote-config-types.remoteconfig.md) instance either hasn't fetched or initialization is incomplete. - -Signature: - -```typescript -fetchTimeMillis: number; -``` diff --git a/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md b/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md deleted file mode 100644 index 6a2e7e48087..00000000000 --- a/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [lastFetchStatus](./remote-config-types.remoteconfig.lastfetchstatus.md) - -## RemoteConfig.lastFetchStatus property - -The status of the last fetch attempt. - -Signature: - -```typescript -lastFetchStatus: FetchStatus; -``` diff --git a/docs-exp/remote-config-types.remoteconfig.md b/docs-exp/remote-config-types.remoteconfig.md deleted file mode 100644 index e73d6446dfb..00000000000 --- a/docs-exp/remote-config-types.remoteconfig.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) - -## RemoteConfig interface - -The Firebase Remote Config service interface. - -Signature: - -```typescript -export interface RemoteConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultConfig](./remote-config-types.remoteconfig.defaultconfig.md) | { \[key: string\]: string \| number \| boolean } | Object containing default values for conigs. | -| [fetchTimeMillis](./remote-config-types.remoteconfig.fetchtimemillis.md) | number | The Unix timestamp in milliseconds of the last successful fetch, or negative one if the [RemoteConfig](./remote-config-types.remoteconfig.md) instance either hasn't fetched or initialization is incomplete. | -| [lastFetchStatus](./remote-config-types.remoteconfig.lastfetchstatus.md) | [FetchStatus](./remote-config-types.fetchstatus.md) | The status of the last fetch attempt. | -| [settings](./remote-config-types.remoteconfig.settings.md) | [Settings](./remote-config-types.settings.md) | Defines configuration for the Remote Config SDK. | - diff --git a/docs-exp/remote-config-types.remoteconfig.settings.md b/docs-exp/remote-config-types.remoteconfig.settings.md deleted file mode 100644 index b16b127dd47..00000000000 --- a/docs-exp/remote-config-types.remoteconfig.settings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [settings](./remote-config-types.remoteconfig.settings.md) - -## RemoteConfig.settings property - -Defines configuration for the Remote Config SDK. - -Signature: - -```typescript -settings: Settings; -``` diff --git a/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md b/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md deleted file mode 100644 index d504bfd9ca2..00000000000 --- a/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) > [fetchTimeoutMillis](./remote-config-types.settings.fetchtimeoutmillis.md) - -## Settings.fetchTimeoutMillis property - -Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server. Defaults to 60000 (One minute). - -Signature: - -```typescript -fetchTimeoutMillis: number; -``` diff --git a/docs-exp/remote-config-types.settings.md b/docs-exp/remote-config-types.settings.md deleted file mode 100644 index d75b0587519..00000000000 --- a/docs-exp/remote-config-types.settings.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) - -## Settings interface - -Defines configuration options for the Remote Config SDK. - -Signature: - -```typescript -export interface Settings -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fetchTimeoutMillis](./remote-config-types.settings.fetchtimeoutmillis.md) | number | Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server. Defaults to 60000 (One minute). | -| [minimumFetchIntervalMillis](./remote-config-types.settings.minimumfetchintervalmillis.md) | number | Defines the maximum age in milliseconds of an entry in the config cache before it is considered stale. Defaults to 43200000 (Twelve hours). | - diff --git a/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md b/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md deleted file mode 100644 index 8036e67e19c..00000000000 --- a/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) > [minimumFetchIntervalMillis](./remote-config-types.settings.minimumfetchintervalmillis.md) - -## Settings.minimumFetchIntervalMillis property - -Defines the maximum age in milliseconds of an entry in the config cache before it is considered stale. Defaults to 43200000 (Twelve hours). - -Signature: - -```typescript -minimumFetchIntervalMillis: number; -``` diff --git a/docs-exp/remote-config-types.value.asboolean.md b/docs-exp/remote-config-types.value.asboolean.md deleted file mode 100644 index 9018551584f..00000000000 --- a/docs-exp/remote-config-types.value.asboolean.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asBoolean](./remote-config-types.value.asboolean.md) - -## Value.asBoolean() method - -Gets the value as a boolean. - -The following values (case insensitive) are interpreted as true: "1", "true", "t", "yes", "y", "on". Other values are interpreted as false. - -Signature: - -```typescript -asBoolean(): boolean; -``` -Returns: - -boolean - diff --git a/docs-exp/remote-config-types.value.asnumber.md b/docs-exp/remote-config-types.value.asnumber.md deleted file mode 100644 index 6d79f1b9235..00000000000 --- a/docs-exp/remote-config-types.value.asnumber.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asNumber](./remote-config-types.value.asnumber.md) - -## Value.asNumber() method - -Gets the value as a number. Comparable to calling Number(value) \|\| 0. - -Signature: - -```typescript -asNumber(): number; -``` -Returns: - -number - diff --git a/docs-exp/remote-config-types.value.asstring.md b/docs-exp/remote-config-types.value.asstring.md deleted file mode 100644 index 2d4a68670cc..00000000000 --- a/docs-exp/remote-config-types.value.asstring.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asString](./remote-config-types.value.asstring.md) - -## Value.asString() method - -Gets the value as a string. - -Signature: - -```typescript -asString(): string; -``` -Returns: - -string - diff --git a/docs-exp/remote-config-types.value.getsource.md b/docs-exp/remote-config-types.value.getsource.md deleted file mode 100644 index 29009c0c723..00000000000 --- a/docs-exp/remote-config-types.value.getsource.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [getSource](./remote-config-types.value.getsource.md) - -## Value.getSource() method - -Gets the [ValueSource](./remote-config-types.valuesource.md) for the given key. - -Signature: - -```typescript -getSource(): ValueSource; -``` -Returns: - -[ValueSource](./remote-config-types.valuesource.md) - diff --git a/docs-exp/remote-config-types.value.md b/docs-exp/remote-config-types.value.md deleted file mode 100644 index da56fac4c97..00000000000 --- a/docs-exp/remote-config-types.value.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) - -## Value interface - -Wraps a value with metadata and type-safe getters. - -Signature: - -```typescript -export interface Value -``` - -## Methods - -| Method | Description | -| --- | --- | -| [asBoolean()](./remote-config-types.value.asboolean.md) | Gets the value as a boolean.The following values (case insensitive) are interpreted as true: "1", "true", "t", "yes", "y", "on". Other values are interpreted as false. | -| [asNumber()](./remote-config-types.value.asnumber.md) | Gets the value as a number. Comparable to calling Number(value) \|\| 0. | -| [asString()](./remote-config-types.value.asstring.md) | Gets the value as a string. | -| [getSource()](./remote-config-types.value.getsource.md) | Gets the [ValueSource](./remote-config-types.valuesource.md) for the given key. | - diff --git a/docs-exp/remote-config-types.valuesource.md b/docs-exp/remote-config-types.valuesource.md deleted file mode 100644 index 7ea1942be7d..00000000000 --- a/docs-exp/remote-config-types.valuesource.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [ValueSource](./remote-config-types.valuesource.md) - -## ValueSource type - -Indicates the source of a value. - -
  • "static" indicates the value was defined by a static constant.
  • "default" indicates the value was defined by default config.
  • "remote" indicates the value was defined by fetched config.
- -Signature: - -```typescript -export type ValueSource = 'static' | 'default' | 'remote'; -``` diff --git a/docs-exp/remote-config.getremoteconfig.md b/docs-exp/remote-config.getremoteconfig.md index f87ce033bce..cf5600b8c23 100644 --- a/docs-exp/remote-config.getremoteconfig.md +++ b/docs-exp/remote-config.getremoteconfig.md @@ -7,7 +7,7 @@ Signature: ```typescript -export declare function getRemoteConfig(app: FirebaseApp): RemoteConfig; +export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig; ``` ## Parameters diff --git a/docs-exp/remote-config.getvalue.md b/docs-exp/remote-config.getvalue.md index 72b683934f4..2084cbd4dac 100644 --- a/docs-exp/remote-config.getvalue.md +++ b/docs-exp/remote-config.getvalue.md @@ -4,7 +4,7 @@ ## getValue() function -Gets the [Value](./remote-config-types.value.md) for the given key. +Gets the [Value](./remote-config.value.md) for the given key. Signature: diff --git a/docs-exp/remote-config.md b/docs-exp/remote-config.md index c1d0286d346..3098af0efe4 100644 --- a/docs-exp/remote-config.md +++ b/docs-exp/remote-config.md @@ -17,7 +17,7 @@ | [getNumber(remoteConfig, key)](./remote-config.getnumber.md) | Gets the value for the given key as a number.Convenience method for calling remoteConfig.getValue(key).asNumber(). | | [getRemoteConfig(app)](./remote-config.getremoteconfig.md) | | | [getString(remoteConfig, key)](./remote-config.getstring.md) | Gets the value for the given key as a String. Convenience method for calling remoteConfig.getValue(key).asString(). | -| [getValue(remoteConfig, key)](./remote-config.getvalue.md) | Gets the [Value](./remote-config-types.value.md) for the given key. | +| [getValue(remoteConfig, key)](./remote-config.getvalue.md) | Gets the [Value](./remote-config.value.md) for the given key. | | [setLogLevel(remoteConfig, logLevel)](./remote-config.setloglevel.md) | Defines the log level to use. | ## Interfaces diff --git a/docs-exp/storage-types.firebasestorageerror.md b/docs-exp/storage-types.firebasestorageerror.md deleted file mode 100644 index 10a666a4dbc..00000000000 --- a/docs-exp/storage-types.firebasestorageerror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FirebaseStorageError](./storage-types.firebasestorageerror.md) - -## FirebaseStorageError interface - -An error returned by the Firebase Storage SDK. - -Signature: - -```typescript -interface FirebaseStorageError extends FirebaseError -``` -Extends: FirebaseError - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [serverResponse](./storage-types.firebasestorageerror.serverresponse.md) | string \| null | A server response message for the error, if applicable. | - diff --git a/docs-exp/storage-types.firebasestorageerror.serverresponse.md b/docs-exp/storage-types.firebasestorageerror.serverresponse.md deleted file mode 100644 index 035951a6ec3..00000000000 --- a/docs-exp/storage-types.firebasestorageerror.serverresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FirebaseStorageError](./storage-types.firebasestorageerror.md) > [serverResponse](./storage-types.firebasestorageerror.serverresponse.md) - -## FirebaseStorageError.serverResponse property - -A server response message for the error, if applicable. - -Signature: - -```typescript -serverResponse: string | null; -``` diff --git a/docs-exp/storage-types.fullmetadata.bucket.md b/docs-exp/storage-types.fullmetadata.bucket.md deleted file mode 100644 index 01abc9f6f64..00000000000 --- a/docs-exp/storage-types.fullmetadata.bucket.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [bucket](./storage-types.fullmetadata.bucket.md) - -## FullMetadata.bucket property - -The bucket this object is contained in. - -Signature: - -```typescript -bucket: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.downloadtokens.md b/docs-exp/storage-types.fullmetadata.downloadtokens.md deleted file mode 100644 index 94eba944e0e..00000000000 --- a/docs-exp/storage-types.fullmetadata.downloadtokens.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [downloadTokens](./storage-types.fullmetadata.downloadtokens.md) - -## FullMetadata.downloadTokens property - -Tokens to allow access to the downloatd URL. - -Signature: - -```typescript -downloadTokens: string[] | undefined; -``` diff --git a/docs-exp/storage-types.fullmetadata.fullpath.md b/docs-exp/storage-types.fullmetadata.fullpath.md deleted file mode 100644 index 269077e9bf5..00000000000 --- a/docs-exp/storage-types.fullmetadata.fullpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [fullPath](./storage-types.fullmetadata.fullpath.md) - -## FullMetadata.fullPath property - -The full path of this object. - -Signature: - -```typescript -fullPath: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.generation.md b/docs-exp/storage-types.fullmetadata.generation.md deleted file mode 100644 index e9f40d89d74..00000000000 --- a/docs-exp/storage-types.fullmetadata.generation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [generation](./storage-types.fullmetadata.generation.md) - -## FullMetadata.generation property - -The object's generation. [https://cloud.google.com/storage/docs/generations-preconditions](https://cloud.google.com/storage/docs/generations-preconditions) - -Signature: - -```typescript -generation: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.md b/docs-exp/storage-types.fullmetadata.md deleted file mode 100644 index 838580d2ae0..00000000000 --- a/docs-exp/storage-types.fullmetadata.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) - -## FullMetadata interface - -The full set of object metadata, including read-only properties. - -Signature: - -```typescript -export interface FullMetadata extends UploadMetadata -``` -Extends: [UploadMetadata](./storage-types.uploadmetadata.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [bucket](./storage-types.fullmetadata.bucket.md) | string | The bucket this object is contained in. | -| [downloadTokens](./storage-types.fullmetadata.downloadtokens.md) | string\[\] \| undefined | Tokens to allow access to the downloatd URL. | -| [fullPath](./storage-types.fullmetadata.fullpath.md) | string | The full path of this object. | -| [generation](./storage-types.fullmetadata.generation.md) | string | The object's generation. [https://cloud.google.com/storage/docs/generations-preconditions](https://cloud.google.com/storage/docs/generations-preconditions) | -| [metageneration](./storage-types.fullmetadata.metageneration.md) | string | The object's metageneration. [https://cloud.google.com/storage/docs/generations-preconditions](https://cloud.google.com/storage/docs/generations-preconditions) | -| [name](./storage-types.fullmetadata.name.md) | string | The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'. | -| [ref](./storage-types.fullmetadata.ref.md) | [StorageReference](./storage-types.storagereference.md) \| undefined | StorageReference associated with this upload. | -| [size](./storage-types.fullmetadata.size.md) | number | The size of this object, in bytes. | -| [timeCreated](./storage-types.fullmetadata.timecreated.md) | string | A date string representing when this object was created. | -| [updated](./storage-types.fullmetadata.updated.md) | string | A date string representing when this object was last updated. | - diff --git a/docs-exp/storage-types.fullmetadata.metageneration.md b/docs-exp/storage-types.fullmetadata.metageneration.md deleted file mode 100644 index d1b6fdbaccd..00000000000 --- a/docs-exp/storage-types.fullmetadata.metageneration.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [metageneration](./storage-types.fullmetadata.metageneration.md) - -## FullMetadata.metageneration property - -The object's metageneration. [https://cloud.google.com/storage/docs/generations-preconditions](https://cloud.google.com/storage/docs/generations-preconditions) - -Signature: - -```typescript -metageneration: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.name.md b/docs-exp/storage-types.fullmetadata.name.md deleted file mode 100644 index ba1e9219f64..00000000000 --- a/docs-exp/storage-types.fullmetadata.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [name](./storage-types.fullmetadata.name.md) - -## FullMetadata.name property - -The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'. - -Signature: - -```typescript -name: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.ref.md b/docs-exp/storage-types.fullmetadata.ref.md deleted file mode 100644 index 2e60afc5522..00000000000 --- a/docs-exp/storage-types.fullmetadata.ref.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [ref](./storage-types.fullmetadata.ref.md) - -## FullMetadata.ref property - -`StorageReference` associated with this upload. - -Signature: - -```typescript -ref?: StorageReference | undefined; -``` diff --git a/docs-exp/storage-types.fullmetadata.size.md b/docs-exp/storage-types.fullmetadata.size.md deleted file mode 100644 index 230c32d7e4d..00000000000 --- a/docs-exp/storage-types.fullmetadata.size.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [size](./storage-types.fullmetadata.size.md) - -## FullMetadata.size property - -The size of this object, in bytes. - -Signature: - -```typescript -size: number; -``` diff --git a/docs-exp/storage-types.fullmetadata.timecreated.md b/docs-exp/storage-types.fullmetadata.timecreated.md deleted file mode 100644 index aa356ebfed1..00000000000 --- a/docs-exp/storage-types.fullmetadata.timecreated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [timeCreated](./storage-types.fullmetadata.timecreated.md) - -## FullMetadata.timeCreated property - -A date string representing when this object was created. - -Signature: - -```typescript -timeCreated: string; -``` diff --git a/docs-exp/storage-types.fullmetadata.updated.md b/docs-exp/storage-types.fullmetadata.updated.md deleted file mode 100644 index a185edee242..00000000000 --- a/docs-exp/storage-types.fullmetadata.updated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [FullMetadata](./storage-types.fullmetadata.md) > [updated](./storage-types.fullmetadata.updated.md) - -## FullMetadata.updated property - -A date string representing when this object was last updated. - -Signature: - -```typescript -updated: string; -``` diff --git a/docs-exp/storage-types.listoptions.maxresults.md b/docs-exp/storage-types.listoptions.maxresults.md deleted file mode 100644 index ca198c7fcf2..00000000000 --- a/docs-exp/storage-types.listoptions.maxresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListOptions](./storage-types.listoptions.md) > [maxResults](./storage-types.listoptions.maxresults.md) - -## ListOptions.maxResults property - -If set, limits the total number of `prefixes` and `items` to return. The default and maximum maxResults is 1000. - -Signature: - -```typescript -maxResults?: number | null; -``` diff --git a/docs-exp/storage-types.listoptions.md b/docs-exp/storage-types.listoptions.md deleted file mode 100644 index 1f43bf2d7e7..00000000000 --- a/docs-exp/storage-types.listoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListOptions](./storage-types.listoptions.md) - -## ListOptions interface - -The options `list()` accepts. - -Signature: - -```typescript -export interface ListOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxResults](./storage-types.listoptions.maxresults.md) | number \| null | If set, limits the total number of prefixes and items to return. The default and maximum maxResults is 1000. | -| [pageToken](./storage-types.listoptions.pagetoken.md) | string \| null | The nextPageToken from a previous call to list(). If provided, listing is resumed from the previous position. | - diff --git a/docs-exp/storage-types.listoptions.pagetoken.md b/docs-exp/storage-types.listoptions.pagetoken.md deleted file mode 100644 index da71fb3cbeb..00000000000 --- a/docs-exp/storage-types.listoptions.pagetoken.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListOptions](./storage-types.listoptions.md) > [pageToken](./storage-types.listoptions.pagetoken.md) - -## ListOptions.pageToken property - -The `nextPageToken` from a previous call to `list()`. If provided, listing is resumed from the previous position. - -Signature: - -```typescript -pageToken?: string | null; -``` diff --git a/docs-exp/storage-types.listresult.items.md b/docs-exp/storage-types.listresult.items.md deleted file mode 100644 index bbc274b2509..00000000000 --- a/docs-exp/storage-types.listresult.items.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListResult](./storage-types.listresult.md) > [items](./storage-types.listresult.items.md) - -## ListResult.items property - -Objects in this directory. You can call getMetadata() and getDownloadUrl() on them. - -Signature: - -```typescript -items: StorageReference[]; -``` diff --git a/docs-exp/storage-types.listresult.md b/docs-exp/storage-types.listresult.md deleted file mode 100644 index d4e0e2ad38a..00000000000 --- a/docs-exp/storage-types.listresult.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListResult](./storage-types.listresult.md) - -## ListResult interface - -Result returned by list(). - -Signature: - -```typescript -export interface ListResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [items](./storage-types.listresult.items.md) | [StorageReference](./storage-types.storagereference.md)\[\] | Objects in this directory. You can call getMetadata() and getDownloadUrl() on them. | -| [nextPageToken](./storage-types.listresult.nextpagetoken.md) | string | If set, there might be more results for this list. Use this token to resume the list. | -| [prefixes](./storage-types.listresult.prefixes.md) | [StorageReference](./storage-types.storagereference.md)\[\] | References to prefixes (sub-folders). You can call list() on them to get its contents.Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix. | - diff --git a/docs-exp/storage-types.listresult.nextpagetoken.md b/docs-exp/storage-types.listresult.nextpagetoken.md deleted file mode 100644 index daaac4b17e7..00000000000 --- a/docs-exp/storage-types.listresult.nextpagetoken.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListResult](./storage-types.listresult.md) > [nextPageToken](./storage-types.listresult.nextpagetoken.md) - -## ListResult.nextPageToken property - -If set, there might be more results for this list. Use this token to resume the list. - -Signature: - -```typescript -nextPageToken?: string; -``` diff --git a/docs-exp/storage-types.listresult.prefixes.md b/docs-exp/storage-types.listresult.prefixes.md deleted file mode 100644 index 4c96f2cce57..00000000000 --- a/docs-exp/storage-types.listresult.prefixes.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [ListResult](./storage-types.listresult.md) > [prefixes](./storage-types.listresult.prefixes.md) - -## ListResult.prefixes property - -References to prefixes (sub-folders). You can call list() on them to get its contents. - -Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix. - -Signature: - -```typescript -prefixes: StorageReference[]; -``` diff --git a/docs-exp/storage-types.md b/docs-exp/storage-types.md deleted file mode 100644 index c2e8d6ceafa..00000000000 --- a/docs-exp/storage-types.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) - -## storage-types package - -## Interfaces - -| Interface | Description | -| --- | --- | -| [FirebaseStorageError](./storage-types.firebasestorageerror.md) | An error returned by the Firebase Storage SDK. | -| [FullMetadata](./storage-types.fullmetadata.md) | The full set of object metadata, including read-only properties. | -| [ListOptions](./storage-types.listoptions.md) | The options list() accepts. | -| [ListResult](./storage-types.listresult.md) | Result returned by list(). | -| [SettableMetadata](./storage-types.settablemetadata.md) | Object metadata that can be set at any time. | -| [StorageObserver](./storage-types.storageobserver.md) | A stream observer for Firebase Storage. | -| [StorageReference](./storage-types.storagereference.md) | Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata. | -| [StorageService](./storage-types.storageservice.md) | A Firebase Storage instance. | -| [UploadMetadata](./storage-types.uploadmetadata.md) | Object metadata that can be set at upload. | -| [UploadResult](./storage-types.uploadresult.md) | Result returned from a non-resumable upload. | -| [UploadTask](./storage-types.uploadtask.md) | Represents the process of uploading an object. Allows you to monitor and manage the upload. | -| [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) | Holds data about the current state of the upload task. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [TaskEvent](./storage-types.taskevent.md) | An event that is triggered on a task. | -| [TaskState](./storage-types.taskstate.md) | Represents the current state of a running upload. | - diff --git a/docs-exp/storage-types.settablemetadata.cachecontrol.md b/docs-exp/storage-types.settablemetadata.cachecontrol.md deleted file mode 100644 index 30013a512e1..00000000000 --- a/docs-exp/storage-types.settablemetadata.cachecontrol.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [cacheControl](./storage-types.settablemetadata.cachecontrol.md) - -## SettableMetadata.cacheControl property - -Served as the 'Cache-Control' header on object download. - -Signature: - -```typescript -cacheControl?: string | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.contentdisposition.md b/docs-exp/storage-types.settablemetadata.contentdisposition.md deleted file mode 100644 index 43df222800c..00000000000 --- a/docs-exp/storage-types.settablemetadata.contentdisposition.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [contentDisposition](./storage-types.settablemetadata.contentdisposition.md) - -## SettableMetadata.contentDisposition property - -Served as the 'Content-Disposition' header on object download. - -Signature: - -```typescript -contentDisposition?: string | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.contentencoding.md b/docs-exp/storage-types.settablemetadata.contentencoding.md deleted file mode 100644 index 2ee1cf8f0cc..00000000000 --- a/docs-exp/storage-types.settablemetadata.contentencoding.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [contentEncoding](./storage-types.settablemetadata.contentencoding.md) - -## SettableMetadata.contentEncoding property - -Served as the 'Content-Encoding' header on object download. - -Signature: - -```typescript -contentEncoding?: string | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.contentlanguage.md b/docs-exp/storage-types.settablemetadata.contentlanguage.md deleted file mode 100644 index fcf70181442..00000000000 --- a/docs-exp/storage-types.settablemetadata.contentlanguage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [contentLanguage](./storage-types.settablemetadata.contentlanguage.md) - -## SettableMetadata.contentLanguage property - -Served as the 'Content-Language' header on object download. - -Signature: - -```typescript -contentLanguage?: string | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.contenttype.md b/docs-exp/storage-types.settablemetadata.contenttype.md deleted file mode 100644 index 5636f2da972..00000000000 --- a/docs-exp/storage-types.settablemetadata.contenttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [contentType](./storage-types.settablemetadata.contenttype.md) - -## SettableMetadata.contentType property - -Served as the 'Content-Type' header on object download. - -Signature: - -```typescript -contentType?: string | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.custommetadata.md b/docs-exp/storage-types.settablemetadata.custommetadata.md deleted file mode 100644 index 393fc2a8e86..00000000000 --- a/docs-exp/storage-types.settablemetadata.custommetadata.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) > [customMetadata](./storage-types.settablemetadata.custommetadata.md) - -## SettableMetadata.customMetadata property - -Additional user-defined custom metadata. - -Signature: - -```typescript -customMetadata?: - | { - [key: string]: string; - } - | undefined; -``` diff --git a/docs-exp/storage-types.settablemetadata.md b/docs-exp/storage-types.settablemetadata.md deleted file mode 100644 index 8fda8ede743..00000000000 --- a/docs-exp/storage-types.settablemetadata.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [SettableMetadata](./storage-types.settablemetadata.md) - -## SettableMetadata interface - -Object metadata that can be set at any time. - -Signature: - -```typescript -export interface SettableMetadata -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [cacheControl](./storage-types.settablemetadata.cachecontrol.md) | string \| undefined | Served as the 'Cache-Control' header on object download. | -| [contentDisposition](./storage-types.settablemetadata.contentdisposition.md) | string \| undefined | Served as the 'Content-Disposition' header on object download. | -| [contentEncoding](./storage-types.settablemetadata.contentencoding.md) | string \| undefined | Served as the 'Content-Encoding' header on object download. | -| [contentLanguage](./storage-types.settablemetadata.contentlanguage.md) | string \| undefined | Served as the 'Content-Language' header on object download. | -| [contentType](./storage-types.settablemetadata.contenttype.md) | string \| undefined | Served as the 'Content-Type' header on object download. | -| [customMetadata](./storage-types.settablemetadata.custommetadata.md) | \| { \[key: string\]: string; } \| undefined | Additional user-defined custom metadata. | - diff --git a/docs-exp/storage-types.storageobserver.complete.md b/docs-exp/storage-types.storageobserver.complete.md deleted file mode 100644 index d47fb642d81..00000000000 --- a/docs-exp/storage-types.storageobserver.complete.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageObserver](./storage-types.storageobserver.md) > [complete](./storage-types.storageobserver.complete.md) - -## StorageObserver.complete property - -Signature: - -```typescript -complete?: CompleteFn | null; -``` diff --git a/docs-exp/storage-types.storageobserver.error.md b/docs-exp/storage-types.storageobserver.error.md deleted file mode 100644 index 2b9b016e35e..00000000000 --- a/docs-exp/storage-types.storageobserver.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageObserver](./storage-types.storageobserver.md) > [error](./storage-types.storageobserver.error.md) - -## StorageObserver.error property - -Signature: - -```typescript -error?: (error: FirebaseStorageError) => void | null; -``` diff --git a/docs-exp/storage-types.storageobserver.md b/docs-exp/storage-types.storageobserver.md deleted file mode 100644 index 00ae81dab5e..00000000000 --- a/docs-exp/storage-types.storageobserver.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageObserver](./storage-types.storageobserver.md) - -## StorageObserver interface - -A stream observer for Firebase Storage. - -Signature: - -```typescript -export interface StorageObserver -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [complete](./storage-types.storageobserver.complete.md) | CompleteFn \| null | | -| [error](./storage-types.storageobserver.error.md) | (error: [FirebaseStorageError](./storage-types.firebasestorageerror.md)) => void \| null | | -| [next](./storage-types.storageobserver.next.md) | NextFn<T> \| null | | - diff --git a/docs-exp/storage-types.storageobserver.next.md b/docs-exp/storage-types.storageobserver.next.md deleted file mode 100644 index 08aee77739a..00000000000 --- a/docs-exp/storage-types.storageobserver.next.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageObserver](./storage-types.storageobserver.md) > [next](./storage-types.storageobserver.next.md) - -## StorageObserver.next property - -Signature: - -```typescript -next?: NextFn | null; -``` diff --git a/docs-exp/storage-types.storagereference.bucket.md b/docs-exp/storage-types.storagereference.bucket.md deleted file mode 100644 index fef610edd43..00000000000 --- a/docs-exp/storage-types.storagereference.bucket.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [bucket](./storage-types.storagereference.bucket.md) - -## StorageReference.bucket property - -The name of the bucket containing this reference's object. - -Signature: - -```typescript -bucket: string; -``` diff --git a/docs-exp/storage-types.storagereference.fullpath.md b/docs-exp/storage-types.storagereference.fullpath.md deleted file mode 100644 index 0c3ab50d7e9..00000000000 --- a/docs-exp/storage-types.storagereference.fullpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [fullPath](./storage-types.storagereference.fullpath.md) - -## StorageReference.fullPath property - -The full path of this object. - -Signature: - -```typescript -fullPath: string; -``` diff --git a/docs-exp/storage-types.storagereference.md b/docs-exp/storage-types.storagereference.md deleted file mode 100644 index 552b39c5481..00000000000 --- a/docs-exp/storage-types.storagereference.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) - -## StorageReference interface - -Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata. - -Signature: - -```typescript -export interface StorageReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [bucket](./storage-types.storagereference.bucket.md) | string | The name of the bucket containing this reference's object. | -| [fullPath](./storage-types.storagereference.fullpath.md) | string | The full path of this object. | -| [name](./storage-types.storagereference.name.md) | string | The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'. | -| [parent](./storage-types.storagereference.parent.md) | [StorageReference](./storage-types.storagereference.md) \| null | A reference pointing to the parent location of this reference, or null if this reference is the root. | -| [root](./storage-types.storagereference.root.md) | [StorageReference](./storage-types.storagereference.md) | A reference to the root of this object's bucket. | -| [storage](./storage-types.storagereference.storage.md) | [StorageService](./storage-types.storageservice.md) | The StorageService associated with this reference. | - -## Methods - -| Method | Description | -| --- | --- | -| [toString()](./storage-types.storagereference.tostring.md) | Returns a gs:// URL for this object in the form gs://<bucket>/<path>/<to>/<object> | - diff --git a/docs-exp/storage-types.storagereference.name.md b/docs-exp/storage-types.storagereference.name.md deleted file mode 100644 index 70039bec43e..00000000000 --- a/docs-exp/storage-types.storagereference.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [name](./storage-types.storagereference.name.md) - -## StorageReference.name property - -The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'. - -Signature: - -```typescript -name: string; -``` diff --git a/docs-exp/storage-types.storagereference.parent.md b/docs-exp/storage-types.storagereference.parent.md deleted file mode 100644 index ed859df6c62..00000000000 --- a/docs-exp/storage-types.storagereference.parent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [parent](./storage-types.storagereference.parent.md) - -## StorageReference.parent property - -A reference pointing to the parent location of this reference, or null if this reference is the root. - -Signature: - -```typescript -parent: StorageReference | null; -``` diff --git a/docs-exp/storage-types.storagereference.root.md b/docs-exp/storage-types.storagereference.root.md deleted file mode 100644 index 86a503497d0..00000000000 --- a/docs-exp/storage-types.storagereference.root.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [root](./storage-types.storagereference.root.md) - -## StorageReference.root property - -A reference to the root of this object's bucket. - -Signature: - -```typescript -root: StorageReference; -``` diff --git a/docs-exp/storage-types.storagereference.storage.md b/docs-exp/storage-types.storagereference.storage.md deleted file mode 100644 index 3cae21c4b28..00000000000 --- a/docs-exp/storage-types.storagereference.storage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [storage](./storage-types.storagereference.storage.md) - -## StorageReference.storage property - -The StorageService associated with this reference. - -Signature: - -```typescript -storage: StorageService; -``` diff --git a/docs-exp/storage-types.storagereference.tostring.md b/docs-exp/storage-types.storagereference.tostring.md deleted file mode 100644 index c8c599dc9ae..00000000000 --- a/docs-exp/storage-types.storagereference.tostring.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageReference](./storage-types.storagereference.md) > [toString](./storage-types.storagereference.tostring.md) - -## StorageReference.toString() method - -Returns a gs:// URL for this object in the form `gs://///` - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - -The gs:// URL. - diff --git a/docs-exp/storage-types.storageservice.app.md b/docs-exp/storage-types.storageservice.app.md deleted file mode 100644 index 6a86b26997f..00000000000 --- a/docs-exp/storage-types.storageservice.app.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageService](./storage-types.storageservice.md) > [app](./storage-types.storageservice.app.md) - -## StorageService.app property - -FirebaseApp associated with this StorageService instance. - -Signature: - -```typescript -readonly app: FirebaseApp; -``` diff --git a/docs-exp/storage-types.storageservice.maxoperationretrytime.md b/docs-exp/storage-types.storageservice.maxoperationretrytime.md deleted file mode 100644 index 19192bc26e4..00000000000 --- a/docs-exp/storage-types.storageservice.maxoperationretrytime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageService](./storage-types.storageservice.md) > [maxOperationRetryTime](./storage-types.storageservice.maxoperationretrytime.md) - -## StorageService.maxOperationRetryTime property - -The maximum time to retry operations other than uploads or downloads in milliseconds. - -Signature: - -```typescript -maxOperationRetryTime: number; -``` diff --git a/docs-exp/storage-types.storageservice.maxuploadretrytime.md b/docs-exp/storage-types.storageservice.maxuploadretrytime.md deleted file mode 100644 index 3f8c5262636..00000000000 --- a/docs-exp/storage-types.storageservice.maxuploadretrytime.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageService](./storage-types.storageservice.md) > [maxUploadRetryTime](./storage-types.storageservice.maxuploadretrytime.md) - -## StorageService.maxUploadRetryTime property - -The maximum time to retry uploads in milliseconds. - -Signature: - -```typescript -maxUploadRetryTime: number; -``` diff --git a/docs-exp/storage-types.storageservice.md b/docs-exp/storage-types.storageservice.md deleted file mode 100644 index 5375fb9e236..00000000000 --- a/docs-exp/storage-types.storageservice.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [StorageService](./storage-types.storageservice.md) - -## StorageService interface - -A Firebase Storage instance. - -Signature: - -```typescript -export interface StorageService -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [app](./storage-types.storageservice.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | FirebaseApp associated with this StorageService instance. | -| [maxOperationRetryTime](./storage-types.storageservice.maxoperationretrytime.md) | number | The maximum time to retry operations other than uploads or downloads in milliseconds. | -| [maxUploadRetryTime](./storage-types.storageservice.maxuploadretrytime.md) | number | The maximum time to retry uploads in milliseconds. | - diff --git a/docs-exp/storage-types.taskevent.md b/docs-exp/storage-types.taskevent.md deleted file mode 100644 index 9819c558322..00000000000 --- a/docs-exp/storage-types.taskevent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [TaskEvent](./storage-types.taskevent.md) - -## TaskEvent type - -An event that is triggered on a task. - -Signature: - -```typescript -export type TaskEvent = 'state_changed'; -``` diff --git a/docs-exp/storage-types.taskstate.md b/docs-exp/storage-types.taskstate.md deleted file mode 100644 index 70b4f58758c..00000000000 --- a/docs-exp/storage-types.taskstate.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [TaskState](./storage-types.taskstate.md) - -## TaskState type - -Represents the current state of a running upload. - -Signature: - -```typescript -export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error'; -``` diff --git a/docs-exp/storage-types.uploadmetadata.md b/docs-exp/storage-types.uploadmetadata.md deleted file mode 100644 index b08da63ad09..00000000000 --- a/docs-exp/storage-types.uploadmetadata.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadMetadata](./storage-types.uploadmetadata.md) - -## UploadMetadata interface - -Object metadata that can be set at upload. - -Signature: - -```typescript -export interface UploadMetadata extends SettableMetadata -``` -Extends: [SettableMetadata](./storage-types.settablemetadata.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [md5Hash](./storage-types.uploadmetadata.md5hash.md) | string \| undefined | A Base64-encoded MD5 hash of the object being uploaded. | - diff --git a/docs-exp/storage-types.uploadmetadata.md5hash.md b/docs-exp/storage-types.uploadmetadata.md5hash.md deleted file mode 100644 index 4b41d2c9a44..00000000000 --- a/docs-exp/storage-types.uploadmetadata.md5hash.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadMetadata](./storage-types.uploadmetadata.md) > [md5Hash](./storage-types.uploadmetadata.md5hash.md) - -## UploadMetadata.md5Hash property - -A Base64-encoded MD5 hash of the object being uploaded. - -Signature: - -```typescript -md5Hash?: string | undefined; -``` diff --git a/docs-exp/storage-types.uploadresult.md b/docs-exp/storage-types.uploadresult.md deleted file mode 100644 index 280ab794c03..00000000000 --- a/docs-exp/storage-types.uploadresult.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadResult](./storage-types.uploadresult.md) - -## UploadResult interface - -Result returned from a non-resumable upload. - -Signature: - -```typescript -export interface UploadResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [metadata](./storage-types.uploadresult.metadata.md) | [FullMetadata](./storage-types.fullmetadata.md) | Contains the metadata sent back from the server. | -| [ref](./storage-types.uploadresult.ref.md) | [StorageReference](./storage-types.storagereference.md) | The reference that spawned this upload. | - diff --git a/docs-exp/storage-types.uploadresult.metadata.md b/docs-exp/storage-types.uploadresult.metadata.md deleted file mode 100644 index cfd72290b79..00000000000 --- a/docs-exp/storage-types.uploadresult.metadata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadResult](./storage-types.uploadresult.md) > [metadata](./storage-types.uploadresult.metadata.md) - -## UploadResult.metadata property - -Contains the metadata sent back from the server. - -Signature: - -```typescript -readonly metadata: FullMetadata; -``` diff --git a/docs-exp/storage-types.uploadresult.ref.md b/docs-exp/storage-types.uploadresult.ref.md deleted file mode 100644 index a1bb5c20250..00000000000 --- a/docs-exp/storage-types.uploadresult.ref.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadResult](./storage-types.uploadresult.md) > [ref](./storage-types.uploadresult.ref.md) - -## UploadResult.ref property - -The reference that spawned this upload. - -Signature: - -```typescript -readonly ref: StorageReference; -``` diff --git a/docs-exp/storage-types.uploadtask.cancel.md b/docs-exp/storage-types.uploadtask.cancel.md deleted file mode 100644 index 0e5f6dd6afe..00000000000 --- a/docs-exp/storage-types.uploadtask.cancel.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [cancel](./storage-types.uploadtask.cancel.md) - -## UploadTask.cancel() method - -Cancels a running task. Has no effect on a complete or failed task. - -Signature: - -```typescript -cancel(): boolean; -``` -Returns: - -boolean - -True if the cancel had an effect. - diff --git a/docs-exp/storage-types.uploadtask.catch.md b/docs-exp/storage-types.uploadtask.catch.md deleted file mode 100644 index bad3fa1a3b2..00000000000 --- a/docs-exp/storage-types.uploadtask.catch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [catch](./storage-types.uploadtask.catch.md) - -## UploadTask.catch() method - -Equivalent to calling `then(null, onRejected)`. - -Signature: - -```typescript -catch(onRejected: (error: FirebaseStorageError) => any): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| onRejected | (error: [FirebaseStorageError](./storage-types.firebasestorageerror.md)) => any | | - -Returns: - -Promise<any> - diff --git a/docs-exp/storage-types.uploadtask.md b/docs-exp/storage-types.uploadtask.md deleted file mode 100644 index 9fd79800d5a..00000000000 --- a/docs-exp/storage-types.uploadtask.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) - -## UploadTask interface - -Represents the process of uploading an object. Allows you to monitor and manage the upload. - -Signature: - -```typescript -export interface UploadTask -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [snapshot](./storage-types.uploadtask.snapshot.md) | [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) | A snapshot of the current task state. | - -## Methods - -| Method | Description | -| --- | --- | -| [cancel()](./storage-types.uploadtask.cancel.md) | Cancels a running task. Has no effect on a complete or failed task. | -| [catch(onRejected)](./storage-types.uploadtask.catch.md) | Equivalent to calling then(null, onRejected). | -| [on(event, nextOrObserver, error, complete)](./storage-types.uploadtask.on.md) | Listens for events on this task.Events have three callback functions (referred to as next, error, and complete).If only the event is passed, a function that can be used to register the callbacks is returned. Otherwise, the callbacks are passed after the event.Callbacks can be passed either as three separate arguments or as the next, error, and complete properties of an object. Any of the three callbacks is optional, as long as at least one is specified. In addition, when you add your callbacks, you get a function back. You can call this function to unregister the associated callbacks. | -| [pause()](./storage-types.uploadtask.pause.md) | Pauses a currently running task. Has no effect on a paused or failed task. | -| [resume()](./storage-types.uploadtask.resume.md) | Resumes a paused task. Has no effect on a currently running or failed task. | -| [then(onFulfilled, onRejected)](./storage-types.uploadtask.then.md) | This object behaves like a Promise, and resolves with its snapshot data when the upload completes. | - diff --git a/docs-exp/storage-types.uploadtask.on.md b/docs-exp/storage-types.uploadtask.on.md deleted file mode 100644 index 0c7a23a21f9..00000000000 --- a/docs-exp/storage-types.uploadtask.on.md +++ /dev/null @@ -1,134 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [on](./storage-types.uploadtask.on.md) - -## UploadTask.on() method - -Listens for events on this task. - -Events have three callback functions (referred to as `next`, `error`, and `complete`). - -If only the event is passed, a function that can be used to register the callbacks is returned. Otherwise, the callbacks are passed after the event. - -Callbacks can be passed either as three separate arguments or as the `next`, `error`, and `complete` properties of an object. Any of the three callbacks is optional, as long as at least one is specified. In addition, when you add your callbacks, you get a function back. You can call this function to unregister the associated callbacks. - -Signature: - -```typescript -on( - event: TaskEvent, - nextOrObserver?: - | StorageObserver - | null - | ((snapshot: UploadTaskSnapshot) => any), - error?: ((a: FirebaseStorageError) => any) | null, - complete?: Unsubscribe | null - ): Function; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [TaskEvent](./storage-types.taskevent.md) | The type of event to listen for. | -| nextOrObserver | \| [StorageObserver](./storage-types.storageobserver.md)<[UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md)> \| null \| ((snapshot: [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md)) => any) | The next function, which gets called for each item in the event stream, or an observer object with some or all of these three properties (next, error, complete). | -| error | ((a: [FirebaseStorageError](./storage-types.firebasestorageerror.md)) => any) \| null | A function that gets called with a FirebaseStorageError if the event stream ends due to an error. | -| complete | Unsubscribe \| null | | - -Returns: - -Function - -If only the event argument is passed, returns a function you can use to add callbacks (see the examples above). If more than just the event argument is passed, returns a function you can call to unregister the callbacks. - -## Example 1 - -\*\*Pass callbacks separately or in an object.\*\* - -```javascript -var next = function(snapshot) {}; -var error = function(error) {}; -var complete = function() {}; - -// The first example. -uploadTask.on( - firebase.storage.TaskEvent.STATE_CHANGED, - next, - error, - complete); - -// This is equivalent to the first example. -uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, { - 'next': next, - 'error': error, - 'complete': complete -}); - -// This is equivalent to the first example. -var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED); -subscribe(next, error, complete); - -// This is equivalent to the first example. -var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED); -subscribe({ - 'next': next, - 'error': error, - 'complete': complete -}); - -``` - -## Example 2 - -\*\*Any callback is optional.\*\* - -```javascript -// Just listening for completion, this is legal. -uploadTask.on( - firebase.storage.TaskEvent.STATE_CHANGED, - null, - null, - function() { - console.log('upload complete!'); - }); - -// Just listening for progress/state changes, this is legal. -uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, function(snapshot) { - var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100; - console.log(percent + "% done"); -}); - -// This is also legal. -uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, { - 'complete': function() { - console.log('upload complete!'); - } -}); - -``` - -## Example 3 - -\*\*Use the returned function to remove callbacks.\*\* - -```javascript -var unsubscribe = uploadTask.on( - firebase.storage.TaskEvent.STATE_CHANGED, - function(snapshot) { - var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100; - console.log(percent + "% done"); - // Stop after receiving one update. - unsubscribe(); - }); - -// This code is equivalent to the above. -var handle = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED); -unsubscribe = handle(function(snapshot) { - var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100; - console.log(percent + "% done"); - // Stop after receiving one update. - unsubscribe(); -}); - -``` - diff --git a/docs-exp/storage-types.uploadtask.pause.md b/docs-exp/storage-types.uploadtask.pause.md deleted file mode 100644 index dd9cb8f14e4..00000000000 --- a/docs-exp/storage-types.uploadtask.pause.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [pause](./storage-types.uploadtask.pause.md) - -## UploadTask.pause() method - -Pauses a currently running task. Has no effect on a paused or failed task. - -Signature: - -```typescript -pause(): boolean; -``` -Returns: - -boolean - -True if the operation took effect, false if ignored. - diff --git a/docs-exp/storage-types.uploadtask.resume.md b/docs-exp/storage-types.uploadtask.resume.md deleted file mode 100644 index 576318f3a18..00000000000 --- a/docs-exp/storage-types.uploadtask.resume.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [resume](./storage-types.uploadtask.resume.md) - -## UploadTask.resume() method - -Resumes a paused task. Has no effect on a currently running or failed task. - -Signature: - -```typescript -resume(): boolean; -``` -Returns: - -boolean - -True if the operation took effect, false if ignored. - diff --git a/docs-exp/storage-types.uploadtask.snapshot.md b/docs-exp/storage-types.uploadtask.snapshot.md deleted file mode 100644 index 93d1ec516f7..00000000000 --- a/docs-exp/storage-types.uploadtask.snapshot.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [snapshot](./storage-types.uploadtask.snapshot.md) - -## UploadTask.snapshot property - -A snapshot of the current task state. - -Signature: - -```typescript -snapshot: UploadTaskSnapshot; -``` diff --git a/docs-exp/storage-types.uploadtask.then.md b/docs-exp/storage-types.uploadtask.then.md deleted file mode 100644 index fea06322b1c..00000000000 --- a/docs-exp/storage-types.uploadtask.then.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTask](./storage-types.uploadtask.md) > [then](./storage-types.uploadtask.then.md) - -## UploadTask.then() method - -This object behaves like a Promise, and resolves with its snapshot data when the upload completes. - -Signature: - -```typescript -then( - onFulfilled?: ((snapshot: UploadTaskSnapshot) => any) | null, - onRejected?: ((error: FirebaseStorageError) => any) | null - ): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| onFulfilled | ((snapshot: [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md)) => any) \| null | The fulfillment callback. Promise chaining works as normal. | -| onRejected | ((error: [FirebaseStorageError](./storage-types.firebasestorageerror.md)) => any) \| null | The rejection callback. | - -Returns: - -Promise<any> - diff --git a/docs-exp/storage-types.uploadtasksnapshot.bytestransferred.md b/docs-exp/storage-types.uploadtasksnapshot.bytestransferred.md deleted file mode 100644 index 0a063ca2812..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.bytestransferred.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [bytesTransferred](./storage-types.uploadtasksnapshot.bytestransferred.md) - -## UploadTaskSnapshot.bytesTransferred property - -The number of bytes that have been successfully uploaded so far. - -Signature: - -```typescript -bytesTransferred: number; -``` diff --git a/docs-exp/storage-types.uploadtasksnapshot.md b/docs-exp/storage-types.uploadtasksnapshot.md deleted file mode 100644 index 34383159c56..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) - -## UploadTaskSnapshot interface - -Holds data about the current state of the upload task. - -Signature: - -```typescript -export interface UploadTaskSnapshot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [bytesTransferred](./storage-types.uploadtasksnapshot.bytestransferred.md) | number | The number of bytes that have been successfully uploaded so far. | -| [metadata](./storage-types.uploadtasksnapshot.metadata.md) | [FullMetadata](./storage-types.fullmetadata.md) | Before the upload completes, contains the metadata sent to the server. After the upload completes, contains the metadata sent back from the server. | -| [ref](./storage-types.uploadtasksnapshot.ref.md) | [StorageReference](./storage-types.storagereference.md) | The reference that spawned this snapshot's upload task. | -| [state](./storage-types.uploadtasksnapshot.state.md) | [TaskState](./storage-types.taskstate.md) | The current state of the task. | -| [task](./storage-types.uploadtasksnapshot.task.md) | [UploadTask](./storage-types.uploadtask.md) | The task of which this is a snapshot. | -| [totalBytes](./storage-types.uploadtasksnapshot.totalbytes.md) | number | The total number of bytes to be uploaded. | - diff --git a/docs-exp/storage-types.uploadtasksnapshot.metadata.md b/docs-exp/storage-types.uploadtasksnapshot.metadata.md deleted file mode 100644 index e1131f825a3..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.metadata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [metadata](./storage-types.uploadtasksnapshot.metadata.md) - -## UploadTaskSnapshot.metadata property - -Before the upload completes, contains the metadata sent to the server. After the upload completes, contains the metadata sent back from the server. - -Signature: - -```typescript -metadata: FullMetadata; -``` diff --git a/docs-exp/storage-types.uploadtasksnapshot.ref.md b/docs-exp/storage-types.uploadtasksnapshot.ref.md deleted file mode 100644 index 7e0f7498070..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.ref.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [ref](./storage-types.uploadtasksnapshot.ref.md) - -## UploadTaskSnapshot.ref property - -The reference that spawned this snapshot's upload task. - -Signature: - -```typescript -ref: StorageReference; -``` diff --git a/docs-exp/storage-types.uploadtasksnapshot.state.md b/docs-exp/storage-types.uploadtasksnapshot.state.md deleted file mode 100644 index 2e46e0a74de..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [state](./storage-types.uploadtasksnapshot.state.md) - -## UploadTaskSnapshot.state property - -The current state of the task. - -Signature: - -```typescript -state: TaskState; -``` diff --git a/docs-exp/storage-types.uploadtasksnapshot.task.md b/docs-exp/storage-types.uploadtasksnapshot.task.md deleted file mode 100644 index b26149372f7..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.task.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [task](./storage-types.uploadtasksnapshot.task.md) - -## UploadTaskSnapshot.task property - -The task of which this is a snapshot. - -Signature: - -```typescript -task: UploadTask; -``` diff --git a/docs-exp/storage-types.uploadtasksnapshot.totalbytes.md b/docs-exp/storage-types.uploadtasksnapshot.totalbytes.md deleted file mode 100644 index 3454ec4aa07..00000000000 --- a/docs-exp/storage-types.uploadtasksnapshot.totalbytes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@firebase/storage-types](./storage-types.md) > [UploadTaskSnapshot](./storage-types.uploadtasksnapshot.md) > [totalBytes](./storage-types.uploadtasksnapshot.totalbytes.md) - -## UploadTaskSnapshot.totalBytes property - -The total number of bytes to be uploaded. - -Signature: - -```typescript -totalBytes: number; -``` diff --git a/docs-exp/storage.getstorage.md b/docs-exp/storage.getstorage.md index aa35a0bf86b..9b3aee84f2a 100644 --- a/docs-exp/storage.getstorage.md +++ b/docs-exp/storage.getstorage.md @@ -9,7 +9,7 @@ Gets a Firebase StorageService instance for the given Firebase app. Signature: ```typescript -export declare function getStorage(app: FirebaseApp, bucketUrl?: string): StorageService; +export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): StorageService; ``` ## Parameters diff --git a/packages-exp/auth-exp/src/core/providers/saml.ts b/packages-exp/auth-exp/src/core/providers/saml.ts index 4a2c278cd18..e4378bb6d48 100644 --- a/packages-exp/auth-exp/src/core/providers/saml.ts +++ b/packages-exp/auth-exp/src/core/providers/saml.ts @@ -36,7 +36,7 @@ const SAML_PROVIDER_PREFIX = 'saml.'; export class SAMLAuthProvider extends FederatedAuthProvider { /** * Constructor. The providerId must start with "saml." - * @param providerId + * @param - providerId */ constructor(providerId: string) { _assert( diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts index 668f4c5b52b..bbd6c404605 100644 --- a/packages-exp/remote-config-exp/src/api.ts +++ b/packages-exp/remote-config-exp/src/api.ts @@ -197,7 +197,7 @@ export function getString(remoteConfig: RemoteConfig, key: string): string { } /** - * Gets the {@link @firebase/remote-config-types#Value} for the given key. + * Gets the {@link Value} for the given key. * * @param remoteConfig - the remote config instance * @param key - the name of the parameter diff --git a/packages/firestore/src/exp/database.ts b/packages/firestore/src/exp/database.ts index 936ac2f2efb..c79f23a28f0 100644 --- a/packages/firestore/src/exp/database.ts +++ b/packages/firestore/src/exp/database.ts @@ -111,7 +111,7 @@ export class FirebaseFirestore extends LiteFirestore { * {@link getFirestore}. If the custom settings are empty, this function is * equivalent to calling {@link getFirestore}. * - * @param app - The {@link FirebaseApp} with which the `Firestore` instance will + * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will * be associated. * @param settings - A settings object to configure the `Firestore` instance. * @returns A newly initialized `Firestore` instance. @@ -145,10 +145,10 @@ export function initializeFirestore( /** * Returns the existing instance of Firestore that is associated with the - * provided {@link FirebaseApp}. If no instance exists, initializes a new + * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new * instance with default settings. * - * @param app - The {@link FirebaseApp} instance that the returned Firestore + * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned Firestore * instance is associated with. * @returns The `Firestore` instance of the provided app. */ @@ -481,7 +481,7 @@ export function terminate(firestore: FirebaseFirestore): Promise { * @param bundleData - An object representing the bundle to be loaded. Valid objects are * `ArrayBuffer`, `ReadableStream` or `string`. * - * @return + * @returns * A `LoadBundleTask` object, which notifies callers with progress updates, and completion * or error events. It can be used as a `Promise`. */ diff --git a/packages/firestore/src/exp/reference_impl.ts b/packages/firestore/src/exp/reference_impl.ts index afa47c7ee2b..ec41ed73dd9 100644 --- a/packages/firestore/src/exp/reference_impl.ts +++ b/packages/firestore/src/exp/reference_impl.ts @@ -65,8 +65,8 @@ import { ensureFirestoreConfigured, FirebaseFirestore } from './database'; import { DocumentSnapshot, QuerySnapshot, SnapshotMetadata } from './snapshot'; /** - * An options object that can be passed to {@link onSnapshot} and {@link - * QuerySnapshot#docChanges} to control which types of changes to include in the + * An options object that can be passed to {@link (onSnapshot:1)} and {@link + * QuerySnapshot.docChanges} to control which types of changes to include in the * result set. */ export interface SnapshotListenOptions { diff --git a/packages/firestore/src/exp/snapshot.ts b/packages/firestore/src/exp/snapshot.ts index fb51fb5c563..f09994a9301 100644 --- a/packages/firestore/src/exp/snapshot.ts +++ b/packages/firestore/src/exp/snapshot.ts @@ -89,8 +89,8 @@ export interface FirestoreDataConverter /** * Called by the Firestore SDK to convert a custom model object of type `T` * into a plain JavaScript object (suitable for writing directly to the - * Firestore database). Used with {@link setData}, {@link WriteBatch#set} - * and {@link Transaction#set} with `merge:true` or `mergeFields`. + * Firestore database). Used with {@link (setDoc:1)}, {@link (WriteBatch.set:1)} + * and {@link (Transaction.set:1)} with `merge:true` or `mergeFields`. */ toFirestore(modelObject: Partial, options: SetOptions): DocumentData; diff --git a/packages/firestore/src/lite/database.ts b/packages/firestore/src/lite/database.ts index 7389b369f60..4d4ef42e6c9 100644 --- a/packages/firestore/src/lite/database.ts +++ b/packages/firestore/src/lite/database.ts @@ -85,7 +85,7 @@ export class FirebaseFirestore implements FirestoreService { } /** - * The {@link FirebaseApp} associated with this `Firestore` service + * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service * instance. */ get app(): FirebaseApp { @@ -177,7 +177,7 @@ function databaseIdFromApp(app: FirebaseApp): DatabaseId { * {@link getFirestore}. If the custom settings are empty, this function is * equivalent to calling {@link getFirestore}. * - * @param app - The {@link FirebaseApp} with which the `Firestore` instance will + * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will * be associated. * @param settings - A settings object to configure the `Firestore` instance. * @returns A newly initialized Firestore instance. @@ -200,10 +200,10 @@ export function initializeFirestore( /** * Returns the existing instance of Firestore that is associated with the - * provided {@link FirebaseApp}. If no instance exists, initializes a new + * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new * instance with default settings. * - * @param app - The {@link FirebaseApp} instance that the returned Firestore + * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned Firestore * instance is associated with. * @returns The `Firestore` instance of the provided app. */ diff --git a/packages/firestore/src/lite/field_value_impl.ts b/packages/firestore/src/lite/field_value_impl.ts index 8aae2b7e7cc..b4c65ca6de2 100644 --- a/packages/firestore/src/lite/field_value_impl.ts +++ b/packages/firestore/src/lite/field_value_impl.ts @@ -25,15 +25,15 @@ import { } from './user_data_reader'; /** - * Returns a sentinel for use with {@link updateDoc} or - * {@link setDoc} with `{merge: true}` to mark a field for deletion. + * Returns a sentinel for use with {@link @firebase/firestore/lite#(updateDoc:1)} or + * {@link @firebase/firestore/lite#(setDoc:1)} with `{merge: true}` to mark a field for deletion. */ export function deleteField(): FieldValue { return new DeleteFieldValueImpl('deleteField'); } /** - * Returns a sentinel used with {@link setDoc} or {@link updateDoc} to + * Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to * include a server-generated timestamp in the written data. */ export function serverTimestamp(): FieldValue { @@ -41,8 +41,8 @@ export function serverTimestamp(): FieldValue { } /** - * Returns a special value that can be used with {@link setDoc} or {@link - * updateDoc} that tells the server to union the given elements with any array + * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link + * @firebase/firestore/lite#(updateDoc:1)} that tells the server to union the given elements with any array * value that already exists on the server. Each specified element that doesn't * already exist in the array will be added to the end. If the field being * modified is not already an array it will be overwritten with an array @@ -60,7 +60,7 @@ export function arrayUnion(...elements: unknown[]): FieldValue { /** * Returns a special value that can be used with {@link (setDoc:1)} or {@link - * updateDoc} that tells the server to remove the given elements from any + * updateDoc:1} that tells the server to remove the given elements from any * array value that already exists on the server. All instances of each element * specified will be removed from the array. If the field being modified is not * already an array it will be overwritten with an empty array. @@ -76,8 +76,8 @@ export function arrayRemove(...elements: unknown[]): FieldValue { } /** - * Returns a special value that can be used with {@link setDoc} or {@link - * updateDoc} that tells the server to increment the field's current value by + * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link + * @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by * the given value. * * If either the operand or the current field value uses floating point diff --git a/packages/firestore/src/lite/query.ts b/packages/firestore/src/lite/query.ts index 4d9e27dc967..c7cdb576412 100644 --- a/packages/firestore/src/lite/query.ts +++ b/packages/firestore/src/lite/query.ts @@ -88,8 +88,8 @@ export type QueryConstraintType = /** * A `QueryConstraint` is used to narrow the set of documents returned by a * Firestore query. `QueryConstraint`s are created by invoking {@link where}, - * {@link orderBy}, {@link startAt}, {@link startAfter}, {@link - * endBefore}, {@link endAt}, {@link limit} or {@link limitToLast} and + * {@link orderBy}, {@link (startAt:1)}, {@link (startAfter:1)}, {@link + * endBefore:1}, {@link (endAt:1)}, {@link limit} or {@link limitToLast} and * can then be passed to {@link query} to create a new query instance that * also contains this `QueryConstraint`. */ diff --git a/packages/firestore/src/lite/reference.ts b/packages/firestore/src/lite/reference.ts index c96260a47ef..e97c9eebc7b 100644 --- a/packages/firestore/src/lite/reference.ts +++ b/packages/firestore/src/lite/reference.ts @@ -39,7 +39,7 @@ import { FieldPath } from './field_path'; import { FirestoreDataConverter } from './snapshot'; /** - * Document data (for use with {@link setDoc}) consists of fields mapped to + * Document data (for use with {@link @firebase/firestore/lite#(setDoc:1)}) consists of fields mapped to * values. */ export interface DocumentData { @@ -49,7 +49,7 @@ export interface DocumentData { } /** - * Update data (for use with {@link updateDoc}) consists of field paths (e.g. + * Update data (for use with {@link @firebase/firestore/lite#(updateDoc:1)}) consists of field paths (e.g. * 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference * nested fields within the document. */ @@ -60,8 +60,8 @@ export interface UpdateData { } /** - * An options object that configures the behavior of {@link setDoc}, {@link - * WriteBatch#set} and {@link Transaction#set} calls. These calls can be + * An options object that configures the behavior of {@link @firebase/firestore/lite#(setDoc:1)}, {@link + * @firebase/firestore/lite#(WriteBatch.set:1)} and {@link @firebase/firestore/lite#(Transaction.set:1)} calls. These calls can be * configured to perform granular merges instead of overwriting the target * documents in their entirety by providing a `SetOptions` with `merge: true`. * @@ -137,7 +137,7 @@ export class DocumentReference { /** * Applies a custom data converter to this `DocumentReference`, allowing you * to use your own custom model objects with Firestore. When you call {@link - * setDoc}, {@link getDoc}, etc. with the returned `DocumentReference` + * @firebase/firestore/lite#(setDoc:1)}, {@link @firebase/firestore/lite#getDoc}, etc. with the returned `DocumentReference` * instance, the provided converter will convert between Firestore data and * your custom type `U`. * diff --git a/packages/firestore/src/lite/snapshot.ts b/packages/firestore/src/lite/snapshot.ts index ec5aae727bb..01ab14d976b 100644 --- a/packages/firestore/src/lite/snapshot.ts +++ b/packages/firestore/src/lite/snapshot.ts @@ -80,16 +80,16 @@ export interface FirestoreDataConverter { /** * Called by the Firestore SDK to convert a custom model object of type `T` * into a plain Javascript object (suitable for writing directly to the - * Firestore database). Used with {@link setData}, {@link WriteBatch#set} - * and {@link Transaction#set}. + * Firestore database). Used with {@link @firebase/firestore/lite#(setDoc:1)}, {@link @firebase/firestore/lite#(WriteBatch.set:1)} + * and {@link @firebase/firestore/lite#(Transaction.set:1)}. */ toFirestore(modelObject: T): DocumentData; /** * Called by the Firestore SDK to convert a custom model object of type `T` * into a plain Javascript object (suitable for writing directly to the - * Firestore database). Used with {@link setData}, {@link WriteBatch#set} - * and {@link Transaction#set} with `merge:true` or `mergeFields`. + * Firestore database). Used with {@link @firebase/firestore/lite#(setDoc:1)}, {@link @firebase/firestore/lite#(WriteBatch.set:1)} + * and {@link @firebase/firestore/lite#(Transaction.set:1)} with `merge:true` or `mergeFields`. */ toFirestore(modelObject: Partial, options: SetOptions): DocumentData; diff --git a/packages/firestore/src/lite/write_batch.ts b/packages/firestore/src/lite/write_batch.ts index fccb5bb54df..a60c6a79d00 100644 --- a/packages/firestore/src/lite/write_batch.ts +++ b/packages/firestore/src/lite/write_batch.ts @@ -40,7 +40,7 @@ import { * * A `WriteBatch` object can be acquired by calling {@link writeBatch}. It * provides methods for adding writes to the write batch. None of the writes - * will be committed (or visible locally) until {@link WriteBatch#commit} is + * will be committed (or visible locally) until {@link WriteBatch.commit} is * called. */ export class WriteBatch {