From a84c306b1c8659015f910c386459a84f9cf1ebc1 Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 1 Oct 2020 16:21:37 -0700 Subject: [PATCH 1/2] integrate api extractor into auth-next --- packages-exp/auth-exp/api-extractor.json | 5 +++++ packages-exp/auth-exp/package.json | 8 ++++++-- packages-exp/auth-types-exp/api-extractor.json | 10 ++++++++++ packages-exp/auth-types-exp/package.json | 6 +++++- 4 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 packages-exp/auth-exp/api-extractor.json create mode 100644 packages-exp/auth-types-exp/api-extractor.json diff --git a/packages-exp/auth-exp/api-extractor.json b/packages-exp/auth-exp/api-extractor.json new file mode 100644 index 00000000000..620d10a071c --- /dev/null +++ b/packages-exp/auth-exp/api-extractor.json @@ -0,0 +1,5 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/dist/index.d.ts" +} \ No newline at end of file diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index ea598fb19b6..34590605a33 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -16,7 +16,7 @@ "scripts": { "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", - "build": "rollup -c", + "build": "rollup -c && yarn api-report", "build:deps": "lerna run --scope @firebase/auth-exp --include-dependencies build", "build:release": "rollup -c rollup.config.release.js", "dev": "rollup -c -w", @@ -29,7 +29,11 @@ "test:browser:debug": "karma start --auto-watch", "test:browser:unit:debug": "karma start --auto-watch --unit", "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/!(platform_browser|platform_react_native)/**/*.test.ts' --file index.node.ts --config ../../config/mocharc.node.js", - "prepare": "rollup -c rollup.config.release.js" + "prepare": "rollup -c rollup.config.release.js", + "api-report": "api-extractor run --local --verbose", + "predoc": "node ../../scripts/exp/remove-exp.js temp", + "doc": "api-documenter markdown --input temp --output docs", + "build:doc": "yarn build && yarn doc" }, "peerDependencies": { "@firebase/app-exp": "0.x", diff --git a/packages-exp/auth-types-exp/api-extractor.json b/packages-exp/auth-types-exp/api-extractor.json new file mode 100644 index 00000000000..8a3c6cb251e --- /dev/null +++ b/packages-exp/auth-types-exp/api-extractor.json @@ -0,0 +1,10 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/dist/src/index.d.ts", + "dtsRollup": { + "enabled": true, + "untrimmedFilePath": "/dist/.d.ts", + "publicTrimmedFilePath": "/dist/-public.d.ts" + } +} \ No newline at end of file diff --git a/packages-exp/auth-types-exp/package.json b/packages-exp/auth-types-exp/package.json index 613a975858e..e0a5b339fe7 100644 --- a/packages-exp/auth-types-exp/package.json +++ b/packages-exp/auth-types-exp/package.json @@ -6,7 +6,11 @@ "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", "scripts": { - "test": "tsc" + "test": "tsc", + "api-report": "api-extractor run --local --verbose", + "predoc": "node ../../scripts/exp/remove-exp.js temp", + "doc": "api-documenter markdown --input temp --output docs", + "build:doc": "yarn api-report && yarn doc" }, "files": [ "index.d.ts" From bb675d4f22c8686d2fbbcf75d904c70d477fadcf Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 1 Oct 2020 16:41:41 -0700 Subject: [PATCH 2/2] generate auth-next reference docs --- common/api-review/auth-exp.api.md | 451 ++++++++++++++ common/api-review/auth-types-exp.api.md | 557 ++++++++++++++++++ docs-exp/auth-types.actioncodeinfo.data.md | 15 + docs-exp/auth-types.actioncodeinfo.md | 21 + .../auth-types.actioncodeinfo.operation.md | 11 + .../auth-types.actioncodesettings.android.md | 15 + ...es.actioncodesettings.dynamiclinkdomain.md | 11 + ...ypes.actioncodesettings.handlecodeinapp.md | 11 + docs-exp/auth-types.actioncodesettings.ios.md | 13 + docs-exp/auth-types.actioncodesettings.md | 24 + docs-exp/auth-types.actioncodesettings.url.md | 11 + docs-exp/auth-types.actioncodeurl.apikey.md | 11 + docs-exp/auth-types.actioncodeurl.code.md | 11 + .../auth-types.actioncodeurl.continueurl.md | 11 + .../auth-types.actioncodeurl.languagecode.md | 11 + docs-exp/auth-types.actioncodeurl.md | 31 + .../auth-types.actioncodeurl.operation.md | 11 + .../auth-types.actioncodeurl.parselink.md | 22 + docs-exp/auth-types.actioncodeurl.tenantid.md | 11 + ...auth-types.additionaluserinfo.isnewuser.md | 11 + docs-exp/auth-types.additionaluserinfo.md | 23 + .../auth-types.additionaluserinfo.profile.md | 11 + ...uth-types.additionaluserinfo.providerid.md | 11 + .../auth-types.additionaluserinfo.username.md | 11 + docs-exp/auth-types.applicationverifier.md | 26 + .../auth-types.applicationverifier.type.md | 11 + .../auth-types.applicationverifier.verify.md | 15 + docs-exp/auth-types.auth.config.md | 11 + docs-exp/auth-types.auth.currentuser.md | 11 + docs-exp/auth-types.auth.languagecode.md | 11 + docs-exp/auth-types.auth.md | 37 ++ docs-exp/auth-types.auth.name.md | 11 + .../auth-types.auth.onauthstatechanged.md | 28 + docs-exp/auth-types.auth.onidtokenchanged.md | 28 + docs-exp/auth-types.auth.setpersistence.md | 22 + docs-exp/auth-types.auth.settings.md | 11 + docs-exp/auth-types.auth.signout.md | 15 + docs-exp/auth-types.auth.tenantid.md | 11 + docs-exp/auth-types.auth.updatecurrentuser.md | 22 + docs-exp/auth-types.auth.usedevicelanguage.md | 15 + docs-exp/auth-types.auth.useemulator.md | 23 + .../auth-types.authcredential.fromjson.md | 22 + docs-exp/auth-types.authcredential.md | 28 + .../auth-types.authcredential.providerid.md | 11 + .../auth-types.authcredential.signinmethod.md | 11 + docs-exp/auth-types.authcredential.tojson.md | 15 + docs-exp/auth-types.autherror.appname.md | 11 + docs-exp/auth-types.autherror.email.md | 11 + docs-exp/auth-types.autherror.md | 24 + docs-exp/auth-types.autherror.phonenumber.md | 11 + docs-exp/auth-types.autherror.tenantid.md | 11 + docs-exp/auth-types.authprovider.md | 22 + .../auth-types.authprovider.providerid.md | 11 + ...tings.appverificationdisabledfortesting.md | 11 + docs-exp/auth-types.authsettings.md | 20 + docs-exp/auth-types.config.apihost.md | 11 + docs-exp/auth-types.config.apikey.md | 11 + docs-exp/auth-types.config.apischeme.md | 11 + docs-exp/auth-types.config.authdomain.md | 11 + docs-exp/auth-types.config.md | 25 + .../auth-types.config.sdkclientversion.md | 11 + docs-exp/auth-types.config.tokenapihost.md | 11 + .../auth-types.confirmationresult.confirm.md | 22 + docs-exp/auth-types.confirmationresult.md | 26 + ...types.confirmationresult.verificationid.md | 11 + ...auth-types.emailauthprovider.credential.md | 23 + ...es.emailauthprovider.credentialwithlink.md | 28 + ...lauthprovider.email_link_sign_in_method.md | 11 + ...hprovider.email_password_sign_in_method.md | 11 + docs-exp/auth-types.emailauthprovider.md | 33 ++ ...uth-types.emailauthprovider.provider_id.md | 11 + ...auth-types.emailauthprovider.providerid.md | 11 + docs-exp/auth-types.idtokenresult.authtime.md | 11 + docs-exp/auth-types.idtokenresult.claims.md | 11 + ...auth-types.idtokenresult.expirationtime.md | 11 + .../auth-types.idtokenresult.issuedattime.md | 11 + docs-exp/auth-types.idtokenresult.md | 28 + ...auth-types.idtokenresult.signinprovider.md | 11 + ...-types.idtokenresult.signinsecondfactor.md | 11 + docs-exp/auth-types.idtokenresult.token.md | 11 + docs-exp/auth-types.md | 70 +++ ...uth-types.multifactorassertion.factorid.md | 11 + docs-exp/auth-types.multifactorassertion.md | 20 + .../auth-types.multifactorerror.credential.md | 11 + docs-exp/auth-types.multifactorerror.md | 22 + ...th-types.multifactorerror.operationtype.md | 11 + .../auth-types.multifactorinfo.displayname.md | 11 + ...th-types.multifactorinfo.enrollmenttime.md | 11 + .../auth-types.multifactorinfo.factorid.md | 11 + docs-exp/auth-types.multifactorinfo.md | 23 + docs-exp/auth-types.multifactorinfo.uid.md | 11 + .../auth-types.multifactorresolver.hints.md | 11 + docs-exp/auth-types.multifactorresolver.md | 27 + ...types.multifactorresolver.resolvesignin.md | 22 + .../auth-types.multifactorresolver.session.md | 11 + docs-exp/auth-types.multifactorsession.md | 13 + docs-exp/auth-types.multifactoruser.enroll.md | 26 + ...h-types.multifactoruser.enrolledfactors.md | 11 + .../auth-types.multifactoruser.getsession.md | 15 + docs-exp/auth-types.multifactoruser.md | 28 + .../auth-types.multifactoruser.unenroll.md | 22 + docs-exp/auth-types.nextorobserver.md | 13 + .../auth-types.oauthcredential.accesstoken.md | 11 + .../auth-types.oauthcredential.fromjson.md | 22 + .../auth-types.oauthcredential.idtoken.md | 11 + docs-exp/auth-types.oauthcredential.md | 29 + docs-exp/auth-types.oauthcredential.secret.md | 11 + docs-exp/auth-types.operation.md | 25 + docs-exp/auth-types.operationtype.md | 22 + docs-exp/auth-types.parsedtoken.auth_time.md | 11 + docs-exp/auth-types.parsedtoken.exp.md | 11 + docs-exp/auth-types.parsedtoken.firebase.md | 14 + docs-exp/auth-types.parsedtoken.iat.md | 11 + docs-exp/auth-types.parsedtoken.md | 26 + docs-exp/auth-types.parsedtoken.sub.md | 11 + docs-exp/auth-types.persistence.md | 20 + docs-exp/auth-types.persistence.type.md | 11 + ...auth-types.phoneauthcredential.fromjson.md | 22 + docs-exp/auth-types.phoneauthcredential.md | 21 + ...h-types.phoneauthprovider._constructor_.md | 20 + ...auth-types.phoneauthprovider.credential.md | 26 + docs-exp/auth-types.phoneauthprovider.md | 38 ++ ....phoneauthprovider.phone_sign_in_method.md | 11 + ...uth-types.phoneauthprovider.provider_id.md | 11 + ...auth-types.phoneauthprovider.providerid.md | 11 + ...pes.phoneauthprovider.verifyphonenumber.md | 26 + docs-exp/auth-types.phoneinfooptions.md | 16 + .../auth-types.phonemultifactorassertion.md | 15 + ...types.phonemultifactorenrollinfooptions.md | 19 + ...ultifactorenrollinfooptions.phonenumber.md | 11 + ...onemultifactorenrollinfooptions.session.md | 11 + ...pes.phonemultifactorgenerator.assertion.md | 24 + ...pes.phonemultifactorgenerator.factor_id.md | 11 + .../auth-types.phonemultifactorgenerator.md | 26 + ...types.phonemultifactorsignininfooptions.md | 20 + ...factorsignininfooptions.multifactorhint.md | 11 + ...ifactorsignininfooptions.multifactoruid.md | 11 + ...onemultifactorsignininfooptions.session.md | 11 + ...auth-types.phonesinglefactorinfooptions.md | 18 + ...honesinglefactorinfooptions.phonenumber.md | 11 + docs-exp/auth-types.popupredirectresolver.md | 13 + docs-exp/auth-types.providerid.md | 28 + ...h-types.reactnativeasyncstorage.getitem.md | 22 + .../auth-types.reactnativeasyncstorage.md | 20 + ...ypes.reactnativeasyncstorage.removeitem.md | 22 + ...h-types.reactnativeasyncstorage.setitem.md | 23 + ...h-types.recaptchaverifier._constructor_.md | 26 + .../auth-types.recaptchaverifier.clear.md | 15 + docs-exp/auth-types.recaptchaverifier.md | 35 ++ .../auth-types.recaptchaverifier.render.md | 15 + docs-exp/auth-types.recaptchaverifier.type.md | 11 + .../auth-types.recaptchaverifier.verify.md | 15 + docs-exp/auth-types.signinmethod.md | 27 + docs-exp/auth-types.user.delete.md | 15 + docs-exp/auth-types.user.emailverified.md | 11 + docs-exp/auth-types.user.getidtoken.md | 22 + docs-exp/auth-types.user.getidtokenresult.md | 22 + docs-exp/auth-types.user.isanonymous.md | 11 + docs-exp/auth-types.user.md | 36 ++ docs-exp/auth-types.user.metadata.md | 11 + docs-exp/auth-types.user.providerdata.md | 11 + docs-exp/auth-types.user.refreshtoken.md | 11 + docs-exp/auth-types.user.reload.md | 15 + docs-exp/auth-types.user.tenantid.md | 11 + docs-exp/auth-types.user.tojson.md | 15 + docs-exp/auth-types.usercredential.md | 22 + ...auth-types.usercredential.operationtype.md | 11 + .../auth-types.usercredential.providerid.md | 11 + docs-exp/auth-types.usercredential.user.md | 11 + docs-exp/auth-types.userinfo.displayname.md | 11 + docs-exp/auth-types.userinfo.email.md | 11 + docs-exp/auth-types.userinfo.md | 25 + docs-exp/auth-types.userinfo.phonenumber.md | 11 + docs-exp/auth-types.userinfo.photourl.md | 11 + docs-exp/auth-types.userinfo.providerid.md | 11 + docs-exp/auth-types.userinfo.uid.md | 11 + .../auth-types.usermetadata.creationtime.md | 11 + .../auth-types.usermetadata.lastsignintime.md | 11 + docs-exp/auth-types.usermetadata.md | 21 + docs-exp/auth-types.userprofile.md | 13 + docs-exp/auth.actioncodeurl._constructor_.md | 20 + docs-exp/auth.actioncodeurl.apikey.md | 11 + docs-exp/auth.actioncodeurl.code.md | 11 + docs-exp/auth.actioncodeurl.continueurl.md | 11 + docs-exp/auth.actioncodeurl.languagecode.md | 11 + docs-exp/auth.actioncodeurl.md | 36 ++ docs-exp/auth.actioncodeurl.operation.md | 11 + docs-exp/auth.actioncodeurl.parselink.md | 22 + docs-exp/auth.actioncodeurl.tenantid.md | 11 + docs-exp/auth.applyactioncode.md | 23 + docs-exp/auth.authcredential._constructor_.md | 21 + ...auth.authcredential._getidtokenresponse.md | 22 + ...credential._getreauthenticationresolver.md | 22 + .../auth.authcredential._linktoidtoken.md | 23 + docs-exp/auth.authcredential.md | 34 ++ docs-exp/auth.authcredential.providerid.md | 11 + docs-exp/auth.authcredential.signinmethod.md | 11 + docs-exp/auth.authcredential.tojson.md | 15 + docs-exp/auth.browserlocalpersistence.md | 11 + docs-exp/auth.browserpopupredirectresolver.md | 11 + docs-exp/auth.browsersessionpersistence.md | 11 + docs-exp/auth.checkactioncode.md | 23 + docs-exp/auth.confirmpasswordreset.md | 24 + .../auth.createuserwithemailandpassword.md | 24 + docs-exp/auth.deleteuser.md | 22 + ...h.emailauthcredential._fromemailandcode.md | 24 + ...ailauthcredential._fromemailandpassword.md | 23 + ...emailauthcredential._getidtokenresponse.md | 22 + ...credential._getreauthenticationresolver.md | 22 + ...auth.emailauthcredential._linktoidtoken.md | 23 + docs-exp/auth.emailauthcredential.email.md | 11 + docs-exp/auth.emailauthcredential.fromjson.md | 22 + docs-exp/auth.emailauthcredential.md | 35 ++ docs-exp/auth.emailauthcredential.password.md | 11 + docs-exp/auth.emailauthcredential.tenantid.md | 11 + docs-exp/auth.emailauthcredential.tojson.md | 15 + docs-exp/auth.emailauthprovider.credential.md | 23 + ...th.emailauthprovider.credentialwithlink.md | 23 + ...lauthprovider.email_link_sign_in_method.md | 11 + ...hprovider.email_password_sign_in_method.md | 11 + docs-exp/auth.emailauthprovider.md | 29 + .../auth.emailauthprovider.provider_id.md | 11 + docs-exp/auth.emailauthprovider.providerid.md | 11 + .../auth.facebookauthprovider.credential.md | 22 + ...acebookauthprovider.credentialfromerror.md | 22 + ...cebookauthprovider.credentialfromresult.md | 22 + ...ookauthprovider.facebook_sign_in_method.md | 11 + docs-exp/auth.facebookauthprovider.md | 29 + .../auth.facebookauthprovider.provider_id.md | 11 + .../auth.facebookauthprovider.providerid.md | 11 + docs-exp/auth.fetchsigninmethodsforemail.md | 23 + docs-exp/auth.getadditionaluserinfo.md | 22 + docs-exp/auth.getauth.md | 22 + docs-exp/auth.getidtoken.md | 23 + docs-exp/auth.getidtokenresult.md | 23 + docs-exp/auth.getmultifactorresolver.md | 23 + docs-exp/auth.getredirectresult.md | 23 + .../auth.githubauthprovider.credential.md | 22 + ....githubauthprovider.credentialfromerror.md | 22 + ...githubauthprovider.credentialfromresult.md | 22 + ...ithubauthprovider.github_sign_in_method.md | 11 + docs-exp/auth.githubauthprovider.md | 29 + .../auth.githubauthprovider.provider_id.md | 11 + .../auth.githubauthprovider.providerid.md | 11 + .../auth.googleauthprovider.credential.md | 23 + ....googleauthprovider.credentialfromerror.md | 22 + ...googleauthprovider.credentialfromresult.md | 22 + ...oogleauthprovider.google_sign_in_method.md | 11 + docs-exp/auth.googleauthprovider.md | 29 + .../auth.googleauthprovider.provider_id.md | 11 + .../auth.googleauthprovider.providerid.md | 11 + docs-exp/auth.indexeddblocalpersistence.md | 11 + docs-exp/auth.initializeauth.md | 23 + docs-exp/auth.inmemorypersistence.md | 11 + docs-exp/auth.issigninwithemaillink.md | 23 + docs-exp/auth.linkwithcredential.md | 23 + docs-exp/auth.linkwithphonenumber.md | 24 + docs-exp/auth.linkwithpopup.md | 24 + docs-exp/auth.linkwithredirect.md | 24 + docs-exp/auth.md | 89 +++ docs-exp/auth.multifactor.md | 22 + docs-exp/auth.oauthcredential._fromparams.md | 22 + ...uth.oauthcredential._getidtokenresponse.md | 22 + ...credential._getreauthenticationresolver.md | 22 + .../auth.oauthcredential._linktoidtoken.md | 23 + docs-exp/auth.oauthcredential.accesstoken.md | 11 + docs-exp/auth.oauthcredential.fromjson.md | 22 + docs-exp/auth.oauthcredential.idtoken.md | 11 + docs-exp/auth.oauthcredential.md | 35 ++ docs-exp/auth.oauthcredential.nonce.md | 11 + docs-exp/auth.oauthcredential.secret.md | 11 + docs-exp/auth.oauthcredential.tojson.md | 15 + docs-exp/auth.oauthprovider._constructor_.md | 20 + docs-exp/auth.oauthprovider.addscope.md | 22 + docs-exp/auth.oauthprovider.credential.md | 22 + .../auth.oauthprovider.credentialfromjson.md | 22 + .../auth.oauthprovider.defaultlanguagecode.md | 11 + .../auth.oauthprovider.getcustomparameters.md | 15 + docs-exp/auth.oauthprovider.getscopes.md | 15 + docs-exp/auth.oauthprovider.md | 38 ++ docs-exp/auth.oauthprovider.providerid.md | 11 + .../auth.oauthprovider.setcustomparameters.md | 22 + .../auth.oauthprovider.setdefaultlanguage.md | 22 + docs-exp/auth.onauthstatechanged.md | 25 + docs-exp/auth.onidtokenchanged.md | 25 + docs-exp/auth.parseactioncodeurl.md | 22 + ....phoneauthcredential._fromtokenresponse.md | 23 + ...h.phoneauthcredential._fromverification.md | 23 + ...phoneauthcredential._getidtokenresponse.md | 22 + ...credential._getreauthenticationresolver.md | 22 + ...auth.phoneauthcredential._linktoidtoken.md | 23 + ...authcredential._makeverificationrequest.md | 15 + docs-exp/auth.phoneauthcredential.fromjson.md | 22 + docs-exp/auth.phoneauthcredential.md | 28 + docs-exp/auth.phoneauthcredential.tojson.md | 15 + .../auth.phoneauthprovider._constructor_.md | 20 + docs-exp/auth.phoneauthprovider.credential.md | 23 + ....phoneauthprovider.credentialfromresult.md | 22 + docs-exp/auth.phoneauthprovider.md | 35 ++ ....phoneauthprovider.phone_sign_in_method.md | 11 + .../auth.phoneauthprovider.provider_id.md | 11 + docs-exp/auth.phoneauthprovider.providerid.md | 11 + ...uth.phoneauthprovider.verifyphonenumber.md | 23 + ...uth.phonemultifactorgenerator.assertion.md | 22 + docs-exp/auth.phonemultifactorgenerator.md | 19 + docs-exp/auth.reauthenticatewithcredential.md | 23 + .../auth.reauthenticatewithphonenumber.md | 24 + docs-exp/auth.reauthenticatewithpopup.md | 24 + docs-exp/auth.reauthenticatewithredirect.md | 24 + .../auth.recaptchaverifier._constructor_.md | 22 + ...auth.recaptchaverifier._recaptchaloader.md | 11 + docs-exp/auth.recaptchaverifier._reset.md | 15 + docs-exp/auth.recaptchaverifier.clear.md | 15 + docs-exp/auth.recaptchaverifier.md | 35 ++ docs-exp/auth.recaptchaverifier.render.md | 15 + docs-exp/auth.recaptchaverifier.type.md | 11 + docs-exp/auth.recaptchaverifier.verify.md | 15 + docs-exp/auth.reload.md | 22 + docs-exp/auth.sendemailverification.md | 23 + docs-exp/auth.sendpasswordresetemail.md | 24 + docs-exp/auth.sendsigninlinktoemail.md | 24 + docs-exp/auth.setpersistence.md | 23 + docs-exp/auth.signinanonymously.md | 22 + docs-exp/auth.signinwithcredential.md | 23 + docs-exp/auth.signinwithcustomtoken.md | 23 + docs-exp/auth.signinwithemailandpassword.md | 24 + docs-exp/auth.signinwithemaillink.md | 24 + docs-exp/auth.signinwithphonenumber.md | 24 + docs-exp/auth.signinwithpopup.md | 24 + docs-exp/auth.signinwithredirect.md | 24 + docs-exp/auth.signout.md | 22 + .../auth.twitterauthprovider.credential.md | 23 + ...twitterauthprovider.credentialfromerror.md | 22 + ...witterauthprovider.credentialfromresult.md | 22 + docs-exp/auth.twitterauthprovider.md | 29 + .../auth.twitterauthprovider.provider_id.md | 11 + .../auth.twitterauthprovider.providerid.md | 11 + ...tterauthprovider.twitter_sign_in_method.md | 11 + docs-exp/auth.unlink.md | 25 + docs-exp/auth.updatecurrentuser.md | 23 + docs-exp/auth.updateemail.md | 23 + docs-exp/auth.updatepassword.md | 23 + docs-exp/auth.updatephonenumber.md | 23 + docs-exp/auth.updateprofile.md | 23 + docs-exp/auth.usedevicelanguage.md | 22 + docs-exp/auth.verifybeforeupdateemail.md | 24 + docs-exp/auth.verifypasswordresetcode.md | 23 + docs-exp/index.md | 2 + docs-exp/performance.registerperformance.md | 15 - .../auth-types-exp/api-extractor.json | 7 +- 350 files changed, 7355 insertions(+), 21 deletions(-) create mode 100644 common/api-review/auth-exp.api.md create mode 100644 common/api-review/auth-types-exp.api.md create mode 100644 docs-exp/auth-types.actioncodeinfo.data.md create mode 100644 docs-exp/auth-types.actioncodeinfo.md create mode 100644 docs-exp/auth-types.actioncodeinfo.operation.md create mode 100644 docs-exp/auth-types.actioncodesettings.android.md create mode 100644 docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md create mode 100644 docs-exp/auth-types.actioncodesettings.handlecodeinapp.md create mode 100644 docs-exp/auth-types.actioncodesettings.ios.md create mode 100644 docs-exp/auth-types.actioncodesettings.md create mode 100644 docs-exp/auth-types.actioncodesettings.url.md create mode 100644 docs-exp/auth-types.actioncodeurl.apikey.md create mode 100644 docs-exp/auth-types.actioncodeurl.code.md create mode 100644 docs-exp/auth-types.actioncodeurl.continueurl.md create mode 100644 docs-exp/auth-types.actioncodeurl.languagecode.md create mode 100644 docs-exp/auth-types.actioncodeurl.md create mode 100644 docs-exp/auth-types.actioncodeurl.operation.md create mode 100644 docs-exp/auth-types.actioncodeurl.parselink.md create mode 100644 docs-exp/auth-types.actioncodeurl.tenantid.md create mode 100644 docs-exp/auth-types.additionaluserinfo.isnewuser.md create mode 100644 docs-exp/auth-types.additionaluserinfo.md create mode 100644 docs-exp/auth-types.additionaluserinfo.profile.md create mode 100644 docs-exp/auth-types.additionaluserinfo.providerid.md create mode 100644 docs-exp/auth-types.additionaluserinfo.username.md create mode 100644 docs-exp/auth-types.applicationverifier.md create mode 100644 docs-exp/auth-types.applicationverifier.type.md create mode 100644 docs-exp/auth-types.applicationverifier.verify.md create mode 100644 docs-exp/auth-types.auth.config.md create mode 100644 docs-exp/auth-types.auth.currentuser.md create mode 100644 docs-exp/auth-types.auth.languagecode.md create mode 100644 docs-exp/auth-types.auth.md create mode 100644 docs-exp/auth-types.auth.name.md create mode 100644 docs-exp/auth-types.auth.onauthstatechanged.md create mode 100644 docs-exp/auth-types.auth.onidtokenchanged.md create mode 100644 docs-exp/auth-types.auth.setpersistence.md create mode 100644 docs-exp/auth-types.auth.settings.md create mode 100644 docs-exp/auth-types.auth.signout.md create mode 100644 docs-exp/auth-types.auth.tenantid.md create mode 100644 docs-exp/auth-types.auth.updatecurrentuser.md create mode 100644 docs-exp/auth-types.auth.usedevicelanguage.md create mode 100644 docs-exp/auth-types.auth.useemulator.md create mode 100644 docs-exp/auth-types.authcredential.fromjson.md create mode 100644 docs-exp/auth-types.authcredential.md create mode 100644 docs-exp/auth-types.authcredential.providerid.md create mode 100644 docs-exp/auth-types.authcredential.signinmethod.md create mode 100644 docs-exp/auth-types.authcredential.tojson.md create mode 100644 docs-exp/auth-types.autherror.appname.md create mode 100644 docs-exp/auth-types.autherror.email.md create mode 100644 docs-exp/auth-types.autherror.md create mode 100644 docs-exp/auth-types.autherror.phonenumber.md create mode 100644 docs-exp/auth-types.autherror.tenantid.md create mode 100644 docs-exp/auth-types.authprovider.md create mode 100644 docs-exp/auth-types.authprovider.providerid.md create mode 100644 docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md create mode 100644 docs-exp/auth-types.authsettings.md create mode 100644 docs-exp/auth-types.config.apihost.md create mode 100644 docs-exp/auth-types.config.apikey.md create mode 100644 docs-exp/auth-types.config.apischeme.md create mode 100644 docs-exp/auth-types.config.authdomain.md create mode 100644 docs-exp/auth-types.config.md create mode 100644 docs-exp/auth-types.config.sdkclientversion.md create mode 100644 docs-exp/auth-types.config.tokenapihost.md create mode 100644 docs-exp/auth-types.confirmationresult.confirm.md create mode 100644 docs-exp/auth-types.confirmationresult.md create mode 100644 docs-exp/auth-types.confirmationresult.verificationid.md create mode 100644 docs-exp/auth-types.emailauthprovider.credential.md create mode 100644 docs-exp/auth-types.emailauthprovider.credentialwithlink.md create mode 100644 docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md create mode 100644 docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md create mode 100644 docs-exp/auth-types.emailauthprovider.md create mode 100644 docs-exp/auth-types.emailauthprovider.provider_id.md create mode 100644 docs-exp/auth-types.emailauthprovider.providerid.md create mode 100644 docs-exp/auth-types.idtokenresult.authtime.md create mode 100644 docs-exp/auth-types.idtokenresult.claims.md create mode 100644 docs-exp/auth-types.idtokenresult.expirationtime.md create mode 100644 docs-exp/auth-types.idtokenresult.issuedattime.md create mode 100644 docs-exp/auth-types.idtokenresult.md create mode 100644 docs-exp/auth-types.idtokenresult.signinprovider.md create mode 100644 docs-exp/auth-types.idtokenresult.signinsecondfactor.md create mode 100644 docs-exp/auth-types.idtokenresult.token.md create mode 100644 docs-exp/auth-types.md create mode 100644 docs-exp/auth-types.multifactorassertion.factorid.md create mode 100644 docs-exp/auth-types.multifactorassertion.md create mode 100644 docs-exp/auth-types.multifactorerror.credential.md create mode 100644 docs-exp/auth-types.multifactorerror.md create mode 100644 docs-exp/auth-types.multifactorerror.operationtype.md create mode 100644 docs-exp/auth-types.multifactorinfo.displayname.md create mode 100644 docs-exp/auth-types.multifactorinfo.enrollmenttime.md create mode 100644 docs-exp/auth-types.multifactorinfo.factorid.md create mode 100644 docs-exp/auth-types.multifactorinfo.md create mode 100644 docs-exp/auth-types.multifactorinfo.uid.md create mode 100644 docs-exp/auth-types.multifactorresolver.hints.md create mode 100644 docs-exp/auth-types.multifactorresolver.md create mode 100644 docs-exp/auth-types.multifactorresolver.resolvesignin.md create mode 100644 docs-exp/auth-types.multifactorresolver.session.md create mode 100644 docs-exp/auth-types.multifactorsession.md create mode 100644 docs-exp/auth-types.multifactoruser.enroll.md create mode 100644 docs-exp/auth-types.multifactoruser.enrolledfactors.md create mode 100644 docs-exp/auth-types.multifactoruser.getsession.md create mode 100644 docs-exp/auth-types.multifactoruser.md create mode 100644 docs-exp/auth-types.multifactoruser.unenroll.md create mode 100644 docs-exp/auth-types.nextorobserver.md create mode 100644 docs-exp/auth-types.oauthcredential.accesstoken.md create mode 100644 docs-exp/auth-types.oauthcredential.fromjson.md create mode 100644 docs-exp/auth-types.oauthcredential.idtoken.md create mode 100644 docs-exp/auth-types.oauthcredential.md create mode 100644 docs-exp/auth-types.oauthcredential.secret.md create mode 100644 docs-exp/auth-types.operation.md create mode 100644 docs-exp/auth-types.operationtype.md create mode 100644 docs-exp/auth-types.parsedtoken.auth_time.md create mode 100644 docs-exp/auth-types.parsedtoken.exp.md create mode 100644 docs-exp/auth-types.parsedtoken.firebase.md create mode 100644 docs-exp/auth-types.parsedtoken.iat.md create mode 100644 docs-exp/auth-types.parsedtoken.md create mode 100644 docs-exp/auth-types.parsedtoken.sub.md create mode 100644 docs-exp/auth-types.persistence.md create mode 100644 docs-exp/auth-types.persistence.type.md create mode 100644 docs-exp/auth-types.phoneauthcredential.fromjson.md create mode 100644 docs-exp/auth-types.phoneauthcredential.md create mode 100644 docs-exp/auth-types.phoneauthprovider._constructor_.md create mode 100644 docs-exp/auth-types.phoneauthprovider.credential.md create mode 100644 docs-exp/auth-types.phoneauthprovider.md create mode 100644 docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md create mode 100644 docs-exp/auth-types.phoneauthprovider.provider_id.md create mode 100644 docs-exp/auth-types.phoneauthprovider.providerid.md create mode 100644 docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md create mode 100644 docs-exp/auth-types.phoneinfooptions.md create mode 100644 docs-exp/auth-types.phonemultifactorassertion.md create mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.md create mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md create mode 100644 docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md create mode 100644 docs-exp/auth-types.phonemultifactorgenerator.assertion.md create mode 100644 docs-exp/auth-types.phonemultifactorgenerator.factor_id.md create mode 100644 docs-exp/auth-types.phonemultifactorgenerator.md create mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.md create mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md create mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md create mode 100644 docs-exp/auth-types.phonemultifactorsignininfooptions.session.md create mode 100644 docs-exp/auth-types.phonesinglefactorinfooptions.md create mode 100644 docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md create mode 100644 docs-exp/auth-types.popupredirectresolver.md create mode 100644 docs-exp/auth-types.providerid.md create mode 100644 docs-exp/auth-types.reactnativeasyncstorage.getitem.md create mode 100644 docs-exp/auth-types.reactnativeasyncstorage.md create mode 100644 docs-exp/auth-types.reactnativeasyncstorage.removeitem.md create mode 100644 docs-exp/auth-types.reactnativeasyncstorage.setitem.md create mode 100644 docs-exp/auth-types.recaptchaverifier._constructor_.md create mode 100644 docs-exp/auth-types.recaptchaverifier.clear.md create mode 100644 docs-exp/auth-types.recaptchaverifier.md create mode 100644 docs-exp/auth-types.recaptchaverifier.render.md create mode 100644 docs-exp/auth-types.recaptchaverifier.type.md create mode 100644 docs-exp/auth-types.recaptchaverifier.verify.md create mode 100644 docs-exp/auth-types.signinmethod.md create mode 100644 docs-exp/auth-types.user.delete.md create mode 100644 docs-exp/auth-types.user.emailverified.md create mode 100644 docs-exp/auth-types.user.getidtoken.md create mode 100644 docs-exp/auth-types.user.getidtokenresult.md create mode 100644 docs-exp/auth-types.user.isanonymous.md create mode 100644 docs-exp/auth-types.user.md create mode 100644 docs-exp/auth-types.user.metadata.md create mode 100644 docs-exp/auth-types.user.providerdata.md create mode 100644 docs-exp/auth-types.user.refreshtoken.md create mode 100644 docs-exp/auth-types.user.reload.md create mode 100644 docs-exp/auth-types.user.tenantid.md create mode 100644 docs-exp/auth-types.user.tojson.md create mode 100644 docs-exp/auth-types.usercredential.md create mode 100644 docs-exp/auth-types.usercredential.operationtype.md create mode 100644 docs-exp/auth-types.usercredential.providerid.md create mode 100644 docs-exp/auth-types.usercredential.user.md create mode 100644 docs-exp/auth-types.userinfo.displayname.md create mode 100644 docs-exp/auth-types.userinfo.email.md create mode 100644 docs-exp/auth-types.userinfo.md create mode 100644 docs-exp/auth-types.userinfo.phonenumber.md create mode 100644 docs-exp/auth-types.userinfo.photourl.md create mode 100644 docs-exp/auth-types.userinfo.providerid.md create mode 100644 docs-exp/auth-types.userinfo.uid.md create mode 100644 docs-exp/auth-types.usermetadata.creationtime.md create mode 100644 docs-exp/auth-types.usermetadata.lastsignintime.md create mode 100644 docs-exp/auth-types.usermetadata.md create mode 100644 docs-exp/auth-types.userprofile.md create mode 100644 docs-exp/auth.actioncodeurl._constructor_.md create mode 100644 docs-exp/auth.actioncodeurl.apikey.md create mode 100644 docs-exp/auth.actioncodeurl.code.md create mode 100644 docs-exp/auth.actioncodeurl.continueurl.md create mode 100644 docs-exp/auth.actioncodeurl.languagecode.md create mode 100644 docs-exp/auth.actioncodeurl.md create mode 100644 docs-exp/auth.actioncodeurl.operation.md create mode 100644 docs-exp/auth.actioncodeurl.parselink.md create mode 100644 docs-exp/auth.actioncodeurl.tenantid.md create mode 100644 docs-exp/auth.applyactioncode.md create mode 100644 docs-exp/auth.authcredential._constructor_.md create mode 100644 docs-exp/auth.authcredential._getidtokenresponse.md create mode 100644 docs-exp/auth.authcredential._getreauthenticationresolver.md create mode 100644 docs-exp/auth.authcredential._linktoidtoken.md create mode 100644 docs-exp/auth.authcredential.md create mode 100644 docs-exp/auth.authcredential.providerid.md create mode 100644 docs-exp/auth.authcredential.signinmethod.md create mode 100644 docs-exp/auth.authcredential.tojson.md create mode 100644 docs-exp/auth.browserlocalpersistence.md create mode 100644 docs-exp/auth.browserpopupredirectresolver.md create mode 100644 docs-exp/auth.browsersessionpersistence.md create mode 100644 docs-exp/auth.checkactioncode.md create mode 100644 docs-exp/auth.confirmpasswordreset.md create mode 100644 docs-exp/auth.createuserwithemailandpassword.md create mode 100644 docs-exp/auth.deleteuser.md create mode 100644 docs-exp/auth.emailauthcredential._fromemailandcode.md create mode 100644 docs-exp/auth.emailauthcredential._fromemailandpassword.md create mode 100644 docs-exp/auth.emailauthcredential._getidtokenresponse.md create mode 100644 docs-exp/auth.emailauthcredential._getreauthenticationresolver.md create mode 100644 docs-exp/auth.emailauthcredential._linktoidtoken.md create mode 100644 docs-exp/auth.emailauthcredential.email.md create mode 100644 docs-exp/auth.emailauthcredential.fromjson.md create mode 100644 docs-exp/auth.emailauthcredential.md create mode 100644 docs-exp/auth.emailauthcredential.password.md create mode 100644 docs-exp/auth.emailauthcredential.tenantid.md create mode 100644 docs-exp/auth.emailauthcredential.tojson.md create mode 100644 docs-exp/auth.emailauthprovider.credential.md create mode 100644 docs-exp/auth.emailauthprovider.credentialwithlink.md create mode 100644 docs-exp/auth.emailauthprovider.email_link_sign_in_method.md create mode 100644 docs-exp/auth.emailauthprovider.email_password_sign_in_method.md create mode 100644 docs-exp/auth.emailauthprovider.md create mode 100644 docs-exp/auth.emailauthprovider.provider_id.md create mode 100644 docs-exp/auth.emailauthprovider.providerid.md create mode 100644 docs-exp/auth.facebookauthprovider.credential.md create mode 100644 docs-exp/auth.facebookauthprovider.credentialfromerror.md create mode 100644 docs-exp/auth.facebookauthprovider.credentialfromresult.md create mode 100644 docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md create mode 100644 docs-exp/auth.facebookauthprovider.md create mode 100644 docs-exp/auth.facebookauthprovider.provider_id.md create mode 100644 docs-exp/auth.facebookauthprovider.providerid.md create mode 100644 docs-exp/auth.fetchsigninmethodsforemail.md create mode 100644 docs-exp/auth.getadditionaluserinfo.md create mode 100644 docs-exp/auth.getauth.md create mode 100644 docs-exp/auth.getidtoken.md create mode 100644 docs-exp/auth.getidtokenresult.md create mode 100644 docs-exp/auth.getmultifactorresolver.md create mode 100644 docs-exp/auth.getredirectresult.md create mode 100644 docs-exp/auth.githubauthprovider.credential.md create mode 100644 docs-exp/auth.githubauthprovider.credentialfromerror.md create mode 100644 docs-exp/auth.githubauthprovider.credentialfromresult.md create mode 100644 docs-exp/auth.githubauthprovider.github_sign_in_method.md create mode 100644 docs-exp/auth.githubauthprovider.md create mode 100644 docs-exp/auth.githubauthprovider.provider_id.md create mode 100644 docs-exp/auth.githubauthprovider.providerid.md create mode 100644 docs-exp/auth.googleauthprovider.credential.md create mode 100644 docs-exp/auth.googleauthprovider.credentialfromerror.md create mode 100644 docs-exp/auth.googleauthprovider.credentialfromresult.md create mode 100644 docs-exp/auth.googleauthprovider.google_sign_in_method.md create mode 100644 docs-exp/auth.googleauthprovider.md create mode 100644 docs-exp/auth.googleauthprovider.provider_id.md create mode 100644 docs-exp/auth.googleauthprovider.providerid.md create mode 100644 docs-exp/auth.indexeddblocalpersistence.md create mode 100644 docs-exp/auth.initializeauth.md create mode 100644 docs-exp/auth.inmemorypersistence.md create mode 100644 docs-exp/auth.issigninwithemaillink.md create mode 100644 docs-exp/auth.linkwithcredential.md create mode 100644 docs-exp/auth.linkwithphonenumber.md create mode 100644 docs-exp/auth.linkwithpopup.md create mode 100644 docs-exp/auth.linkwithredirect.md create mode 100644 docs-exp/auth.md create mode 100644 docs-exp/auth.multifactor.md create mode 100644 docs-exp/auth.oauthcredential._fromparams.md create mode 100644 docs-exp/auth.oauthcredential._getidtokenresponse.md create mode 100644 docs-exp/auth.oauthcredential._getreauthenticationresolver.md create mode 100644 docs-exp/auth.oauthcredential._linktoidtoken.md create mode 100644 docs-exp/auth.oauthcredential.accesstoken.md create mode 100644 docs-exp/auth.oauthcredential.fromjson.md create mode 100644 docs-exp/auth.oauthcredential.idtoken.md create mode 100644 docs-exp/auth.oauthcredential.md create mode 100644 docs-exp/auth.oauthcredential.nonce.md create mode 100644 docs-exp/auth.oauthcredential.secret.md create mode 100644 docs-exp/auth.oauthcredential.tojson.md create mode 100644 docs-exp/auth.oauthprovider._constructor_.md create mode 100644 docs-exp/auth.oauthprovider.addscope.md create mode 100644 docs-exp/auth.oauthprovider.credential.md create mode 100644 docs-exp/auth.oauthprovider.credentialfromjson.md create mode 100644 docs-exp/auth.oauthprovider.defaultlanguagecode.md create mode 100644 docs-exp/auth.oauthprovider.getcustomparameters.md create mode 100644 docs-exp/auth.oauthprovider.getscopes.md create mode 100644 docs-exp/auth.oauthprovider.md create mode 100644 docs-exp/auth.oauthprovider.providerid.md create mode 100644 docs-exp/auth.oauthprovider.setcustomparameters.md create mode 100644 docs-exp/auth.oauthprovider.setdefaultlanguage.md create mode 100644 docs-exp/auth.onauthstatechanged.md create mode 100644 docs-exp/auth.onidtokenchanged.md create mode 100644 docs-exp/auth.parseactioncodeurl.md create mode 100644 docs-exp/auth.phoneauthcredential._fromtokenresponse.md create mode 100644 docs-exp/auth.phoneauthcredential._fromverification.md create mode 100644 docs-exp/auth.phoneauthcredential._getidtokenresponse.md create mode 100644 docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md create mode 100644 docs-exp/auth.phoneauthcredential._linktoidtoken.md create mode 100644 docs-exp/auth.phoneauthcredential._makeverificationrequest.md create mode 100644 docs-exp/auth.phoneauthcredential.fromjson.md create mode 100644 docs-exp/auth.phoneauthcredential.md create mode 100644 docs-exp/auth.phoneauthcredential.tojson.md create mode 100644 docs-exp/auth.phoneauthprovider._constructor_.md create mode 100644 docs-exp/auth.phoneauthprovider.credential.md create mode 100644 docs-exp/auth.phoneauthprovider.credentialfromresult.md create mode 100644 docs-exp/auth.phoneauthprovider.md create mode 100644 docs-exp/auth.phoneauthprovider.phone_sign_in_method.md create mode 100644 docs-exp/auth.phoneauthprovider.provider_id.md create mode 100644 docs-exp/auth.phoneauthprovider.providerid.md create mode 100644 docs-exp/auth.phoneauthprovider.verifyphonenumber.md create mode 100644 docs-exp/auth.phonemultifactorgenerator.assertion.md create mode 100644 docs-exp/auth.phonemultifactorgenerator.md create mode 100644 docs-exp/auth.reauthenticatewithcredential.md create mode 100644 docs-exp/auth.reauthenticatewithphonenumber.md create mode 100644 docs-exp/auth.reauthenticatewithpopup.md create mode 100644 docs-exp/auth.reauthenticatewithredirect.md create mode 100644 docs-exp/auth.recaptchaverifier._constructor_.md create mode 100644 docs-exp/auth.recaptchaverifier._recaptchaloader.md create mode 100644 docs-exp/auth.recaptchaverifier._reset.md create mode 100644 docs-exp/auth.recaptchaverifier.clear.md create mode 100644 docs-exp/auth.recaptchaverifier.md create mode 100644 docs-exp/auth.recaptchaverifier.render.md create mode 100644 docs-exp/auth.recaptchaverifier.type.md create mode 100644 docs-exp/auth.recaptchaverifier.verify.md create mode 100644 docs-exp/auth.reload.md create mode 100644 docs-exp/auth.sendemailverification.md create mode 100644 docs-exp/auth.sendpasswordresetemail.md create mode 100644 docs-exp/auth.sendsigninlinktoemail.md create mode 100644 docs-exp/auth.setpersistence.md create mode 100644 docs-exp/auth.signinanonymously.md create mode 100644 docs-exp/auth.signinwithcredential.md create mode 100644 docs-exp/auth.signinwithcustomtoken.md create mode 100644 docs-exp/auth.signinwithemailandpassword.md create mode 100644 docs-exp/auth.signinwithemaillink.md create mode 100644 docs-exp/auth.signinwithphonenumber.md create mode 100644 docs-exp/auth.signinwithpopup.md create mode 100644 docs-exp/auth.signinwithredirect.md create mode 100644 docs-exp/auth.signout.md create mode 100644 docs-exp/auth.twitterauthprovider.credential.md create mode 100644 docs-exp/auth.twitterauthprovider.credentialfromerror.md create mode 100644 docs-exp/auth.twitterauthprovider.credentialfromresult.md create mode 100644 docs-exp/auth.twitterauthprovider.md create mode 100644 docs-exp/auth.twitterauthprovider.provider_id.md create mode 100644 docs-exp/auth.twitterauthprovider.providerid.md create mode 100644 docs-exp/auth.twitterauthprovider.twitter_sign_in_method.md create mode 100644 docs-exp/auth.unlink.md create mode 100644 docs-exp/auth.updatecurrentuser.md create mode 100644 docs-exp/auth.updateemail.md create mode 100644 docs-exp/auth.updatepassword.md create mode 100644 docs-exp/auth.updatephonenumber.md create mode 100644 docs-exp/auth.updateprofile.md create mode 100644 docs-exp/auth.usedevicelanguage.md create mode 100644 docs-exp/auth.verifybeforeupdateemail.md create mode 100644 docs-exp/auth.verifypasswordresetcode.md delete mode 100644 docs-exp/performance.registerperformance.md diff --git a/common/api-review/auth-exp.api.md b/common/api-review/auth-exp.api.md new file mode 100644 index 00000000000..f86520621a7 --- /dev/null +++ b/common/api-review/auth-exp.api.md @@ -0,0 +1,451 @@ +## API Report File for "@firebase/auth-exp" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { Auth } from '@firebase/auth-types-exp'; +import { CompleteFn } from '@firebase/util'; +import { ErrorFn } from '@firebase/util'; +import * as externs from '@firebase/auth-types-exp'; +import { FirebaseApp } from '@firebase/app-types-exp'; +import { FirebaseError } from '@firebase/util'; +import { ProviderId } from '@firebase/auth-types-exp'; +import { Unsubscribe } from '@firebase/util'; +import { UserCredential } from '@firebase/auth-types-exp'; + +// @public (undocumented) +export class ActionCodeURL implements externs.ActionCodeURL { + constructor(actionLink: string); + // (undocumented) + readonly apiKey: string; + // (undocumented) + readonly code: string; + // (undocumented) + readonly continueUrl: string | null; + // (undocumented) + readonly languageCode: string | null; + // (undocumented) + readonly operation: externs.Operation; + // (undocumented) + static parseLink(link: string): externs.ActionCodeURL | null; + // (undocumented) + readonly tenantId: string | null; +} + +// @public (undocumented) +export function applyActionCode(auth: externs.Auth, oobCode: string): Promise; + +// @public (undocumented) +export class AuthCredential { + protected constructor(providerId: string, signInMethod: string); + // Warning: (ae-forgotten-export) The symbol "AuthCore" needs to be exported by the entry point index.d.ts + // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts + // + // (undocumented) + _getIdTokenResponse(_auth: AuthCore): Promise; + // (undocumented) + _getReauthenticationResolver(_auth: AuthCore): Promise; + // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts + // + // (undocumented) + _linkToIdToken(_auth: AuthCore, _idToken: string): Promise; + // (undocumented) + readonly providerId: string; + // (undocumented) + readonly signInMethod: string; + // (undocumented) + toJSON(): object; +} + +// @public (undocumented) +export const browserLocalPersistence: externs.Persistence; + +// @public (undocumented) +export const browserPopupRedirectResolver: externs.PopupRedirectResolver; + +// @public (undocumented) +export const browserSessionPersistence: externs.Persistence; + +// @public (undocumented) +export function checkActionCode(auth: externs.Auth, oobCode: string): Promise; + +// @public (undocumented) +export function confirmPasswordReset(auth: externs.Auth, oobCode: string, newPassword: string): Promise; + +// @public (undocumented) +export function createUserWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; + +// @public (undocumented) +export function deleteUser(user: externs.User): Promise; + +// @public (undocumented) +export class EmailAuthCredential extends AuthCredential implements externs.AuthCredential { + // (undocumented) + readonly email: string; + // (undocumented) + static _fromEmailAndCode(email: string, oobCode: string, tenantId?: string | null): EmailAuthCredential; + // (undocumented) + static _fromEmailAndPassword(email: string, password: string): EmailAuthCredential; + // (undocumented) + static fromJSON(json: object | string): EmailAuthCredential | null; + // (undocumented) + _getIdTokenResponse(auth: AuthCore): Promise; + // (undocumented) + _getReauthenticationResolver(auth: AuthCore): Promise; + // (undocumented) + _linkToIdToken(auth: AuthCore, idToken: string): Promise; + // (undocumented) + readonly password: string; + // (undocumented) + readonly tenantId: string | null; + // (undocumented) + toJSON(): object; +} + +// @public (undocumented) +export class EmailAuthProvider implements externs.EmailAuthProvider { + // (undocumented) + static credential(email: string, password: string): EmailAuthCredential; + // (undocumented) + static credentialWithLink(email: string, emailLink: string): EmailAuthCredential; + // (undocumented) + static readonly EMAIL_LINK_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_LINK; + // (undocumented) + static readonly EMAIL_PASSWORD_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_PASSWORD; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.PASSWORD; + // (undocumented) + readonly providerId = externs.ProviderId.PASSWORD; +} + +// @public (undocumented) +export class FacebookAuthProvider extends OAuthProvider { + // (undocumented) + static credential(accessToken: string): externs.OAuthCredential; + // (undocumented) + static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; + // (undocumented) + static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; + // (undocumented) + static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; + // (undocumented) + readonly providerId = externs.ProviderId.FACEBOOK; +} + +// @public (undocumented) +export function fetchSignInMethodsForEmail(auth: externs.Auth, email: string): Promise; + +// @public (undocumented) +export function getAdditionalUserInfo(userCredential: externs.UserCredential): externs.AdditionalUserInfo | null; + +// @public (undocumented) +export function getAuth(app?: FirebaseApp): Auth; + +// @public (undocumented) +export function getIdToken(user: externs.User, forceRefresh?: boolean): Promise; + +// @public (undocumented) +export function getIdTokenResult(externUser: externs.User, forceRefresh?: boolean): Promise; + +// @public (undocumented) +export function getMultiFactorResolver(auth: externs.Auth, errorExtern: externs.MultiFactorError): externs.MultiFactorResolver; + +// @public (undocumented) +export function getRedirectResult(authExtern: externs.Auth, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export class GithubAuthProvider extends OAuthProvider { + // (undocumented) + static credential(accessToken: string): externs.OAuthCredential; + // (undocumented) + static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; + // (undocumented) + static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; + // (undocumented) + static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.GITHUB; + // (undocumented) + readonly providerId = externs.ProviderId.GITHUB; +} + +// @public (undocumented) +export class GoogleAuthProvider extends OAuthProvider { + // (undocumented) + static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential; + // (undocumented) + static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; + // (undocumented) + static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; + // (undocumented) + static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; + // (undocumented) + readonly providerId = externs.ProviderId.GOOGLE; +} + +// @public (undocumented) +export const indexedDBLocalPersistence: externs.Persistence; + +// Warning: (ae-forgotten-export) The symbol "Dependencies" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function initializeAuth(app?: FirebaseApp, deps?: Dependencies): externs.Auth; + +// @public (undocumented) +export const inMemoryPersistence: externs.Persistence; + +// @public (undocumented) +export function isSignInWithEmailLink(auth: externs.Auth, emailLink: string): boolean; + +// @public (undocumented) +export function linkWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; + +// @public (undocumented) +export function linkWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; + +// @public (undocumented) +export function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export function multiFactor(user: externs.User): externs.MultiFactorUser; + +// @public (undocumented) +export class OAuthCredential extends AuthCredential implements externs.OAuthCredential { + // (undocumented) + accessToken?: string; + // (undocumented) + static fromJSON(json: string | object): OAuthCredential | null; + // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts + // + // (undocumented) + static _fromParams(params: OAuthCredentialParams): OAuthCredential; + // (undocumented) + _getIdTokenResponse(auth: AuthCore): Promise; + // (undocumented) + _getReauthenticationResolver(auth: AuthCore): Promise; + // (undocumented) + idToken?: string; + // (undocumented) + _linkToIdToken(auth: AuthCore, idToken: string): Promise; + // (undocumented) + nonce?: string; + // (undocumented) + secret?: string; + // (undocumented) + toJSON(): object; +} + +// @public (undocumented) +export class OAuthProvider implements externs.AuthProvider { + constructor(providerId: string); + // (undocumented) + addScope(scope: string): externs.AuthProvider; + // Warning: (ae-forgotten-export) The symbol "CredentialParameters" needs to be exported by the entry point index.d.ts + // + // (undocumented) + credential(params: CredentialParameters): externs.OAuthCredential; + // (undocumented) + static credentialFromJSON(json: object | string): externs.OAuthCredential; + // (undocumented) + defaultLanguageCode: string | null; + // (undocumented) + getCustomParameters(): CustomParameters; + // (undocumented) + getScopes(): string[]; + // (undocumented) + readonly providerId: string; + // Warning: (ae-forgotten-export) The symbol "CustomParameters" needs to be exported by the entry point index.d.ts + // + // (undocumented) + setCustomParameters(customOAuthParameters: CustomParameters): externs.AuthProvider; + // (undocumented) + setDefaultLanguage(languageCode: string | null): void; +} + +// @public (undocumented) +export function onAuthStateChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; + +// @public (undocumented) +export function onIdTokenChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; + +// @public (undocumented) +export function parseActionCodeURL(link: string): externs.ActionCodeURL | null; + +// @public (undocumented) +export class PhoneAuthCredential extends AuthCredential implements externs.PhoneAuthCredential { + // (undocumented) + static fromJSON(json: object | string): PhoneAuthCredential | null; + // (undocumented) + static _fromTokenResponse(phoneNumber: string, temporaryProof: string): PhoneAuthCredential; + // (undocumented) + static _fromVerification(verificationId: string, verificationCode: string): PhoneAuthCredential; + // (undocumented) + _getIdTokenResponse(auth: AuthCore): Promise; + // (undocumented) + _getReauthenticationResolver(auth: AuthCore): Promise; + // (undocumented) + _linkToIdToken(auth: AuthCore, idToken: string): Promise; + // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts + // + // (undocumented) + _makeVerificationRequest(): SignInWithPhoneNumberRequest; + // (undocumented) + toJSON(): object; +} + +// @public (undocumented) +export class PhoneAuthProvider implements externs.PhoneAuthProvider { + constructor(auth: AuthCore); + // (undocumented) + static credential(verificationId: string, verificationCode: string): PhoneAuthCredential; + // (undocumented) + static credentialFromResult(userCredential: externs.UserCredential): externs.AuthCredential | null; + // (undocumented) + static readonly PHONE_SIGN_IN_METHOD = externs.SignInMethod.PHONE; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.PHONE; + // (undocumented) + readonly providerId = externs.ProviderId.PHONE; + // (undocumented) + verifyPhoneNumber(phoneOptions: externs.PhoneInfoOptions | string, applicationVerifier: externs.ApplicationVerifier): Promise; +} + +// @public (undocumented) +export class PhoneMultiFactorGenerator implements externs.PhoneMultiFactorGenerator { + // (undocumented) + static assertion(credential: externs.PhoneAuthCredential): externs.PhoneMultiFactorAssertion; +} + +// @public (undocumented) +export function reauthenticateWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; + +// @public (undocumented) +export function reauthenticateWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; + +// @public (undocumented) +export function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// Warning: (ae-forgotten-export) The symbol "ApplicationVerifier" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export class RecaptchaVerifier implements externs.RecaptchaVerifier, ApplicationVerifier { + // Warning: (ae-forgotten-export) The symbol "Parameters" needs to be exported by the entry point index.d.ts + constructor(containerOrId: HTMLElement | string, parameters: Parameters_2, auth: AuthCore); + // (undocumented) + clear(): void; + // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts + // + // (undocumented) + readonly _recaptchaLoader: ReCaptchaLoader; + // (undocumented) + render(): Promise; + // (undocumented) + _reset(): void; + // (undocumented) + readonly type = "recaptcha"; + // (undocumented) + verify(): Promise; + } + +// @public (undocumented) +export function reload(externUser: externs.User): Promise; + +// @public (undocumented) +export function sendEmailVerification(userExtern: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; + +// @public (undocumented) +export function sendPasswordResetEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; + +// @public (undocumented) +export function sendSignInLinkToEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; + +// @public (undocumented) +export function setPersistence(auth: externs.Auth, persistence: externs.Persistence): void; + +// @public (undocumented) +export function signInAnonymously(auth: externs.Auth): Promise; + +// @public (undocumented) +export function signInWithCredential(auth: externs.Auth, credential: externs.AuthCredential): Promise; + +// @public (undocumented) +export function signInWithCustomToken(authExtern: externs.Auth, customToken: string): Promise; + +// @public (undocumented) +export function signInWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; + +// @public (undocumented) +export function signInWithEmailLink(auth: externs.Auth, email: string, emailLink?: string): Promise; + +// @public (undocumented) +export function signInWithPhoneNumber(auth: externs.Auth, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; + +// @public (undocumented) +export function signInWithPopup(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export function signInWithRedirect(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; + +// @public (undocumented) +export function signOut(auth: externs.Auth): Promise; + +// @public (undocumented) +export class TwitterAuthProvider extends OAuthProvider { + // (undocumented) + static credential(token: string, secret: string): externs.OAuthCredential; + // (undocumented) + static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; + // (undocumented) + static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; + // (undocumented) + static readonly PROVIDER_ID = externs.ProviderId.TWITTER; + // (undocumented) + readonly providerId = externs.ProviderId.TWITTER; + // (undocumented) + static readonly TWITTER_SIGN_IN_METHOD = externs.SignInMethod.TWITTER; +} + +// @public +export function unlink(userExtern: externs.User, providerId: externs.ProviderId): Promise; + +// @public (undocumented) +export function updateCurrentUser(auth: externs.Auth, user: externs.User | null): Promise; + +// @public (undocumented) +export function updateEmail(externUser: externs.User, newEmail: string): Promise; + +// @public (undocumented) +export function updatePassword(externUser: externs.User, newPassword: string): Promise; + +// @public (undocumented) +export function updatePhoneNumber(user: externs.User, credential: externs.PhoneAuthCredential): Promise; + +// Warning: (ae-forgotten-export) The symbol "Profile" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function updateProfile(externUser: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; + +// @public (undocumented) +export function useDeviceLanguage(auth: externs.Auth): void; + +// @public (undocumented) +export function verifyBeforeUpdateEmail(userExtern: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; + +// @public (undocumented) +export function verifyPasswordResetCode(auth: externs.Auth, code: string): Promise; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/common/api-review/auth-types-exp.api.md b/common/api-review/auth-types-exp.api.md new file mode 100644 index 00000000000..6a0e032900f --- /dev/null +++ b/common/api-review/auth-types-exp.api.md @@ -0,0 +1,557 @@ +## API Report File for "@firebase/auth-types-exp" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompleteFn } from '@firebase/util'; +import { ErrorFn } from '@firebase/util'; +import { FirebaseError } from '@firebase/util'; +import { NextFn } from '@firebase/util'; +import { Observer } from '@firebase/util'; +import { Unsubscribe } from '@firebase/util'; + +// @public +export interface ActionCodeInfo { + // (undocumented) + data: { + email?: string | null; + multiFactorInfo?: MultiFactorInfo | null; + previousEmail?: string | null; + }; + // (undocumented) + operation: Operation; +} + +// @public +export interface ActionCodeSettings { + // (undocumented) + android?: { + installApp?: boolean; + minimumVersion?: string; + packageName: string; + }; + // (undocumented) + dynamicLinkDomain?: string; + // (undocumented) + handleCodeInApp?: boolean; + // (undocumented) + iOS?: { + bundleId: string; + }; + // (undocumented) + url: string; +} + +// @public +export abstract class ActionCodeURL { + // (undocumented) + readonly apiKey: string; + // (undocumented) + readonly code: string; + // (undocumented) + readonly continueUrl: string | null; + // (undocumented) + readonly languageCode: string | null; + // (undocumented) + readonly operation: Operation; + // (undocumented) + static parseLink(link: string): ActionCodeURL | null; + // (undocumented) + readonly tenantId: string | null; +} + +// @public +export interface AdditionalUserInfo { + // (undocumented) + readonly isNewUser: boolean; + // (undocumented) + readonly profile: UserProfile | null; + // (undocumented) + readonly providerId: ProviderId | null; + // (undocumented) + readonly username?: string | null; +} + +// @public +export interface ApplicationVerifier { + // (undocumented) + readonly type: string; + // (undocumented) + verify(): Promise; +} + +// @public +export interface Auth { + // (undocumented) + readonly config: Config; + // (undocumented) + readonly currentUser: User | null; + // (undocumented) + languageCode: string | null; + // (undocumented) + readonly name: string; + // (undocumented) + onAuthStateChanged( + nextOrObserver: NextOrObserver, + error?: ErrorFn, + completed?: CompleteFn + ): Unsubscribe; + // (undocumented) + onIdTokenChanged( + nextOrObserver: NextOrObserver, + error?: ErrorFn, + completed?: CompleteFn + ): Unsubscribe; + // (undocumented) + setPersistence(persistence: Persistence): void; + // (undocumented) + readonly settings: AuthSettings; + // (undocumented) + signOut(): Promise; + // (undocumented) + tenantId: string | null; + // (undocumented) + updateCurrentUser(user: User | null): Promise; + // (undocumented) + useDeviceLanguage(): void; + // (undocumented) + useEmulator(hostname: string, port: number): void; +} + +// @public +export abstract class AuthCredential { + // (undocumented) + static fromJSON(json: object | string): AuthCredential | null; + + // (undocumented) + readonly providerId: string; + + // (undocumented) + readonly signInMethod: string; + + // (undocumented) + toJSON(): object; +} + +// @public +export interface AuthError extends FirebaseError { + // (undocumented) + readonly appName: string; + + // (undocumented) + readonly email?: string; + + // (undocumented) + readonly phoneNumber?: string; + + // (undocumented) + readonly tenantid?: string; +} + +// @public +export interface AuthProvider { + // (undocumented) + readonly providerId: string; +} + +// @public +export interface AuthSettings { + // (undocumented) + appVerificationDisabledForTesting: boolean; +} + +// @public +export interface Config { + // (undocumented) + apiHost: string; + // (undocumented) + apiKey: string; + // (undocumented) + apiScheme: string; + // (undocumented) + authDomain?: string; + // (undocumented) + sdkClientVersion: string; + // (undocumented) + tokenApiHost: string; +} + +// @public +export interface ConfirmationResult { + // (undocumented) + confirm(verificationCode: string): Promise; + // (undocumented) + readonly verificationId: string; +} + +// @public +export abstract class EmailAuthProvider implements AuthProvider { + // (undocumented) + static credential(email: string, password: string): AuthCredential; + // (undocumented) + static credentialWithLink( + auth: Auth, + email: string, + emailLink: string + ): AuthCredential; + // (undocumented) + static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod; + // (undocumented) + static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod; + // (undocumented) + static readonly PROVIDER_ID: ProviderId; + // (undocumented) + readonly providerId: ProviderId; +} + +// @public +export interface IdTokenResult { + // (undocumented) + authTime: string; + // (undocumented) + claims: ParsedToken; + // (undocumented) + expirationTime: string; + // (undocumented) + issuedAtTime: string; + // (undocumented) + signInProvider: string | null; + // (undocumented) + signInSecondFactor: string | null; + // (undocumented) + token: string; +} + +// @public +export interface MultiFactorAssertion { + // (undocumented) + readonly factorId: string; +} + +// @public +export interface MultiFactorError extends AuthError { + // (undocumented) + readonly credential: AuthCredential; + // (undocumented) + readonly operationType: OperationType; +} + +// @public +export interface MultiFactorInfo { + // (undocumented) + readonly displayName?: string | null; + // (undocumented) + readonly enrollmentTime: string; + // (undocumented) + readonly factorId: ProviderId; + // (undocumented) + readonly uid: string; +} + +// @public +export abstract class MultiFactorResolver { + // (undocumented) + hints: MultiFactorInfo[]; + // (undocumented) + resolveSignIn(assertion: MultiFactorAssertion): Promise; + // (undocumented) + session: MultiFactorSession; +} + +// @public +export interface MultiFactorSession {} + +// @public +export interface MultiFactorUser { + // (undocumented) + enroll( + assertion: MultiFactorAssertion, + displayName?: string | null + ): Promise; + // (undocumented) + readonly enrolledFactors: MultiFactorInfo[]; + // (undocumented) + getSession(): Promise; + // (undocumented) + unenroll(option: MultiFactorInfo | string): Promise; +} + +// @public +export type NextOrObserver = NextFn | Observer; + +// @public +export abstract class OAuthCredential extends AuthCredential { + // (undocumented) + readonly accessToken?: string; + + // (undocumented) + static fromJSON(json: object | string): OAuthCredential | null; + + // (undocumented) + readonly idToken?: string; + + // (undocumented) + readonly secret?: string; +} + +// @public +export const enum Operation { + // (undocumented) + EMAIL_SIGNIN = 'EMAIL_SIGNIN', + // (undocumented) + PASSWORD_RESET = 'PASSWORD_RESET', + // (undocumented) + RECOVER_EMAIL = 'RECOVER_EMAIL', + // (undocumented) + REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION', + // (undocumented) + VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL', + // (undocumented) + VERIFY_EMAIL = 'VERIFY_EMAIL' +} + +// @public +export const enum OperationType { + // (undocumented) + LINK = 'link', + // (undocumented) + REAUTHENTICATE = 'reauthenticate', + // (undocumented) + SIGN_IN = 'signIn' +} + +// @public +export interface ParsedToken { + // (undocumented) + [key: string]: string | object | undefined; + // (undocumented) + 'auth_time'?: string; + // (undocumented) + 'exp'?: string; + // (undocumented) + 'firebase'?: { + 'sign_in_provider'?: string; + 'sign_in_second_factor'?: string; + }; + // (undocumented) + 'iat'?: string; + // (undocumented) + 'sub'?: string; +} + +// @public +export interface Persistence { + // (undocumented) + readonly type: 'SESSION' | 'LOCAL' | 'NONE'; +} + +// @public +export abstract class PhoneAuthCredential extends AuthCredential { + // (undocumented) + static fromJSON(json: object | string): PhoneAuthCredential | null; +} + +// @public +export class PhoneAuthProvider implements AuthProvider { + constructor(auth?: Auth | null); + // (undocumented) + static credential( + verificationId: string, + verificationCode: string + ): AuthCredential; + // (undocumented) + static readonly PHONE_SIGN_IN_METHOD: SignInMethod; + // (undocumented) + static readonly PROVIDER_ID: ProviderId; + // (undocumented) + readonly providerId: ProviderId; + // (undocumented) + verifyPhoneNumber( + phoneInfoOptions: PhoneInfoOptions | string, + applicationVerifier: ApplicationVerifier + ): Promise; +} + +// @public +export type PhoneInfoOptions = + | PhoneSingleFactorInfoOptions + | PhoneMultiFactorEnrollInfoOptions + | PhoneMultiFactorSignInInfoOptions; + +// @public +export interface PhoneMultiFactorAssertion extends MultiFactorAssertion {} + +// @public (undocumented) +export interface PhoneMultiFactorEnrollInfoOptions { + // (undocumented) + phoneNumber: string; + // (undocumented) + session: MultiFactorSession; +} + +// @public +export abstract class PhoneMultiFactorGenerator { + // (undocumented) + static assertion( + phoneAuthCredential: PhoneAuthCredential + ): PhoneMultiFactorAssertion; + // (undocumented) + static FACTOR_ID: ProviderId; +} + +// @public (undocumented) +export interface PhoneMultiFactorSignInInfoOptions { + // (undocumented) + multiFactorHint?: MultiFactorInfo; + // (undocumented) + multiFactorUid?: string; + // (undocumented) + session: MultiFactorSession; +} + +// @public (undocumented) +export interface PhoneSingleFactorInfoOptions { + // (undocumented) + phoneNumber: string; +} + +// @public +export interface PopupRedirectResolver {} + +// @public +export const enum ProviderId { + // (undocumented) + ANONYMOUS = 'anonymous', + // (undocumented) + CUSTOM = 'custom', + // (undocumented) + FACEBOOK = 'facebook.com', + // (undocumented) + FIREBASE = 'firebase', + // (undocumented) + GITHUB = 'github.com', + // (undocumented) + GOOGLE = 'google.com', + // (undocumented) + PASSWORD = 'password', + // (undocumented) + PHONE = 'phone', + // (undocumented) + TWITTER = 'twitter.com' +} + +// @public (undocumented) +export interface ReactNativeAsyncStorage { + // (undocumented) + getItem(key: string): Promise; + // (undocumented) + removeItem(key: string): Promise; + // (undocumented) + setItem(key: string, value: string): Promise; +} + +// @public +export abstract class RecaptchaVerifier implements ApplicationVerifier { + constructor( + container: any | string, + parameters?: Object | null, + auth?: Auth | null + ); + // (undocumented) + clear(): void; + // (undocumented) + render(): Promise; + // (undocumented) + readonly type: string; + // (undocumented) + verify(): Promise; +} + +// @public +export const enum SignInMethod { + // (undocumented) + ANONYMOUS = 'anonymous', + // (undocumented) + EMAIL_LINK = 'emailLink', + // (undocumented) + EMAIL_PASSWORD = 'password', + // (undocumented) + FACEBOOK = 'facebook.com', + // (undocumented) + GITHUB = 'github.com', + // (undocumented) + GOOGLE = 'google.com', + // (undocumented) + PHONE = 'phone', + // (undocumented) + TWITTER = 'twitter.com' +} + +// @public +export interface User extends UserInfo { + // (undocumented) + delete(): Promise; + // (undocumented) + readonly emailVerified: boolean; + // (undocumented) + getIdToken(forceRefresh?: boolean): Promise; + // (undocumented) + getIdTokenResult(forceRefresh?: boolean): Promise; + // (undocumented) + readonly isAnonymous: boolean; + // (undocumented) + readonly metadata: UserMetadata; + // (undocumented) + readonly providerData: UserInfo[]; + // (undocumented) + readonly refreshToken: string; + // (undocumented) + reload(): Promise; + // (undocumented) + readonly tenantId: string | null; + // (undocumented) + toJSON(): object; +} + +// @public +export interface UserCredential { + // (undocumented) + operationType: OperationType; + // (undocumented) + providerId: ProviderId | null; + // (undocumented) + user: User; +} + +// @public +export interface UserInfo { + // (undocumented) + readonly displayName: string | null; + // (undocumented) + readonly email: string | null; + // (undocumented) + readonly phoneNumber: string | null; + // (undocumented) + readonly photoURL: string | null; + // (undocumented) + readonly providerId: string; + // (undocumented) + readonly uid: string; +} + +// @public +export interface UserMetadata { + // (undocumented) + readonly creationTime?: string; + // (undocumented) + readonly lastSignInTime?: string; +} + +// @public +export type UserProfile = Record; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/docs-exp/auth-types.actioncodeinfo.data.md b/docs-exp/auth-types.actioncodeinfo.data.md new file mode 100644 index 00000000000..fcb46b989bb --- /dev/null +++ b/docs-exp/auth-types.actioncodeinfo.data.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) > [data](./auth-types.actioncodeinfo.data.md) + +## ActionCodeInfo.data property + +Signature: + +```typescript +data: { + email?: string | null; + multiFactorInfo?: MultiFactorInfo | null; + previousEmail?: string | null; + }; +``` diff --git a/docs-exp/auth-types.actioncodeinfo.md b/docs-exp/auth-types.actioncodeinfo.md new file mode 100644 index 00000000000..2c94067f213 --- /dev/null +++ b/docs-exp/auth-types.actioncodeinfo.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) + +## ActionCodeInfo interface + +https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo + +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; } | | +| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | | + diff --git a/docs-exp/auth-types.actioncodeinfo.operation.md b/docs-exp/auth-types.actioncodeinfo.operation.md new file mode 100644 index 00000000000..107a974d87a --- /dev/null +++ b/docs-exp/auth-types.actioncodeinfo.operation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeInfo](./auth-types.actioncodeinfo.md) > [operation](./auth-types.actioncodeinfo.operation.md) + +## ActionCodeInfo.operation property + +Signature: + +```typescript +operation: Operation; +``` diff --git a/docs-exp/auth-types.actioncodesettings.android.md b/docs-exp/auth-types.actioncodesettings.android.md new file mode 100644 index 00000000000..3f2fb765245 --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.android.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [android](./auth-types.actioncodesettings.android.md) + +## ActionCodeSettings.android property + +Signature: + +```typescript +android?: { + installApp?: boolean; + minimumVersion?: string; + packageName: string; + }; +``` diff --git a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md new file mode 100644 index 00000000000..b99eda2a742 --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) + +## ActionCodeSettings.dynamicLinkDomain property + +Signature: + +```typescript +dynamicLinkDomain?: string; +``` diff --git a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md new file mode 100644 index 00000000000..44f86269269 --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) + +## ActionCodeSettings.handleCodeInApp property + +Signature: + +```typescript +handleCodeInApp?: boolean; +``` diff --git a/docs-exp/auth-types.actioncodesettings.ios.md b/docs-exp/auth-types.actioncodesettings.ios.md new file mode 100644 index 00000000000..fd66f5e5485 --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.ios.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [iOS](./auth-types.actioncodesettings.ios.md) + +## ActionCodeSettings.iOS property + +Signature: + +```typescript +iOS?: { + bundleId: string; + }; +``` diff --git a/docs-exp/auth-types.actioncodesettings.md b/docs-exp/auth-types.actioncodesettings.md new file mode 100644 index 00000000000..3a3c1455397 --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) + +## ActionCodeSettings interface + +https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings + +Signature: + +```typescript +export interface ActionCodeSettings +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | | +| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | | +| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | | +| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | | +| [url](./auth-types.actioncodesettings.url.md) | string | | + diff --git a/docs-exp/auth-types.actioncodesettings.url.md b/docs-exp/auth-types.actioncodesettings.url.md new file mode 100644 index 00000000000..ab2ef041a8d --- /dev/null +++ b/docs-exp/auth-types.actioncodesettings.url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeSettings](./auth-types.actioncodesettings.md) > [url](./auth-types.actioncodesettings.url.md) + +## ActionCodeSettings.url property + +Signature: + +```typescript +url: string; +``` diff --git a/docs-exp/auth-types.actioncodeurl.apikey.md b/docs-exp/auth-types.actioncodeurl.apikey.md new file mode 100644 index 00000000000..d1c16d4307b --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.apikey.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [apiKey](./auth-types.actioncodeurl.apikey.md) + +## ActionCodeURL.apiKey property + +Signature: + +```typescript +readonly apiKey: string; +``` diff --git a/docs-exp/auth-types.actioncodeurl.code.md b/docs-exp/auth-types.actioncodeurl.code.md new file mode 100644 index 00000000000..ed51c711c1c --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.code.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [code](./auth-types.actioncodeurl.code.md) + +## ActionCodeURL.code property + +Signature: + +```typescript +readonly code: string; +``` diff --git a/docs-exp/auth-types.actioncodeurl.continueurl.md b/docs-exp/auth-types.actioncodeurl.continueurl.md new file mode 100644 index 00000000000..6d2a2643a56 --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.continueurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [continueUrl](./auth-types.actioncodeurl.continueurl.md) + +## ActionCodeURL.continueUrl property + +Signature: + +```typescript +readonly continueUrl: string | null; +``` diff --git a/docs-exp/auth-types.actioncodeurl.languagecode.md b/docs-exp/auth-types.actioncodeurl.languagecode.md new file mode 100644 index 00000000000..9f24dc7e9aa --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.languagecode.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [languageCode](./auth-types.actioncodeurl.languagecode.md) + +## ActionCodeURL.languageCode property + +Signature: + +```typescript +readonly languageCode: string | null; +``` diff --git a/docs-exp/auth-types.actioncodeurl.md b/docs-exp/auth-types.actioncodeurl.md new file mode 100644 index 00000000000..5c998008f70 --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) + +## ActionCodeURL class + +https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL + +Signature: + +```typescript +export abstract class ActionCodeURL +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | | +| [code](./auth-types.actioncodeurl.code.md) | | string | | +| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | | +| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | | +| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | | +| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static | | + diff --git a/docs-exp/auth-types.actioncodeurl.operation.md b/docs-exp/auth-types.actioncodeurl.operation.md new file mode 100644 index 00000000000..9e75986f290 --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.operation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [operation](./auth-types.actioncodeurl.operation.md) + +## ActionCodeURL.operation property + +Signature: + +```typescript +readonly operation: Operation; +``` diff --git a/docs-exp/auth-types.actioncodeurl.parselink.md b/docs-exp/auth-types.actioncodeurl.parselink.md new file mode 100644 index 00000000000..375a6a3635d --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.parselink.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [parseLink](./auth-types.actioncodeurl.parselink.md) + +## ActionCodeURL.parseLink() method + +Signature: + +```typescript +static parseLink(link: string): ActionCodeURL | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| link | string | | + +Returns: + +[ActionCodeURL](./auth-types.actioncodeurl.md) \| null + diff --git a/docs-exp/auth-types.actioncodeurl.tenantid.md b/docs-exp/auth-types.actioncodeurl.tenantid.md new file mode 100644 index 00000000000..c181bfe728c --- /dev/null +++ b/docs-exp/auth-types.actioncodeurl.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ActionCodeURL](./auth-types.actioncodeurl.md) > [tenantId](./auth-types.actioncodeurl.tenantid.md) + +## ActionCodeURL.tenantId property + +Signature: + +```typescript +readonly tenantId: string | null; +``` diff --git a/docs-exp/auth-types.additionaluserinfo.isnewuser.md b/docs-exp/auth-types.additionaluserinfo.isnewuser.md new file mode 100644 index 00000000000..7a35baf9a6b --- /dev/null +++ b/docs-exp/auth-types.additionaluserinfo.isnewuser.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) + +## AdditionalUserInfo.isNewUser property + +Signature: + +```typescript +readonly isNewUser: boolean; +``` diff --git a/docs-exp/auth-types.additionaluserinfo.md b/docs-exp/auth-types.additionaluserinfo.md new file mode 100644 index 00000000000..dcda2f0fcc4 --- /dev/null +++ b/docs-exp/auth-types.additionaluserinfo.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) + +## AdditionalUserInfo interface + +Additional user information. + +Signature: + +```typescript +export interface AdditionalUserInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | | +| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | | +| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | | +| [username](./auth-types.additionaluserinfo.username.md) | string \| null | | + diff --git a/docs-exp/auth-types.additionaluserinfo.profile.md b/docs-exp/auth-types.additionaluserinfo.profile.md new file mode 100644 index 00000000000..367352cc9f3 --- /dev/null +++ b/docs-exp/auth-types.additionaluserinfo.profile.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [profile](./auth-types.additionaluserinfo.profile.md) + +## AdditionalUserInfo.profile property + +Signature: + +```typescript +readonly profile: UserProfile | null; +``` diff --git a/docs-exp/auth-types.additionaluserinfo.providerid.md b/docs-exp/auth-types.additionaluserinfo.providerid.md new file mode 100644 index 00000000000..457c6c9da9e --- /dev/null +++ b/docs-exp/auth-types.additionaluserinfo.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [providerId](./auth-types.additionaluserinfo.providerid.md) + +## AdditionalUserInfo.providerId property + +Signature: + +```typescript +readonly providerId: ProviderId | null; +``` diff --git a/docs-exp/auth-types.additionaluserinfo.username.md b/docs-exp/auth-types.additionaluserinfo.username.md new file mode 100644 index 00000000000..0690abf0c09 --- /dev/null +++ b/docs-exp/auth-types.additionaluserinfo.username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AdditionalUserInfo](./auth-types.additionaluserinfo.md) > [username](./auth-types.additionaluserinfo.username.md) + +## AdditionalUserInfo.username property + +Signature: + +```typescript +readonly username?: string | null; +``` diff --git a/docs-exp/auth-types.applicationverifier.md b/docs-exp/auth-types.applicationverifier.md new file mode 100644 index 00000000000..b62ba6a19c8 --- /dev/null +++ b/docs-exp/auth-types.applicationverifier.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) + +## ApplicationVerifier interface + +https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier + +Signature: + +```typescript +export interface ApplicationVerifier +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [type](./auth-types.applicationverifier.type.md) | string | | + +## Methods + +| Method | Description | +| --- | --- | +| [verify()](./auth-types.applicationverifier.verify.md) | | + diff --git a/docs-exp/auth-types.applicationverifier.type.md b/docs-exp/auth-types.applicationverifier.type.md new file mode 100644 index 00000000000..7be9a80fb70 --- /dev/null +++ b/docs-exp/auth-types.applicationverifier.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) > [type](./auth-types.applicationverifier.type.md) + +## ApplicationVerifier.type property + +Signature: + +```typescript +readonly type: string; +``` diff --git a/docs-exp/auth-types.applicationverifier.verify.md b/docs-exp/auth-types.applicationverifier.verify.md new file mode 100644 index 00000000000..088e9c8cb4d --- /dev/null +++ b/docs-exp/auth-types.applicationverifier.verify.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ApplicationVerifier](./auth-types.applicationverifier.md) > [verify](./auth-types.applicationverifier.verify.md) + +## ApplicationVerifier.verify() method + +Signature: + +```typescript +verify(): Promise; +``` +Returns: + +Promise<string> + diff --git a/docs-exp/auth-types.auth.config.md b/docs-exp/auth-types.auth.config.md new file mode 100644 index 00000000000..707a520af87 --- /dev/null +++ b/docs-exp/auth-types.auth.config.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [config](./auth-types.auth.config.md) + +## Auth.config property + +Signature: + +```typescript +readonly config: Config; +``` diff --git a/docs-exp/auth-types.auth.currentuser.md b/docs-exp/auth-types.auth.currentuser.md new file mode 100644 index 00000000000..f25aed8a581 --- /dev/null +++ b/docs-exp/auth-types.auth.currentuser.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [currentUser](./auth-types.auth.currentuser.md) + +## Auth.currentUser property + +Signature: + +```typescript +readonly currentUser: User | null; +``` diff --git a/docs-exp/auth-types.auth.languagecode.md b/docs-exp/auth-types.auth.languagecode.md new file mode 100644 index 00000000000..f7ccb01afda --- /dev/null +++ b/docs-exp/auth-types.auth.languagecode.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [languageCode](./auth-types.auth.languagecode.md) + +## Auth.languageCode property + +Signature: + +```typescript +languageCode: string | null; +``` diff --git a/docs-exp/auth-types.auth.md b/docs-exp/auth-types.auth.md new file mode 100644 index 00000000000..aa7615514cd --- /dev/null +++ b/docs-exp/auth-types.auth.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) + +## Auth interface + +https://firebase.google.com/docs/reference/js/firebase.auth.Auth + +Signature: + +```typescript +export interface Auth +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | | +| [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | | +| [languageCode](./auth-types.auth.languagecode.md) | string \| null | | +| [name](./auth-types.auth.name.md) | string | | +| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | | +| [tenantId](./auth-types.auth.tenantid.md) | string \| null | | + +## Methods + +| Method | Description | +| --- | --- | +| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | | +| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | | +| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | | +| [signOut()](./auth-types.auth.signout.md) | | +| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | | +| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | | +| [useEmulator(hostname, port)](./auth-types.auth.useemulator.md) | | + diff --git a/docs-exp/auth-types.auth.name.md b/docs-exp/auth-types.auth.name.md new file mode 100644 index 00000000000..3efeb1ac5b2 --- /dev/null +++ b/docs-exp/auth-types.auth.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [name](./auth-types.auth.name.md) + +## Auth.name property + +Signature: + +```typescript +readonly name: string; +``` diff --git a/docs-exp/auth-types.auth.onauthstatechanged.md b/docs-exp/auth-types.auth.onauthstatechanged.md new file mode 100644 index 00000000000..a3b1905f277 --- /dev/null +++ b/docs-exp/auth-types.auth.onauthstatechanged.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [onAuthStateChanged](./auth-types.auth.onauthstatechanged.md) + +## Auth.onAuthStateChanged() method + +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)> | | +| error | ErrorFn | | +| completed | CompleteFn | | + +Returns: + +Unsubscribe + diff --git a/docs-exp/auth-types.auth.onidtokenchanged.md b/docs-exp/auth-types.auth.onidtokenchanged.md new file mode 100644 index 00000000000..954413feb5f --- /dev/null +++ b/docs-exp/auth-types.auth.onidtokenchanged.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [onIdTokenChanged](./auth-types.auth.onidtokenchanged.md) + +## Auth.onIdTokenChanged() method + +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)> | | +| error | ErrorFn | | +| completed | CompleteFn | | + +Returns: + +Unsubscribe + diff --git a/docs-exp/auth-types.auth.setpersistence.md b/docs-exp/auth-types.auth.setpersistence.md new file mode 100644 index 00000000000..c0e164d0b52 --- /dev/null +++ b/docs-exp/auth-types.auth.setpersistence.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [setPersistence](./auth-types.auth.setpersistence.md) + +## Auth.setPersistence() method + +Signature: + +```typescript +setPersistence(persistence: Persistence): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| persistence | [Persistence](./auth-types.persistence.md) | | + +Returns: + +void + diff --git a/docs-exp/auth-types.auth.settings.md b/docs-exp/auth-types.auth.settings.md new file mode 100644 index 00000000000..5ea4d5c65e1 --- /dev/null +++ b/docs-exp/auth-types.auth.settings.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [settings](./auth-types.auth.settings.md) + +## Auth.settings property + +Signature: + +```typescript +readonly settings: AuthSettings; +``` diff --git a/docs-exp/auth-types.auth.signout.md b/docs-exp/auth-types.auth.signout.md new file mode 100644 index 00000000000..e6a44b038bc --- /dev/null +++ b/docs-exp/auth-types.auth.signout.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [signOut](./auth-types.auth.signout.md) + +## Auth.signOut() method + +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 new file mode 100644 index 00000000000..57cba12a545 --- /dev/null +++ b/docs-exp/auth-types.auth.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [tenantId](./auth-types.auth.tenantid.md) + +## Auth.tenantId property + +Signature: + +```typescript +tenantId: string | null; +``` diff --git a/docs-exp/auth-types.auth.updatecurrentuser.md b/docs-exp/auth-types.auth.updatecurrentuser.md new file mode 100644 index 00000000000..3bcd24c70e1 --- /dev/null +++ b/docs-exp/auth-types.auth.updatecurrentuser.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [updateCurrentUser](./auth-types.auth.updatecurrentuser.md) + +## Auth.updateCurrentUser() method + +Signature: + +```typescript +updateCurrentUser(user: User | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| user | [User](./auth-types.user.md) \| null | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.auth.usedevicelanguage.md b/docs-exp/auth-types.auth.usedevicelanguage.md new file mode 100644 index 00000000000..8a19378f071 --- /dev/null +++ b/docs-exp/auth-types.auth.usedevicelanguage.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [useDeviceLanguage](./auth-types.auth.usedevicelanguage.md) + +## Auth.useDeviceLanguage() method + +Signature: + +```typescript +useDeviceLanguage(): void; +``` +Returns: + +void + diff --git a/docs-exp/auth-types.auth.useemulator.md b/docs-exp/auth-types.auth.useemulator.md new file mode 100644 index 00000000000..9f63781ebd0 --- /dev/null +++ b/docs-exp/auth-types.auth.useemulator.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Auth](./auth-types.auth.md) > [useEmulator](./auth-types.auth.useemulator.md) + +## Auth.useEmulator() method + +Signature: + +```typescript +useEmulator(hostname: string, port: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | | +| port | number | | + +Returns: + +void + diff --git a/docs-exp/auth-types.authcredential.fromjson.md b/docs-exp/auth-types.authcredential.fromjson.md new file mode 100644 index 00000000000..47f8f53921d --- /dev/null +++ b/docs-exp/auth-types.authcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [fromJSON](./auth-types.authcredential.fromjson.md) + +## AuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: object | string): AuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +[AuthCredential](./auth-types.authcredential.md) \| null + diff --git a/docs-exp/auth-types.authcredential.md b/docs-exp/auth-types.authcredential.md new file mode 100644 index 00000000000..6796708cf90 --- /dev/null +++ b/docs-exp/auth-types.authcredential.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) + +## AuthCredential class + +https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential + +Signature: + +```typescript +export abstract class AuthCredential +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [providerId](./auth-types.authcredential.providerid.md) | | string | | +| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [fromJSON(json)](./auth-types.authcredential.fromjson.md) | static | | +| [toJSON()](./auth-types.authcredential.tojson.md) | | | + diff --git a/docs-exp/auth-types.authcredential.providerid.md b/docs-exp/auth-types.authcredential.providerid.md new file mode 100644 index 00000000000..260a7e8889b --- /dev/null +++ b/docs-exp/auth-types.authcredential.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [providerId](./auth-types.authcredential.providerid.md) + +## AuthCredential.providerId property + +Signature: + +```typescript +readonly providerId: string; +``` diff --git a/docs-exp/auth-types.authcredential.signinmethod.md b/docs-exp/auth-types.authcredential.signinmethod.md new file mode 100644 index 00000000000..083a4421d8b --- /dev/null +++ b/docs-exp/auth-types.authcredential.signinmethod.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [signInMethod](./auth-types.authcredential.signinmethod.md) + +## AuthCredential.signInMethod property + +Signature: + +```typescript +readonly signInMethod: string; +``` diff --git a/docs-exp/auth-types.authcredential.tojson.md b/docs-exp/auth-types.authcredential.tojson.md new file mode 100644 index 00000000000..a60ba35bd59 --- /dev/null +++ b/docs-exp/auth-types.authcredential.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthCredential](./auth-types.authcredential.md) > [toJSON](./auth-types.authcredential.tojson.md) + +## AuthCredential.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth-types.autherror.appname.md b/docs-exp/auth-types.autherror.appname.md new file mode 100644 index 00000000000..5d214250458 --- /dev/null +++ b/docs-exp/auth-types.autherror.appname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [appName](./auth-types.autherror.appname.md) + +## AuthError.appName property + +Signature: + +```typescript +readonly appName: string; +``` diff --git a/docs-exp/auth-types.autherror.email.md b/docs-exp/auth-types.autherror.email.md new file mode 100644 index 00000000000..8e1fe38b659 --- /dev/null +++ b/docs-exp/auth-types.autherror.email.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [email](./auth-types.autherror.email.md) + +## AuthError.email property + +Signature: + +```typescript +readonly email?: string; +``` diff --git a/docs-exp/auth-types.autherror.md b/docs-exp/auth-types.autherror.md new file mode 100644 index 00000000000..79b5615f737 --- /dev/null +++ b/docs-exp/auth-types.autherror.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) + +## AuthError interface + +https://firebase.google.com/docs/reference/js/firebase.auth.AuthError + +Signature: + +```typescript +export interface AuthError extends FirebaseError +``` +Extends: FirebaseError + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appName](./auth-types.autherror.appname.md) | string | | +| [email](./auth-types.autherror.email.md) | string | | +| [phoneNumber](./auth-types.autherror.phonenumber.md) | string | | +| [tenantid](./auth-types.autherror.tenantid.md) | string | | + diff --git a/docs-exp/auth-types.autherror.phonenumber.md b/docs-exp/auth-types.autherror.phonenumber.md new file mode 100644 index 00000000000..ffce6d1fe59 --- /dev/null +++ b/docs-exp/auth-types.autherror.phonenumber.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [phoneNumber](./auth-types.autherror.phonenumber.md) + +## AuthError.phoneNumber property + +Signature: + +```typescript +readonly phoneNumber?: string; +``` diff --git a/docs-exp/auth-types.autherror.tenantid.md b/docs-exp/auth-types.autherror.tenantid.md new file mode 100644 index 00000000000..a3c396633d7 --- /dev/null +++ b/docs-exp/auth-types.autherror.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthError](./auth-types.autherror.md) > [tenantid](./auth-types.autherror.tenantid.md) + +## AuthError.tenantid property + +Signature: + +```typescript +readonly tenantid?: string; +``` diff --git a/docs-exp/auth-types.authprovider.md b/docs-exp/auth-types.authprovider.md new file mode 100644 index 00000000000..c9a29ec6d6c --- /dev/null +++ b/docs-exp/auth-types.authprovider.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthProvider](./auth-types.authprovider.md) + +## AuthProvider interface + +A provider for generating credentials + +https://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider + +Signature: + +```typescript +export interface AuthProvider +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [providerId](./auth-types.authprovider.providerid.md) | string | | + diff --git a/docs-exp/auth-types.authprovider.providerid.md b/docs-exp/auth-types.authprovider.providerid.md new file mode 100644 index 00000000000..a8af80c7e7a --- /dev/null +++ b/docs-exp/auth-types.authprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthProvider](./auth-types.authprovider.md) > [providerId](./auth-types.authprovider.providerid.md) + +## AuthProvider.providerId property + +Signature: + +```typescript +readonly providerId: string; +``` diff --git a/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md b/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md new file mode 100644 index 00000000000..f2512d1887a --- /dev/null +++ b/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthSettings](./auth-types.authsettings.md) > [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) + +## AuthSettings.appVerificationDisabledForTesting property + +Signature: + +```typescript +appVerificationDisabledForTesting: boolean; +``` diff --git a/docs-exp/auth-types.authsettings.md b/docs-exp/auth-types.authsettings.md new file mode 100644 index 00000000000..92ea98b6768 --- /dev/null +++ b/docs-exp/auth-types.authsettings.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [AuthSettings](./auth-types.authsettings.md) + +## AuthSettings interface + +https://firebase.google.com/docs/reference/js/firebase.auth.AuthSettings + +Signature: + +```typescript +export interface AuthSettings +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) | boolean | | + diff --git a/docs-exp/auth-types.config.apihost.md b/docs-exp/auth-types.config.apihost.md new file mode 100644 index 00000000000..0b2fa63a20e --- /dev/null +++ b/docs-exp/auth-types.config.apihost.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiHost](./auth-types.config.apihost.md) + +## Config.apiHost property + +Signature: + +```typescript +apiHost: string; +``` diff --git a/docs-exp/auth-types.config.apikey.md b/docs-exp/auth-types.config.apikey.md new file mode 100644 index 00000000000..c7cc7fe1591 --- /dev/null +++ b/docs-exp/auth-types.config.apikey.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiKey](./auth-types.config.apikey.md) + +## Config.apiKey property + +Signature: + +```typescript +apiKey: string; +``` diff --git a/docs-exp/auth-types.config.apischeme.md b/docs-exp/auth-types.config.apischeme.md new file mode 100644 index 00000000000..a9af37a5dcd --- /dev/null +++ b/docs-exp/auth-types.config.apischeme.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [apiScheme](./auth-types.config.apischeme.md) + +## Config.apiScheme property + +Signature: + +```typescript +apiScheme: string; +``` diff --git a/docs-exp/auth-types.config.authdomain.md b/docs-exp/auth-types.config.authdomain.md new file mode 100644 index 00000000000..ef2fa19916c --- /dev/null +++ b/docs-exp/auth-types.config.authdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [authDomain](./auth-types.config.authdomain.md) + +## Config.authDomain property + +Signature: + +```typescript +authDomain?: string; +``` diff --git a/docs-exp/auth-types.config.md b/docs-exp/auth-types.config.md new file mode 100644 index 00000000000..099ba33075e --- /dev/null +++ b/docs-exp/auth-types.config.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) + +## Config interface + +Auth config object + +Signature: + +```typescript +export interface Config +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiHost](./auth-types.config.apihost.md) | string | | +| [apiKey](./auth-types.config.apikey.md) | string | | +| [apiScheme](./auth-types.config.apischeme.md) | string | | +| [authDomain](./auth-types.config.authdomain.md) | string | | +| [sdkClientVersion](./auth-types.config.sdkclientversion.md) | string | | +| [tokenApiHost](./auth-types.config.tokenapihost.md) | string | | + diff --git a/docs-exp/auth-types.config.sdkclientversion.md b/docs-exp/auth-types.config.sdkclientversion.md new file mode 100644 index 00000000000..0b9e404605a --- /dev/null +++ b/docs-exp/auth-types.config.sdkclientversion.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [sdkClientVersion](./auth-types.config.sdkclientversion.md) + +## Config.sdkClientVersion property + +Signature: + +```typescript +sdkClientVersion: string; +``` diff --git a/docs-exp/auth-types.config.tokenapihost.md b/docs-exp/auth-types.config.tokenapihost.md new file mode 100644 index 00000000000..2b2af334b34 --- /dev/null +++ b/docs-exp/auth-types.config.tokenapihost.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Config](./auth-types.config.md) > [tokenApiHost](./auth-types.config.tokenapihost.md) + +## Config.tokenApiHost property + +Signature: + +```typescript +tokenApiHost: string; +``` diff --git a/docs-exp/auth-types.confirmationresult.confirm.md b/docs-exp/auth-types.confirmationresult.confirm.md new file mode 100644 index 00000000000..703f435a1be --- /dev/null +++ b/docs-exp/auth-types.confirmationresult.confirm.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) > [confirm](./auth-types.confirmationresult.confirm.md) + +## ConfirmationResult.confirm() method + +Signature: + +```typescript +confirm(verificationCode: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| verificationCode | string | | + +Returns: + +Promise<[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth-types.confirmationresult.md b/docs-exp/auth-types.confirmationresult.md new file mode 100644 index 00000000000..305be1c045b --- /dev/null +++ b/docs-exp/auth-types.confirmationresult.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) + +## ConfirmationResult interface + +https://firebase.google.com/docs/reference/js/firebase.auth.ConfirmationResult + +Signature: + +```typescript +export interface ConfirmationResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | | + +## Methods + +| Method | Description | +| --- | --- | +| [confirm(verificationCode)](./auth-types.confirmationresult.confirm.md) | | + diff --git a/docs-exp/auth-types.confirmationresult.verificationid.md b/docs-exp/auth-types.confirmationresult.verificationid.md new file mode 100644 index 00000000000..afc0eb72872 --- /dev/null +++ b/docs-exp/auth-types.confirmationresult.verificationid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ConfirmationResult](./auth-types.confirmationresult.md) > [verificationId](./auth-types.confirmationresult.verificationid.md) + +## ConfirmationResult.verificationId property + +Signature: + +```typescript +readonly verificationId: string; +``` diff --git a/docs-exp/auth-types.emailauthprovider.credential.md b/docs-exp/auth-types.emailauthprovider.credential.md new file mode 100644 index 00000000000..1489fd2b067 --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.credential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [credential](./auth-types.emailauthprovider.credential.md) + +## EmailAuthProvider.credential() method + +Signature: + +```typescript +static credential(email: string, password: string): AuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| email | string | | +| password | string | | + +Returns: + +[AuthCredential](./auth-types.authcredential.md) + diff --git a/docs-exp/auth-types.emailauthprovider.credentialwithlink.md b/docs-exp/auth-types.emailauthprovider.credentialwithlink.md new file mode 100644 index 00000000000..2857ddd8cba --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.credentialwithlink.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [credentialWithLink](./auth-types.emailauthprovider.credentialwithlink.md) + +## EmailAuthProvider.credentialWithLink() method + +Signature: + +```typescript +static credentialWithLink( + auth: Auth, + email: string, + emailLink: string + ): AuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | [Auth](./auth-types.auth.md) | | +| email | string | | +| emailLink | string | | + +Returns: + +[AuthCredential](./auth-types.authcredential.md) + 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 new file mode 100644 index 00000000000..3118cbe2354 --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md @@ -0,0 +1,11 @@ + + +[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 + +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 new file mode 100644 index 00000000000..8dabf3dfc9a --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md @@ -0,0 +1,11 @@ + + +[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 + +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 new file mode 100644 index 00000000000..18019b248e3 --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) + +## EmailAuthProvider class + +A provider for generating email & password and email link credentials + +https://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider + +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) | | +| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_password_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | | +| [PROVIDER\_ID](./auth-types.emailauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | | +| [providerId](./auth-types.emailauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(email, password)](./auth-types.emailauthprovider.credential.md) | static | | +| [credentialWithLink(auth, email, emailLink)](./auth-types.emailauthprovider.credentialwithlink.md) | static | | + diff --git a/docs-exp/auth-types.emailauthprovider.provider_id.md b/docs-exp/auth-types.emailauthprovider.provider_id.md new file mode 100644 index 00000000000..f6f44c17f10 --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[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 + +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 new file mode 100644 index 00000000000..235ffe71a2d --- /dev/null +++ b/docs-exp/auth-types.emailauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [EmailAuthProvider](./auth-types.emailauthprovider.md) > [providerId](./auth-types.emailauthprovider.providerid.md) + +## EmailAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId: ProviderId; +``` diff --git a/docs-exp/auth-types.idtokenresult.authtime.md b/docs-exp/auth-types.idtokenresult.authtime.md new file mode 100644 index 00000000000..86cdd6c275c --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.authtime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [authTime](./auth-types.idtokenresult.authtime.md) + +## IdTokenResult.authTime property + +Signature: + +```typescript +authTime: string; +``` diff --git a/docs-exp/auth-types.idtokenresult.claims.md b/docs-exp/auth-types.idtokenresult.claims.md new file mode 100644 index 00000000000..8947f1a3e1c --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.claims.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [claims](./auth-types.idtokenresult.claims.md) + +## IdTokenResult.claims property + +Signature: + +```typescript +claims: ParsedToken; +``` diff --git a/docs-exp/auth-types.idtokenresult.expirationtime.md b/docs-exp/auth-types.idtokenresult.expirationtime.md new file mode 100644 index 00000000000..73aacfd4c98 --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.expirationtime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [expirationTime](./auth-types.idtokenresult.expirationtime.md) + +## IdTokenResult.expirationTime property + +Signature: + +```typescript +expirationTime: string; +``` diff --git a/docs-exp/auth-types.idtokenresult.issuedattime.md b/docs-exp/auth-types.idtokenresult.issuedattime.md new file mode 100644 index 00000000000..931e4797660 --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.issuedattime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) + +## IdTokenResult.issuedAtTime property + +Signature: + +```typescript +issuedAtTime: string; +``` diff --git a/docs-exp/auth-types.idtokenresult.md b/docs-exp/auth-types.idtokenresult.md new file mode 100644 index 00000000000..b7c7dc66b6f --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) + +## IdTokenResult interface + +Parsed IdToken for use in public API + +https://firebase.google.com/docs/reference/js/firebase.auth.IDTokenResult + +Signature: + +```typescript +export interface IdTokenResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [authTime](./auth-types.idtokenresult.authtime.md) | string | | +| [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | | +| [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | | +| [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | | +| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | | +| [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | | +| [token](./auth-types.idtokenresult.token.md) | string | | + diff --git a/docs-exp/auth-types.idtokenresult.signinprovider.md b/docs-exp/auth-types.idtokenresult.signinprovider.md new file mode 100644 index 00000000000..62819045f53 --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.signinprovider.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [signInProvider](./auth-types.idtokenresult.signinprovider.md) + +## IdTokenResult.signInProvider property + +Signature: + +```typescript +signInProvider: string | null; +``` diff --git a/docs-exp/auth-types.idtokenresult.signinsecondfactor.md b/docs-exp/auth-types.idtokenresult.signinsecondfactor.md new file mode 100644 index 00000000000..c0228609989 --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.signinsecondfactor.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) + +## IdTokenResult.signInSecondFactor property + +Signature: + +```typescript +signInSecondFactor: string | null; +``` diff --git a/docs-exp/auth-types.idtokenresult.token.md b/docs-exp/auth-types.idtokenresult.token.md new file mode 100644 index 00000000000..222cf970c2e --- /dev/null +++ b/docs-exp/auth-types.idtokenresult.token.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [IdTokenResult](./auth-types.idtokenresult.md) > [token](./auth-types.idtokenresult.token.md) + +## IdTokenResult.token property + +Signature: + +```typescript +token: string; +``` diff --git a/docs-exp/auth-types.md b/docs-exp/auth-types.md new file mode 100644 index 00000000000..c4669bf39dc --- /dev/null +++ b/docs-exp/auth-types.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) + +## auth-types package + +## Classes + +| Class | Description | +| --- | --- | +| [ActionCodeURL](./auth-types.actioncodeurl.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL | +| [AuthCredential](./auth-types.authcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential | +| [EmailAuthProvider](./auth-types.emailauthprovider.md) | A provider for generating email & password and email link credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider | +| [MultiFactorResolver](./auth-types.multifactorresolver.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver | +| [OAuthCredential](./auth-types.oauthcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential | +| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phoneauthcredential | +| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | A provider for generating phone credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.PhoneAuthProvider | +| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorgenerator | +| [RecaptchaVerifier](./auth-types.recaptchaverifier.md) | https://firebase.google.com/docs/reference/js/firebase.auth.RecaptchaVerifier | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [Operation](./auth-types.operation.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo\#operation\_2 | +| [OperationType](./auth-types.operationtype.md) | Supported operation types | +| [ProviderId](./auth-types.providerid.md) | Supported providers | +| [SignInMethod](./auth-types.signinmethod.md) | Supported sign in methods | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo | +| [ActionCodeSettings](./auth-types.actioncodesettings.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings | +| [AdditionalUserInfo](./auth-types.additionaluserinfo.md) | Additional user information. | +| [ApplicationVerifier](./auth-types.applicationverifier.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier | +| [Auth](./auth-types.auth.md) | https://firebase.google.com/docs/reference/js/firebase.auth.Auth | +| [AuthError](./auth-types.autherror.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthError | +| [AuthProvider](./auth-types.authprovider.md) | A provider for generating credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider | +| [AuthSettings](./auth-types.authsettings.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthSettings | +| [Config](./auth-types.config.md) | Auth config object | +| [ConfirmationResult](./auth-types.confirmationresult.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ConfirmationResult | +| [IdTokenResult](./auth-types.idtokenresult.md) | Parsed IdToken for use in public APIhttps://firebase.google.com/docs/reference/js/firebase.auth.IDTokenResult | +| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorassertion | +| [MultiFactorError](./auth-types.multifactorerror.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorerror | +| [MultiFactorInfo](./auth-types.multifactorinfo.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorinfo | +| [MultiFactorSession](./auth-types.multifactorsession.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorsession | +| [MultiFactorUser](./auth-types.multifactoruser.md) | https://firebase.google.com/docs/reference/js/firebase.user.multifactoruser | +| [ParsedToken](./auth-types.parsedtoken.md) | Parsed Id TokenTODO(avolkovi): consolidate with parsed\_token in implementation | +| [Persistence](./auth-types.persistence.md) | https://firebase.google.com/docs/reference/js/firebase.auth.Auth\#persistence | +| [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorassertion | +| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | | +| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | | +| [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | | +| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | No documentation for this yet | +| [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | | +| [User](./auth-types.user.md) | https://firebase.google.com/docs/reference/js/firebase.User | +| [UserCredential](./auth-types.usercredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#usercredential | +| [UserInfo](./auth-types.userinfo.md) | https://firebase.google.com/docs/reference/js/firebase.UserInfo | +| [UserMetadata](./auth-types.usermetadata.md) | https://firebase.google.com/docs/reference/js/firebase.auth.UserMetadata | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [NextOrObserver](./auth-types.nextorobserver.md) | TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? | +| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#phoneinfooptions | +| [UserProfile](./auth-types.userprofile.md) | User profile used in AdditionalUserInfo | + diff --git a/docs-exp/auth-types.multifactorassertion.factorid.md b/docs-exp/auth-types.multifactorassertion.factorid.md new file mode 100644 index 00000000000..75339bf067f --- /dev/null +++ b/docs-exp/auth-types.multifactorassertion.factorid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorAssertion](./auth-types.multifactorassertion.md) > [factorId](./auth-types.multifactorassertion.factorid.md) + +## MultiFactorAssertion.factorId property + +Signature: + +```typescript +readonly factorId: string; +``` diff --git a/docs-exp/auth-types.multifactorassertion.md b/docs-exp/auth-types.multifactorassertion.md new file mode 100644 index 00000000000..15569fc4db3 --- /dev/null +++ b/docs-exp/auth-types.multifactorassertion.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorAssertion](./auth-types.multifactorassertion.md) + +## MultiFactorAssertion interface + +https://firebase.google.com/docs/reference/js/firebase.auth.multifactorassertion + +Signature: + +```typescript +export interface MultiFactorAssertion +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [factorId](./auth-types.multifactorassertion.factorid.md) | string | | + diff --git a/docs-exp/auth-types.multifactorerror.credential.md b/docs-exp/auth-types.multifactorerror.credential.md new file mode 100644 index 00000000000..96bf195d2a7 --- /dev/null +++ b/docs-exp/auth-types.multifactorerror.credential.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorError](./auth-types.multifactorerror.md) > [credential](./auth-types.multifactorerror.credential.md) + +## MultiFactorError.credential property + +Signature: + +```typescript +readonly credential: AuthCredential; +``` diff --git a/docs-exp/auth-types.multifactorerror.md b/docs-exp/auth-types.multifactorerror.md new file mode 100644 index 00000000000..b3de26523cf --- /dev/null +++ b/docs-exp/auth-types.multifactorerror.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorError](./auth-types.multifactorerror.md) + +## MultiFactorError interface + +https://firebase.google.com/docs/reference/js/firebase.auth.multifactorerror + +Signature: + +```typescript +export interface MultiFactorError extends AuthError +``` +Extends: [AuthError](./auth-types.autherror.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | | +| [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | | + diff --git a/docs-exp/auth-types.multifactorerror.operationtype.md b/docs-exp/auth-types.multifactorerror.operationtype.md new file mode 100644 index 00000000000..9720ba8e154 --- /dev/null +++ b/docs-exp/auth-types.multifactorerror.operationtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorError](./auth-types.multifactorerror.md) > [operationType](./auth-types.multifactorerror.operationtype.md) + +## MultiFactorError.operationType property + +Signature: + +```typescript +readonly operationType: OperationType; +``` diff --git a/docs-exp/auth-types.multifactorinfo.displayname.md b/docs-exp/auth-types.multifactorinfo.displayname.md new file mode 100644 index 00000000000..5d52c8f06db --- /dev/null +++ b/docs-exp/auth-types.multifactorinfo.displayname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [displayName](./auth-types.multifactorinfo.displayname.md) + +## MultiFactorInfo.displayName property + +Signature: + +```typescript +readonly displayName?: string | null; +``` diff --git a/docs-exp/auth-types.multifactorinfo.enrollmenttime.md b/docs-exp/auth-types.multifactorinfo.enrollmenttime.md new file mode 100644 index 00000000000..a205bd20065 --- /dev/null +++ b/docs-exp/auth-types.multifactorinfo.enrollmenttime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) + +## MultiFactorInfo.enrollmentTime property + +Signature: + +```typescript +readonly enrollmentTime: string; +``` diff --git a/docs-exp/auth-types.multifactorinfo.factorid.md b/docs-exp/auth-types.multifactorinfo.factorid.md new file mode 100644 index 00000000000..9b6413c3c36 --- /dev/null +++ b/docs-exp/auth-types.multifactorinfo.factorid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [factorId](./auth-types.multifactorinfo.factorid.md) + +## MultiFactorInfo.factorId property + +Signature: + +```typescript +readonly factorId: ProviderId; +``` diff --git a/docs-exp/auth-types.multifactorinfo.md b/docs-exp/auth-types.multifactorinfo.md new file mode 100644 index 00000000000..fc8f15d3944 --- /dev/null +++ b/docs-exp/auth-types.multifactorinfo.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) + +## MultiFactorInfo interface + +https://firebase.google.com/docs/reference/js/firebase.auth.multifactorinfo + +Signature: + +```typescript +export interface MultiFactorInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | | +| [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | | +| [factorId](./auth-types.multifactorinfo.factorid.md) | [ProviderId](./auth-types.providerid.md) | | +| [uid](./auth-types.multifactorinfo.uid.md) | string | | + diff --git a/docs-exp/auth-types.multifactorinfo.uid.md b/docs-exp/auth-types.multifactorinfo.uid.md new file mode 100644 index 00000000000..7c2dad6df7a --- /dev/null +++ b/docs-exp/auth-types.multifactorinfo.uid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorInfo](./auth-types.multifactorinfo.md) > [uid](./auth-types.multifactorinfo.uid.md) + +## MultiFactorInfo.uid property + +Signature: + +```typescript +readonly uid: string; +``` diff --git a/docs-exp/auth-types.multifactorresolver.hints.md b/docs-exp/auth-types.multifactorresolver.hints.md new file mode 100644 index 00000000000..1fe9ff6c0ff --- /dev/null +++ b/docs-exp/auth-types.multifactorresolver.hints.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [hints](./auth-types.multifactorresolver.hints.md) + +## MultiFactorResolver.hints property + +Signature: + +```typescript +hints: MultiFactorInfo[]; +``` diff --git a/docs-exp/auth-types.multifactorresolver.md b/docs-exp/auth-types.multifactorresolver.md new file mode 100644 index 00000000000..46316dac83d --- /dev/null +++ b/docs-exp/auth-types.multifactorresolver.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) + +## MultiFactorResolver class + +https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver + +Signature: + +```typescript +export abstract class MultiFactorResolver +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [hints](./auth-types.multifactorresolver.hints.md) | | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | | +| [session](./auth-types.multifactorresolver.session.md) | | [MultiFactorSession](./auth-types.multifactorsession.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [resolveSignIn(assertion)](./auth-types.multifactorresolver.resolvesignin.md) | | | + diff --git a/docs-exp/auth-types.multifactorresolver.resolvesignin.md b/docs-exp/auth-types.multifactorresolver.resolvesignin.md new file mode 100644 index 00000000000..245110ec88c --- /dev/null +++ b/docs-exp/auth-types.multifactorresolver.resolvesignin.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [resolveSignIn](./auth-types.multifactorresolver.resolvesignin.md) + +## MultiFactorResolver.resolveSignIn() method + +Signature: + +```typescript +resolveSignIn(assertion: MultiFactorAssertion): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | | + +Returns: + +Promise<[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth-types.multifactorresolver.session.md b/docs-exp/auth-types.multifactorresolver.session.md new file mode 100644 index 00000000000..ab51c8b820d --- /dev/null +++ b/docs-exp/auth-types.multifactorresolver.session.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorResolver](./auth-types.multifactorresolver.md) > [session](./auth-types.multifactorresolver.session.md) + +## MultiFactorResolver.session property + +Signature: + +```typescript +session: MultiFactorSession; +``` diff --git a/docs-exp/auth-types.multifactorsession.md b/docs-exp/auth-types.multifactorsession.md new file mode 100644 index 00000000000..fa4c4349441 --- /dev/null +++ b/docs-exp/auth-types.multifactorsession.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorSession](./auth-types.multifactorsession.md) + +## MultiFactorSession interface + +https://firebase.google.com/docs/reference/js/firebase.auth.multifactorsession + +Signature: + +```typescript +export interface MultiFactorSession +``` diff --git a/docs-exp/auth-types.multifactoruser.enroll.md b/docs-exp/auth-types.multifactoruser.enroll.md new file mode 100644 index 00000000000..e31fe0fc83c --- /dev/null +++ b/docs-exp/auth-types.multifactoruser.enroll.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [enroll](./auth-types.multifactoruser.enroll.md) + +## MultiFactorUser.enroll() method + +Signature: + +```typescript +enroll( + assertion: MultiFactorAssertion, + displayName?: string | null + ): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | | +| displayName | string \| null | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.multifactoruser.enrolledfactors.md b/docs-exp/auth-types.multifactoruser.enrolledfactors.md new file mode 100644 index 00000000000..2f04912ecb1 --- /dev/null +++ b/docs-exp/auth-types.multifactoruser.enrolledfactors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) + +## MultiFactorUser.enrolledFactors property + +Signature: + +```typescript +readonly enrolledFactors: MultiFactorInfo[]; +``` diff --git a/docs-exp/auth-types.multifactoruser.getsession.md b/docs-exp/auth-types.multifactoruser.getsession.md new file mode 100644 index 00000000000..70d23240cea --- /dev/null +++ b/docs-exp/auth-types.multifactoruser.getsession.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [getSession](./auth-types.multifactoruser.getsession.md) + +## MultiFactorUser.getSession() method + +Signature: + +```typescript +getSession(): Promise; +``` +Returns: + +Promise<[MultiFactorSession](./auth-types.multifactorsession.md)> + diff --git a/docs-exp/auth-types.multifactoruser.md b/docs-exp/auth-types.multifactoruser.md new file mode 100644 index 00000000000..cb5ee260d3e --- /dev/null +++ b/docs-exp/auth-types.multifactoruser.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) + +## MultiFactorUser interface + +https://firebase.google.com/docs/reference/js/firebase.user.multifactoruser + +Signature: + +```typescript +export interface MultiFactorUser +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | | + +## Methods + +| Method | Description | +| --- | --- | +| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | | +| [getSession()](./auth-types.multifactoruser.getsession.md) | | +| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | | + diff --git a/docs-exp/auth-types.multifactoruser.unenroll.md b/docs-exp/auth-types.multifactoruser.unenroll.md new file mode 100644 index 00000000000..efb4ac0cdfd --- /dev/null +++ b/docs-exp/auth-types.multifactoruser.unenroll.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [MultiFactorUser](./auth-types.multifactoruser.md) > [unenroll](./auth-types.multifactoruser.unenroll.md) + +## MultiFactorUser.unenroll() method + +Signature: + +```typescript +unenroll(option: MultiFactorInfo | string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| option | [MultiFactorInfo](./auth-types.multifactorinfo.md) \| string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.nextorobserver.md b/docs-exp/auth-types.nextorobserver.md new file mode 100644 index 00000000000..9daf288571a --- /dev/null +++ b/docs-exp/auth-types.nextorobserver.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [NextOrObserver](./auth-types.nextorobserver.md) + +## NextOrObserver type + +TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? + +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 new file mode 100644 index 00000000000..276bacfae87 --- /dev/null +++ b/docs-exp/auth-types.oauthcredential.accesstoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [accessToken](./auth-types.oauthcredential.accesstoken.md) + +## OAuthCredential.accessToken property + +Signature: + +```typescript +readonly accessToken?: string; +``` diff --git a/docs-exp/auth-types.oauthcredential.fromjson.md b/docs-exp/auth-types.oauthcredential.fromjson.md new file mode 100644 index 00000000000..483f8a78712 --- /dev/null +++ b/docs-exp/auth-types.oauthcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [fromJSON](./auth-types.oauthcredential.fromjson.md) + +## OAuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: object | string): OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth-types.oauthcredential.idtoken.md b/docs-exp/auth-types.oauthcredential.idtoken.md new file mode 100644 index 00000000000..833cf622122 --- /dev/null +++ b/docs-exp/auth-types.oauthcredential.idtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [idToken](./auth-types.oauthcredential.idtoken.md) + +## OAuthCredential.idToken property + +Signature: + +```typescript +readonly idToken?: string; +``` diff --git a/docs-exp/auth-types.oauthcredential.md b/docs-exp/auth-types.oauthcredential.md new file mode 100644 index 00000000000..526916240a9 --- /dev/null +++ b/docs-exp/auth-types.oauthcredential.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) + +## OAuthCredential class + +https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential + +Signature: + +```typescript +export abstract class OAuthCredential extends AuthCredential +``` +Extends: [AuthCredential](./auth-types.authcredential.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | | +| [idToken](./auth-types.oauthcredential.idtoken.md) | | string | | +| [secret](./auth-types.oauthcredential.secret.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [fromJSON(json)](./auth-types.oauthcredential.fromjson.md) | static | | + diff --git a/docs-exp/auth-types.oauthcredential.secret.md b/docs-exp/auth-types.oauthcredential.secret.md new file mode 100644 index 00000000000..21bbcee19c7 --- /dev/null +++ b/docs-exp/auth-types.oauthcredential.secret.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OAuthCredential](./auth-types.oauthcredential.md) > [secret](./auth-types.oauthcredential.secret.md) + +## OAuthCredential.secret property + +Signature: + +```typescript +readonly secret?: string; +``` diff --git a/docs-exp/auth-types.operation.md b/docs-exp/auth-types.operation.md new file mode 100644 index 00000000000..46abf37184e --- /dev/null +++ b/docs-exp/auth-types.operation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Operation](./auth-types.operation.md) + +## Operation enum + +https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo\#operation\_2 + +Signature: + +```typescript +export const enum Operation +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EMAIL\_SIGNIN | 'EMAIL_SIGNIN' | | +| PASSWORD\_RESET | 'PASSWORD_RESET' | | +| RECOVER\_EMAIL | 'RECOVER_EMAIL' | | +| REVERT\_SECOND\_FACTOR\_ADDITION | 'REVERT_SECOND_FACTOR_ADDITION' | | +| VERIFY\_AND\_CHANGE\_EMAIL | 'VERIFY_AND_CHANGE_EMAIL' | | +| VERIFY\_EMAIL | 'VERIFY_EMAIL' | | + diff --git a/docs-exp/auth-types.operationtype.md b/docs-exp/auth-types.operationtype.md new file mode 100644 index 00000000000..8dd44a52b3c --- /dev/null +++ b/docs-exp/auth-types.operationtype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [OperationType](./auth-types.operationtype.md) + +## OperationType enum + +Supported operation types + +Signature: + +```typescript +export const enum OperationType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| LINK | 'link' | | +| REAUTHENTICATE | 'reauthenticate' | | +| SIGN\_IN | 'signIn' | | + diff --git a/docs-exp/auth-types.parsedtoken.auth_time.md b/docs-exp/auth-types.parsedtoken.auth_time.md new file mode 100644 index 00000000000..ba89759d0a2 --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.auth_time.md @@ -0,0 +1,11 @@ + + +[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 + +Signature: + +```typescript +'auth_time'?: string; +``` diff --git a/docs-exp/auth-types.parsedtoken.exp.md b/docs-exp/auth-types.parsedtoken.exp.md new file mode 100644 index 00000000000..fa63501e70a --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.exp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [exp](./auth-types.parsedtoken.exp.md) + +## ParsedToken.exp property + +Signature: + +```typescript +'exp'?: string; +``` diff --git a/docs-exp/auth-types.parsedtoken.firebase.md b/docs-exp/auth-types.parsedtoken.firebase.md new file mode 100644 index 00000000000..946fa7eeb66 --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.firebase.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [firebase](./auth-types.parsedtoken.firebase.md) + +## ParsedToken.firebase property + +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 new file mode 100644 index 00000000000..1f233edcb1f --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.iat.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [iat](./auth-types.parsedtoken.iat.md) + +## ParsedToken.iat property + +Signature: + +```typescript +'iat'?: string; +``` diff --git a/docs-exp/auth-types.parsedtoken.md b/docs-exp/auth-types.parsedtoken.md new file mode 100644 index 00000000000..30466793bd3 --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) + +## ParsedToken interface + +Parsed Id Token + +TODO(avolkovi): consolidate with parsed\_token in implementation + +Signature: + +```typescript +export interface ParsedToken +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [auth\_time](./auth-types.parsedtoken.auth_time.md) | string | | +| [exp](./auth-types.parsedtoken.exp.md) | string | | +| [firebase](./auth-types.parsedtoken.firebase.md) | { 'sign\_in\_provider'?: string; 'sign\_in\_second\_factor'?: string; } | | +| [iat](./auth-types.parsedtoken.iat.md) | string | | +| [sub](./auth-types.parsedtoken.sub.md) | string | | + diff --git a/docs-exp/auth-types.parsedtoken.sub.md b/docs-exp/auth-types.parsedtoken.sub.md new file mode 100644 index 00000000000..0307efde1f5 --- /dev/null +++ b/docs-exp/auth-types.parsedtoken.sub.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ParsedToken](./auth-types.parsedtoken.md) > [sub](./auth-types.parsedtoken.sub.md) + +## ParsedToken.sub property + +Signature: + +```typescript +'sub'?: string; +``` diff --git a/docs-exp/auth-types.persistence.md b/docs-exp/auth-types.persistence.md new file mode 100644 index 00000000000..5b785a55f33 --- /dev/null +++ b/docs-exp/auth-types.persistence.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Persistence](./auth-types.persistence.md) + +## Persistence interface + +https://firebase.google.com/docs/reference/js/firebase.auth.Auth\#persistence + +Signature: + +```typescript +export interface Persistence +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | | + diff --git a/docs-exp/auth-types.persistence.type.md b/docs-exp/auth-types.persistence.type.md new file mode 100644 index 00000000000..9de2d0c0bee --- /dev/null +++ b/docs-exp/auth-types.persistence.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [Persistence](./auth-types.persistence.md) > [type](./auth-types.persistence.type.md) + +## Persistence.type property + +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 new file mode 100644 index 00000000000..fc2ba74883a --- /dev/null +++ b/docs-exp/auth-types.phoneauthcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) > [fromJSON](./auth-types.phoneauthcredential.fromjson.md) + +## PhoneAuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: object | string): PhoneAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +[PhoneAuthCredential](./auth-types.phoneauthcredential.md) \| null + diff --git a/docs-exp/auth-types.phoneauthcredential.md b/docs-exp/auth-types.phoneauthcredential.md new file mode 100644 index 00000000000..8cb19042899 --- /dev/null +++ b/docs-exp/auth-types.phoneauthcredential.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) + +## PhoneAuthCredential class + +https://firebase.google.com/docs/reference/js/firebase.auth.phoneauthcredential + +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 | | + diff --git a/docs-exp/auth-types.phoneauthprovider._constructor_.md b/docs-exp/auth-types.phoneauthprovider._constructor_.md new file mode 100644 index 00000000000..27251f405c8 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider._constructor_.md @@ -0,0 +1,20 @@ + + +[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 | | + diff --git a/docs-exp/auth-types.phoneauthprovider.credential.md b/docs-exp/auth-types.phoneauthprovider.credential.md new file mode 100644 index 00000000000..3e063737cf0 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.credential.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [credential](./auth-types.phoneauthprovider.credential.md) + +## PhoneAuthProvider.credential() method + +Signature: + +```typescript +static credential( + verificationId: string, + verificationCode: string + ): AuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| verificationId | string | | +| verificationCode | string | | + +Returns: + +[AuthCredential](./auth-types.authcredential.md) + diff --git a/docs-exp/auth-types.phoneauthprovider.md b/docs-exp/auth-types.phoneauthprovider.md new file mode 100644 index 00000000000..2321bd78d72 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) + +## PhoneAuthProvider class + +A provider for generating phone credentials + +https://firebase.google.com/docs/reference/js/firebase.auth.PhoneAuthProvider + +Signature: + +```typescript +export class PhoneAuthProvider implements AuthProvider +``` +Implements: [AuthProvider](./auth-types.authprovider.md) + +## 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) | | +| [PROVIDER\_ID](./auth-types.phoneauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | | +| [providerId](./auth-types.phoneauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | | +| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | | + diff --git a/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md b/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md new file mode 100644 index 00000000000..a138cf4f643 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md @@ -0,0 +1,11 @@ + + +[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 + +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 new file mode 100644 index 00000000000..a2d422cc365 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[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 + +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 new file mode 100644 index 00000000000..d93c98f1f8c --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [providerId](./auth-types.phoneauthprovider.providerid.md) + +## PhoneAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId: ProviderId; +``` diff --git a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md new file mode 100644 index 00000000000..83f934ddb82 --- /dev/null +++ b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthProvider](./auth-types.phoneauthprovider.md) > [verifyPhoneNumber](./auth-types.phoneauthprovider.verifyphonenumber.md) + +## PhoneAuthProvider.verifyPhoneNumber() method + +Signature: + +```typescript +verifyPhoneNumber( + phoneInfoOptions: PhoneInfoOptions | string, + applicationVerifier: ApplicationVerifier + ): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| phoneInfoOptions | [PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | | +| applicationVerifier | [ApplicationVerifier](./auth-types.applicationverifier.md) | | + +Returns: + +Promise<string> + diff --git a/docs-exp/auth-types.phoneinfooptions.md b/docs-exp/auth-types.phoneinfooptions.md new file mode 100644 index 00000000000..a46d881bfb5 --- /dev/null +++ b/docs-exp/auth-types.phoneinfooptions.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneInfoOptions](./auth-types.phoneinfooptions.md) + +## PhoneInfoOptions type + +https://firebase.google.com/docs/reference/js/firebase.auth\#phoneinfooptions + +Signature: + +```typescript +export type PhoneInfoOptions = + | PhoneSingleFactorInfoOptions + | PhoneMultiFactorEnrollInfoOptions + | PhoneMultiFactorSignInInfoOptions; +``` diff --git a/docs-exp/auth-types.phonemultifactorassertion.md b/docs-exp/auth-types.phonemultifactorassertion.md new file mode 100644 index 00000000000..d2e6a47de25 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorassertion.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) + +## PhoneMultiFactorAssertion interface + +https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorassertion + +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 new file mode 100644 index 00000000000..447376d2446 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) + +## PhoneMultiFactorEnrollInfoOptions interface + +Signature: + +```typescript +export interface PhoneMultiFactorEnrollInfoOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) | string | | +| [session](./auth-types.phonemultifactorenrollinfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | | + diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md new file mode 100644 index 00000000000..8fe88cafa7c --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) > [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) + +## PhoneMultiFactorEnrollInfoOptions.phoneNumber property + +Signature: + +```typescript +phoneNumber: string; +``` diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md new file mode 100644 index 00000000000..db214681f5b --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) > [session](./auth-types.phonemultifactorenrollinfooptions.session.md) + +## PhoneMultiFactorEnrollInfoOptions.session property + +Signature: + +```typescript +session: MultiFactorSession; +``` diff --git a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md new file mode 100644 index 00000000000..7a4565c9a98 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) > [assertion](./auth-types.phonemultifactorgenerator.assertion.md) + +## PhoneMultiFactorGenerator.assertion() method + +Signature: + +```typescript +static assertion( + phoneAuthCredential: PhoneAuthCredential + ): PhoneMultiFactorAssertion; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | | + +Returns: + +[PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) + diff --git a/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md b/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md new file mode 100644 index 00000000000..94552bd4c90 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md @@ -0,0 +1,11 @@ + + +[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 + +Signature: + +```typescript +static FACTOR_ID: ProviderId; +``` diff --git a/docs-exp/auth-types.phonemultifactorgenerator.md b/docs-exp/auth-types.phonemultifactorgenerator.md new file mode 100644 index 00000000000..140e132e5c7 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorgenerator.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) + +## PhoneMultiFactorGenerator class + +https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorgenerator + +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) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [assertion(phoneAuthCredential)](./auth-types.phonemultifactorgenerator.assertion.md) | static | | + diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.md new file mode 100644 index 00000000000..dae9188a691 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) + +## PhoneMultiFactorSignInInfoOptions interface + +Signature: + +```typescript +export interface PhoneMultiFactorSignInInfoOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md) | | +| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | | +| [session](./auth-types.phonemultifactorsignininfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | | + diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md new file mode 100644 index 00000000000..add03e11348 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) + +## PhoneMultiFactorSignInInfoOptions.multiFactorHint property + +Signature: + +```typescript +multiFactorHint?: MultiFactorInfo; +``` diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md new file mode 100644 index 00000000000..684026a83f0 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) + +## PhoneMultiFactorSignInInfoOptions.multiFactorUid property + +Signature: + +```typescript +multiFactorUid?: string; +``` diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md new file mode 100644 index 00000000000..7a6f51c6d60 --- /dev/null +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) > [session](./auth-types.phonemultifactorsignininfooptions.session.md) + +## PhoneMultiFactorSignInInfoOptions.session property + +Signature: + +```typescript +session: MultiFactorSession; +``` diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.md b/docs-exp/auth-types.phonesinglefactorinfooptions.md new file mode 100644 index 00000000000..69f54678555 --- /dev/null +++ b/docs-exp/auth-types.phonesinglefactorinfooptions.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) + +## PhoneSingleFactorInfoOptions interface + +Signature: + +```typescript +export interface PhoneSingleFactorInfoOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) | string | | + diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md b/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md new file mode 100644 index 00000000000..97e1de367f5 --- /dev/null +++ b/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) > [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) + +## PhoneSingleFactorInfoOptions.phoneNumber property + +Signature: + +```typescript +phoneNumber: string; +``` diff --git a/docs-exp/auth-types.popupredirectresolver.md b/docs-exp/auth-types.popupredirectresolver.md new file mode 100644 index 00000000000..5faf7698f91 --- /dev/null +++ b/docs-exp/auth-types.popupredirectresolver.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PopupRedirectResolver](./auth-types.popupredirectresolver.md) + +## PopupRedirectResolver interface + +No documentation for this yet + +Signature: + +```typescript +export interface PopupRedirectResolver +``` diff --git a/docs-exp/auth-types.providerid.md b/docs-exp/auth-types.providerid.md new file mode 100644 index 00000000000..aaf1e9a3a35 --- /dev/null +++ b/docs-exp/auth-types.providerid.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ProviderId](./auth-types.providerid.md) + +## ProviderId enum + +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 new file mode 100644 index 00000000000..94b149edb56 --- /dev/null +++ b/docs-exp/auth-types.reactnativeasyncstorage.getitem.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [getItem](./auth-types.reactnativeasyncstorage.getitem.md) + +## ReactNativeAsyncStorage.getItem() method + +Signature: + +```typescript +getItem(key: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | string | | + +Returns: + +Promise<string \| null> + diff --git a/docs-exp/auth-types.reactnativeasyncstorage.md b/docs-exp/auth-types.reactnativeasyncstorage.md new file mode 100644 index 00000000000..3804977e864 --- /dev/null +++ b/docs-exp/auth-types.reactnativeasyncstorage.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) + +## ReactNativeAsyncStorage interface + +Signature: + +```typescript +export interface ReactNativeAsyncStorage +``` + +## Methods + +| Method | Description | +| --- | --- | +| [getItem(key)](./auth-types.reactnativeasyncstorage.getitem.md) | | +| [removeItem(key)](./auth-types.reactnativeasyncstorage.removeitem.md) | | +| [setItem(key, value)](./auth-types.reactnativeasyncstorage.setitem.md) | | + diff --git a/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md b/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md new file mode 100644 index 00000000000..98e273c4d05 --- /dev/null +++ b/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [removeItem](./auth-types.reactnativeasyncstorage.removeitem.md) + +## ReactNativeAsyncStorage.removeItem() method + +Signature: + +```typescript +removeItem(key: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.reactnativeasyncstorage.setitem.md b/docs-exp/auth-types.reactnativeasyncstorage.setitem.md new file mode 100644 index 00000000000..17531386e46 --- /dev/null +++ b/docs-exp/auth-types.reactnativeasyncstorage.setitem.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) > [setItem](./auth-types.reactnativeasyncstorage.setitem.md) + +## ReactNativeAsyncStorage.setItem() method + +Signature: + +```typescript +setItem(key: string, value: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | string | | +| value | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.recaptchaverifier._constructor_.md b/docs-exp/auth-types.recaptchaverifier._constructor_.md new file mode 100644 index 00000000000..d58af83f20a --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier._constructor_.md @@ -0,0 +1,26 @@ + + +[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 new file mode 100644 index 00000000000..55d3f1ca3c1 --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier.clear.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [clear](./auth-types.recaptchaverifier.clear.md) + +## RecaptchaVerifier.clear() method + +Signature: + +```typescript +clear(): void; +``` +Returns: + +void + diff --git a/docs-exp/auth-types.recaptchaverifier.md b/docs-exp/auth-types.recaptchaverifier.md new file mode 100644 index 00000000000..1c9bdf40a67 --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) + +## RecaptchaVerifier class + +https://firebase.google.com/docs/reference/js/firebase.auth.RecaptchaVerifier + +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 | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [clear()](./auth-types.recaptchaverifier.clear.md) | | | +| [render()](./auth-types.recaptchaverifier.render.md) | | | +| [verify()](./auth-types.recaptchaverifier.verify.md) | | | + diff --git a/docs-exp/auth-types.recaptchaverifier.render.md b/docs-exp/auth-types.recaptchaverifier.render.md new file mode 100644 index 00000000000..728caab96d0 --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier.render.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [render](./auth-types.recaptchaverifier.render.md) + +## RecaptchaVerifier.render() method + +Signature: + +```typescript +render(): Promise; +``` +Returns: + +Promise<number> + diff --git a/docs-exp/auth-types.recaptchaverifier.type.md b/docs-exp/auth-types.recaptchaverifier.type.md new file mode 100644 index 00000000000..4e000332c59 --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [type](./auth-types.recaptchaverifier.type.md) + +## RecaptchaVerifier.type property + +Signature: + +```typescript +readonly type: string; +``` diff --git a/docs-exp/auth-types.recaptchaverifier.verify.md b/docs-exp/auth-types.recaptchaverifier.verify.md new file mode 100644 index 00000000000..e0335cb7a98 --- /dev/null +++ b/docs-exp/auth-types.recaptchaverifier.verify.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [RecaptchaVerifier](./auth-types.recaptchaverifier.md) > [verify](./auth-types.recaptchaverifier.verify.md) + +## RecaptchaVerifier.verify() method + +Signature: + +```typescript +verify(): Promise; +``` +Returns: + +Promise<string> + diff --git a/docs-exp/auth-types.signinmethod.md b/docs-exp/auth-types.signinmethod.md new file mode 100644 index 00000000000..dfd7ca0ceb0 --- /dev/null +++ b/docs-exp/auth-types.signinmethod.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [SignInMethod](./auth-types.signinmethod.md) + +## SignInMethod enum + +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 new file mode 100644 index 00000000000..e8868741dc3 --- /dev/null +++ b/docs-exp/auth-types.user.delete.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [delete](./auth-types.user.delete.md) + +## User.delete() method + +Signature: + +```typescript +delete(): Promise; +``` +Returns: + +Promise<void> + diff --git a/docs-exp/auth-types.user.emailverified.md b/docs-exp/auth-types.user.emailverified.md new file mode 100644 index 00000000000..98b1999336f --- /dev/null +++ b/docs-exp/auth-types.user.emailverified.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [emailVerified](./auth-types.user.emailverified.md) + +## User.emailVerified property + +Signature: + +```typescript +readonly emailVerified: boolean; +``` diff --git a/docs-exp/auth-types.user.getidtoken.md b/docs-exp/auth-types.user.getidtoken.md new file mode 100644 index 00000000000..83a13d93420 --- /dev/null +++ b/docs-exp/auth-types.user.getidtoken.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [getIdToken](./auth-types.user.getidtoken.md) + +## User.getIdToken() method + +Signature: + +```typescript +getIdToken(forceRefresh?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| forceRefresh | boolean | | + +Returns: + +Promise<string> + diff --git a/docs-exp/auth-types.user.getidtokenresult.md b/docs-exp/auth-types.user.getidtokenresult.md new file mode 100644 index 00000000000..29fa689f867 --- /dev/null +++ b/docs-exp/auth-types.user.getidtokenresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [getIdTokenResult](./auth-types.user.getidtokenresult.md) + +## User.getIdTokenResult() method + +Signature: + +```typescript +getIdTokenResult(forceRefresh?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| forceRefresh | boolean | | + +Returns: + +Promise<[IdTokenResult](./auth-types.idtokenresult.md)> + diff --git a/docs-exp/auth-types.user.isanonymous.md b/docs-exp/auth-types.user.isanonymous.md new file mode 100644 index 00000000000..9e679c81b09 --- /dev/null +++ b/docs-exp/auth-types.user.isanonymous.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [isAnonymous](./auth-types.user.isanonymous.md) + +## User.isAnonymous property + +Signature: + +```typescript +readonly isAnonymous: boolean; +``` diff --git a/docs-exp/auth-types.user.md b/docs-exp/auth-types.user.md new file mode 100644 index 00000000000..73a5dcbd3ae --- /dev/null +++ b/docs-exp/auth-types.user.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) + +## User interface + +https://firebase.google.com/docs/reference/js/firebase.User + +Signature: + +```typescript +export interface User extends UserInfo +``` +Extends: [UserInfo](./auth-types.userinfo.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [emailVerified](./auth-types.user.emailverified.md) | boolean | | +| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | | +| [metadata](./auth-types.user.metadata.md) | [UserMetadata](./auth-types.usermetadata.md) | | +| [providerData](./auth-types.user.providerdata.md) | [UserInfo](./auth-types.userinfo.md)\[\] | | +| [refreshToken](./auth-types.user.refreshtoken.md) | string | | +| [tenantId](./auth-types.user.tenantid.md) | string \| null | | + +## Methods + +| Method | Description | +| --- | --- | +| [delete()](./auth-types.user.delete.md) | | +| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | | +| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | | +| [reload()](./auth-types.user.reload.md) | | +| [toJSON()](./auth-types.user.tojson.md) | | + diff --git a/docs-exp/auth-types.user.metadata.md b/docs-exp/auth-types.user.metadata.md new file mode 100644 index 00000000000..5ea9521b2cd --- /dev/null +++ b/docs-exp/auth-types.user.metadata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [metadata](./auth-types.user.metadata.md) + +## User.metadata property + +Signature: + +```typescript +readonly metadata: UserMetadata; +``` diff --git a/docs-exp/auth-types.user.providerdata.md b/docs-exp/auth-types.user.providerdata.md new file mode 100644 index 00000000000..6c7cf6def44 --- /dev/null +++ b/docs-exp/auth-types.user.providerdata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [providerData](./auth-types.user.providerdata.md) + +## User.providerData property + +Signature: + +```typescript +readonly providerData: UserInfo[]; +``` diff --git a/docs-exp/auth-types.user.refreshtoken.md b/docs-exp/auth-types.user.refreshtoken.md new file mode 100644 index 00000000000..953ed1c4e54 --- /dev/null +++ b/docs-exp/auth-types.user.refreshtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [refreshToken](./auth-types.user.refreshtoken.md) + +## User.refreshToken property + +Signature: + +```typescript +readonly refreshToken: string; +``` diff --git a/docs-exp/auth-types.user.reload.md b/docs-exp/auth-types.user.reload.md new file mode 100644 index 00000000000..3a9879344d0 --- /dev/null +++ b/docs-exp/auth-types.user.reload.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [reload](./auth-types.user.reload.md) + +## User.reload() method + +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 new file mode 100644 index 00000000000..5a4f180bd65 --- /dev/null +++ b/docs-exp/auth-types.user.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [tenantId](./auth-types.user.tenantid.md) + +## User.tenantId property + +Signature: + +```typescript +readonly tenantId: string | null; +``` diff --git a/docs-exp/auth-types.user.tojson.md b/docs-exp/auth-types.user.tojson.md new file mode 100644 index 00000000000..31d1264ddae --- /dev/null +++ b/docs-exp/auth-types.user.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [User](./auth-types.user.md) > [toJSON](./auth-types.user.tojson.md) + +## User.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth-types.usercredential.md b/docs-exp/auth-types.usercredential.md new file mode 100644 index 00000000000..a13cfd6eb6e --- /dev/null +++ b/docs-exp/auth-types.usercredential.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) + +## UserCredential interface + +https://firebase.google.com/docs/reference/js/firebase.auth\#usercredential + +Signature: + +```typescript +export interface UserCredential +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [operationType](./auth-types.usercredential.operationtype.md) | [OperationType](./auth-types.operationtype.md) | | +| [providerId](./auth-types.usercredential.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | | +| [user](./auth-types.usercredential.user.md) | [User](./auth-types.user.md) | | + diff --git a/docs-exp/auth-types.usercredential.operationtype.md b/docs-exp/auth-types.usercredential.operationtype.md new file mode 100644 index 00000000000..a36c2ad6eb7 --- /dev/null +++ b/docs-exp/auth-types.usercredential.operationtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [operationType](./auth-types.usercredential.operationtype.md) + +## UserCredential.operationType property + +Signature: + +```typescript +operationType: OperationType; +``` diff --git a/docs-exp/auth-types.usercredential.providerid.md b/docs-exp/auth-types.usercredential.providerid.md new file mode 100644 index 00000000000..425e9fc157a --- /dev/null +++ b/docs-exp/auth-types.usercredential.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [providerId](./auth-types.usercredential.providerid.md) + +## UserCredential.providerId property + +Signature: + +```typescript +providerId: ProviderId | null; +``` diff --git a/docs-exp/auth-types.usercredential.user.md b/docs-exp/auth-types.usercredential.user.md new file mode 100644 index 00000000000..e89a6407fa9 --- /dev/null +++ b/docs-exp/auth-types.usercredential.user.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserCredential](./auth-types.usercredential.md) > [user](./auth-types.usercredential.user.md) + +## UserCredential.user property + +Signature: + +```typescript +user: User; +``` diff --git a/docs-exp/auth-types.userinfo.displayname.md b/docs-exp/auth-types.userinfo.displayname.md new file mode 100644 index 00000000000..87e72d23cc3 --- /dev/null +++ b/docs-exp/auth-types.userinfo.displayname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [displayName](./auth-types.userinfo.displayname.md) + +## UserInfo.displayName property + +Signature: + +```typescript +readonly displayName: string | null; +``` diff --git a/docs-exp/auth-types.userinfo.email.md b/docs-exp/auth-types.userinfo.email.md new file mode 100644 index 00000000000..32d0cb4813e --- /dev/null +++ b/docs-exp/auth-types.userinfo.email.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [email](./auth-types.userinfo.email.md) + +## UserInfo.email property + +Signature: + +```typescript +readonly email: string | null; +``` diff --git a/docs-exp/auth-types.userinfo.md b/docs-exp/auth-types.userinfo.md new file mode 100644 index 00000000000..ff8607e0bf1 --- /dev/null +++ b/docs-exp/auth-types.userinfo.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) + +## UserInfo interface + +https://firebase.google.com/docs/reference/js/firebase.UserInfo + +Signature: + +```typescript +export interface UserInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./auth-types.userinfo.displayname.md) | string \| null | | +| [email](./auth-types.userinfo.email.md) | string \| null | | +| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | | +| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | | +| [providerId](./auth-types.userinfo.providerid.md) | string | | +| [uid](./auth-types.userinfo.uid.md) | string | | + diff --git a/docs-exp/auth-types.userinfo.phonenumber.md b/docs-exp/auth-types.userinfo.phonenumber.md new file mode 100644 index 00000000000..38a13f54cec --- /dev/null +++ b/docs-exp/auth-types.userinfo.phonenumber.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [phoneNumber](./auth-types.userinfo.phonenumber.md) + +## UserInfo.phoneNumber property + +Signature: + +```typescript +readonly phoneNumber: string | null; +``` diff --git a/docs-exp/auth-types.userinfo.photourl.md b/docs-exp/auth-types.userinfo.photourl.md new file mode 100644 index 00000000000..e096f2726b2 --- /dev/null +++ b/docs-exp/auth-types.userinfo.photourl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [photoURL](./auth-types.userinfo.photourl.md) + +## UserInfo.photoURL property + +Signature: + +```typescript +readonly photoURL: string | null; +``` diff --git a/docs-exp/auth-types.userinfo.providerid.md b/docs-exp/auth-types.userinfo.providerid.md new file mode 100644 index 00000000000..46602904366 --- /dev/null +++ b/docs-exp/auth-types.userinfo.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [providerId](./auth-types.userinfo.providerid.md) + +## UserInfo.providerId property + +Signature: + +```typescript +readonly providerId: string; +``` diff --git a/docs-exp/auth-types.userinfo.uid.md b/docs-exp/auth-types.userinfo.uid.md new file mode 100644 index 00000000000..6a5a4b5ee33 --- /dev/null +++ b/docs-exp/auth-types.userinfo.uid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserInfo](./auth-types.userinfo.md) > [uid](./auth-types.userinfo.uid.md) + +## UserInfo.uid property + +Signature: + +```typescript +readonly uid: string; +``` diff --git a/docs-exp/auth-types.usermetadata.creationtime.md b/docs-exp/auth-types.usermetadata.creationtime.md new file mode 100644 index 00000000000..8f878555a12 --- /dev/null +++ b/docs-exp/auth-types.usermetadata.creationtime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) > [creationTime](./auth-types.usermetadata.creationtime.md) + +## UserMetadata.creationTime property + +Signature: + +```typescript +readonly creationTime?: string; +``` diff --git a/docs-exp/auth-types.usermetadata.lastsignintime.md b/docs-exp/auth-types.usermetadata.lastsignintime.md new file mode 100644 index 00000000000..a27139887e5 --- /dev/null +++ b/docs-exp/auth-types.usermetadata.lastsignintime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) > [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) + +## UserMetadata.lastSignInTime property + +Signature: + +```typescript +readonly lastSignInTime?: string; +``` diff --git a/docs-exp/auth-types.usermetadata.md b/docs-exp/auth-types.usermetadata.md new file mode 100644 index 00000000000..7f7aa8397e4 --- /dev/null +++ b/docs-exp/auth-types.usermetadata.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserMetadata](./auth-types.usermetadata.md) + +## UserMetadata interface + +https://firebase.google.com/docs/reference/js/firebase.auth.UserMetadata + +Signature: + +```typescript +export interface UserMetadata +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [creationTime](./auth-types.usermetadata.creationtime.md) | string | | +| [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) | string | | + diff --git a/docs-exp/auth-types.userprofile.md b/docs-exp/auth-types.userprofile.md new file mode 100644 index 00000000000..4a099d88872 --- /dev/null +++ b/docs-exp/auth-types.userprofile.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [UserProfile](./auth-types.userprofile.md) + +## UserProfile type + +User profile used in `AdditionalUserInfo` + +Signature: + +```typescript +export type UserProfile = Record; +``` diff --git a/docs-exp/auth.actioncodeurl._constructor_.md b/docs-exp/auth.actioncodeurl._constructor_.md new file mode 100644 index 00000000000..f9610df25c6 --- /dev/null +++ b/docs-exp/auth.actioncodeurl._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [(constructor)](./auth.actioncodeurl._constructor_.md) + +## ActionCodeURL.(constructor) + +Constructs a new instance of the `ActionCodeURL` class + +Signature: + +```typescript +constructor(actionLink: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actionLink | string | | + diff --git a/docs-exp/auth.actioncodeurl.apikey.md b/docs-exp/auth.actioncodeurl.apikey.md new file mode 100644 index 00000000000..0c096dfb508 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.apikey.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [apiKey](./auth.actioncodeurl.apikey.md) + +## ActionCodeURL.apiKey property + +Signature: + +```typescript +readonly apiKey: string; +``` diff --git a/docs-exp/auth.actioncodeurl.code.md b/docs-exp/auth.actioncodeurl.code.md new file mode 100644 index 00000000000..f0850003f40 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.code.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [code](./auth.actioncodeurl.code.md) + +## ActionCodeURL.code property + +Signature: + +```typescript +readonly code: string; +``` diff --git a/docs-exp/auth.actioncodeurl.continueurl.md b/docs-exp/auth.actioncodeurl.continueurl.md new file mode 100644 index 00000000000..691deb0219c --- /dev/null +++ b/docs-exp/auth.actioncodeurl.continueurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [continueUrl](./auth.actioncodeurl.continueurl.md) + +## ActionCodeURL.continueUrl property + +Signature: + +```typescript +readonly continueUrl: string | null; +``` diff --git a/docs-exp/auth.actioncodeurl.languagecode.md b/docs-exp/auth.actioncodeurl.languagecode.md new file mode 100644 index 00000000000..266a902bd42 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.languagecode.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [languageCode](./auth.actioncodeurl.languagecode.md) + +## ActionCodeURL.languageCode property + +Signature: + +```typescript +readonly languageCode: string | null; +``` diff --git a/docs-exp/auth.actioncodeurl.md b/docs-exp/auth.actioncodeurl.md new file mode 100644 index 00000000000..ddfa4e3a680 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) + +## ActionCodeURL class + +Signature: + +```typescript +export declare class ActionCodeURL implements externs.ActionCodeURL +``` +Implements: externs.[ActionCodeURL](./auth-types.actioncodeurl.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(actionLink)](./auth.actioncodeurl._constructor_.md) | | Constructs a new instance of the ActionCodeURL class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiKey](./auth.actioncodeurl.apikey.md) | | string | | +| [code](./auth.actioncodeurl.code.md) | | string | | +| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | | +| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | | +| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | | +| [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [parseLink(link)](./auth.actioncodeurl.parselink.md) | static | | + diff --git a/docs-exp/auth.actioncodeurl.operation.md b/docs-exp/auth.actioncodeurl.operation.md new file mode 100644 index 00000000000..e6644c5cae9 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.operation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [operation](./auth.actioncodeurl.operation.md) + +## ActionCodeURL.operation property + +Signature: + +```typescript +readonly operation: externs.Operation; +``` diff --git a/docs-exp/auth.actioncodeurl.parselink.md b/docs-exp/auth.actioncodeurl.parselink.md new file mode 100644 index 00000000000..ebef8f3c468 --- /dev/null +++ b/docs-exp/auth.actioncodeurl.parselink.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [parseLink](./auth.actioncodeurl.parselink.md) + +## ActionCodeURL.parseLink() method + +Signature: + +```typescript +static parseLink(link: string): externs.ActionCodeURL | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| link | string | | + +Returns: + +externs.[ActionCodeURL](./auth-types.actioncodeurl.md) \| null + diff --git a/docs-exp/auth.actioncodeurl.tenantid.md b/docs-exp/auth.actioncodeurl.tenantid.md new file mode 100644 index 00000000000..bbd86e49deb --- /dev/null +++ b/docs-exp/auth.actioncodeurl.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [tenantId](./auth.actioncodeurl.tenantid.md) + +## ActionCodeURL.tenantId property + +Signature: + +```typescript +readonly tenantId: string | null; +``` diff --git a/docs-exp/auth.applyactioncode.md b/docs-exp/auth.applyactioncode.md new file mode 100644 index 00000000000..c2bcb0f8416 --- /dev/null +++ b/docs-exp/auth.applyactioncode.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [applyActionCode](./auth.applyactioncode.md) + +## applyActionCode() function + +Signature: + +```typescript +export declare function applyActionCode(auth: externs.Auth, oobCode: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| oobCode | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.authcredential._constructor_.md b/docs-exp/auth.authcredential._constructor_.md new file mode 100644 index 00000000000..b5c53f465e3 --- /dev/null +++ b/docs-exp/auth.authcredential._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [(constructor)](./auth.authcredential._constructor_.md) + +## AuthCredential.(constructor) + +Constructs a new instance of the `AuthCredential` class + +Signature: + +```typescript +protected constructor(providerId: string, signInMethod: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| providerId | string | | +| signInMethod | string | | + diff --git a/docs-exp/auth.authcredential._getidtokenresponse.md b/docs-exp/auth.authcredential._getidtokenresponse.md new file mode 100644 index 00000000000..c3326a29fc5 --- /dev/null +++ b/docs-exp/auth.authcredential._getidtokenresponse.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_getIdTokenResponse](./auth.authcredential._getidtokenresponse.md) + +## AuthCredential.\_getIdTokenResponse() method + +Signature: + +```typescript +_getIdTokenResponse(_auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_auth | AuthCore | | + +Returns: + +Promise<PhoneOrOauthTokenResponse> + diff --git a/docs-exp/auth.authcredential._getreauthenticationresolver.md b/docs-exp/auth.authcredential._getreauthenticationresolver.md new file mode 100644 index 00000000000..919efadbd23 --- /dev/null +++ b/docs-exp/auth.authcredential._getreauthenticationresolver.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_getReauthenticationResolver](./auth.authcredential._getreauthenticationresolver.md) + +## AuthCredential.\_getReauthenticationResolver() method + +Signature: + +```typescript +_getReauthenticationResolver(_auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.authcredential._linktoidtoken.md b/docs-exp/auth.authcredential._linktoidtoken.md new file mode 100644 index 00000000000..5422c8c5759 --- /dev/null +++ b/docs-exp/auth.authcredential._linktoidtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_linkToIdToken](./auth.authcredential._linktoidtoken.md) + +## AuthCredential.\_linkToIdToken() method + +Signature: + +```typescript +_linkToIdToken(_auth: AuthCore, _idToken: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_auth | AuthCore | | +| \_idToken | string | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.authcredential.md b/docs-exp/auth.authcredential.md new file mode 100644 index 00000000000..9afaf9f26e8 --- /dev/null +++ b/docs-exp/auth.authcredential.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) + +## AuthCredential class + +Signature: + +```typescript +export declare class AuthCredential +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(providerId, signInMethod)](./auth.authcredential._constructor_.md) | | Constructs a new instance of the AuthCredential class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [providerId](./auth.authcredential.providerid.md) | | string | | +| [signInMethod](./auth.authcredential.signinmethod.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_getIdTokenResponse(\_auth)](./auth.authcredential._getidtokenresponse.md) | | | +| [\_getReauthenticationResolver(\_auth)](./auth.authcredential._getreauthenticationresolver.md) | | | +| [\_linkToIdToken(\_auth, \_idToken)](./auth.authcredential._linktoidtoken.md) | | | +| [toJSON()](./auth.authcredential.tojson.md) | | | + diff --git a/docs-exp/auth.authcredential.providerid.md b/docs-exp/auth.authcredential.providerid.md new file mode 100644 index 00000000000..181c671bdea --- /dev/null +++ b/docs-exp/auth.authcredential.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [providerId](./auth.authcredential.providerid.md) + +## AuthCredential.providerId property + +Signature: + +```typescript +readonly providerId: string; +``` diff --git a/docs-exp/auth.authcredential.signinmethod.md b/docs-exp/auth.authcredential.signinmethod.md new file mode 100644 index 00000000000..6c9034f18ef --- /dev/null +++ b/docs-exp/auth.authcredential.signinmethod.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [signInMethod](./auth.authcredential.signinmethod.md) + +## AuthCredential.signInMethod property + +Signature: + +```typescript +readonly signInMethod: string; +``` diff --git a/docs-exp/auth.authcredential.tojson.md b/docs-exp/auth.authcredential.tojson.md new file mode 100644 index 00000000000..cf6beaa1d04 --- /dev/null +++ b/docs-exp/auth.authcredential.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [toJSON](./auth.authcredential.tojson.md) + +## AuthCredential.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth.browserlocalpersistence.md b/docs-exp/auth.browserlocalpersistence.md new file mode 100644 index 00000000000..fb783710869 --- /dev/null +++ b/docs-exp/auth.browserlocalpersistence.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [browserLocalPersistence](./auth.browserlocalpersistence.md) + +## browserLocalPersistence variable + +Signature: + +```typescript +browserLocalPersistence: externs.Persistence +``` diff --git a/docs-exp/auth.browserpopupredirectresolver.md b/docs-exp/auth.browserpopupredirectresolver.md new file mode 100644 index 00000000000..fcf0fe7fd25 --- /dev/null +++ b/docs-exp/auth.browserpopupredirectresolver.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [browserPopupRedirectResolver](./auth.browserpopupredirectresolver.md) + +## browserPopupRedirectResolver variable + +Signature: + +```typescript +browserPopupRedirectResolver: externs.PopupRedirectResolver +``` diff --git a/docs-exp/auth.browsersessionpersistence.md b/docs-exp/auth.browsersessionpersistence.md new file mode 100644 index 00000000000..614260f5092 --- /dev/null +++ b/docs-exp/auth.browsersessionpersistence.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [browserSessionPersistence](./auth.browsersessionpersistence.md) + +## browserSessionPersistence variable + +Signature: + +```typescript +browserSessionPersistence: externs.Persistence +``` diff --git a/docs-exp/auth.checkactioncode.md b/docs-exp/auth.checkactioncode.md new file mode 100644 index 00000000000..349fd4daba4 --- /dev/null +++ b/docs-exp/auth.checkactioncode.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [checkActionCode](./auth.checkactioncode.md) + +## checkActionCode() function + +Signature: + +```typescript +export declare function checkActionCode(auth: externs.Auth, oobCode: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| oobCode | string | | + +Returns: + +Promise<externs.[ActionCodeInfo](./auth-types.actioncodeinfo.md)> + diff --git a/docs-exp/auth.confirmpasswordreset.md b/docs-exp/auth.confirmpasswordreset.md new file mode 100644 index 00000000000..2006eaa961b --- /dev/null +++ b/docs-exp/auth.confirmpasswordreset.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [confirmPasswordReset](./auth.confirmpasswordreset.md) + +## confirmPasswordReset() function + +Signature: + +```typescript +export declare function confirmPasswordReset(auth: externs.Auth, oobCode: string, newPassword: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| oobCode | string | | +| newPassword | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.createuserwithemailandpassword.md b/docs-exp/auth.createuserwithemailandpassword.md new file mode 100644 index 00000000000..9b7b66ab58f --- /dev/null +++ b/docs-exp/auth.createuserwithemailandpassword.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [createUserWithEmailAndPassword](./auth.createuserwithemailandpassword.md) + +## createUserWithEmailAndPassword() function + +Signature: + +```typescript +export declare function createUserWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | +| password | string | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.deleteuser.md b/docs-exp/auth.deleteuser.md new file mode 100644 index 00000000000..3cc1811f228 --- /dev/null +++ b/docs-exp/auth.deleteuser.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [deleteUser](./auth.deleteuser.md) + +## deleteUser() function + +Signature: + +```typescript +export declare function deleteUser(user: externs.User): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| user | externs.[User](./auth-types.user.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.emailauthcredential._fromemailandcode.md b/docs-exp/auth.emailauthcredential._fromemailandcode.md new file mode 100644 index 00000000000..e446f40f791 --- /dev/null +++ b/docs-exp/auth.emailauthcredential._fromemailandcode.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_fromEmailAndCode](./auth.emailauthcredential._fromemailandcode.md) + +## EmailAuthCredential.\_fromEmailAndCode() method + +Signature: + +```typescript +static _fromEmailAndCode(email: string, oobCode: string, tenantId?: string | null): EmailAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| email | string | | +| oobCode | string | | +| tenantId | string \| null | | + +Returns: + +[EmailAuthCredential](./auth.emailauthcredential.md) + diff --git a/docs-exp/auth.emailauthcredential._fromemailandpassword.md b/docs-exp/auth.emailauthcredential._fromemailandpassword.md new file mode 100644 index 00000000000..f362d10f488 --- /dev/null +++ b/docs-exp/auth.emailauthcredential._fromemailandpassword.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_fromEmailAndPassword](./auth.emailauthcredential._fromemailandpassword.md) + +## EmailAuthCredential.\_fromEmailAndPassword() method + +Signature: + +```typescript +static _fromEmailAndPassword(email: string, password: string): EmailAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| email | string | | +| password | string | | + +Returns: + +[EmailAuthCredential](./auth.emailauthcredential.md) + diff --git a/docs-exp/auth.emailauthcredential._getidtokenresponse.md b/docs-exp/auth.emailauthcredential._getidtokenresponse.md new file mode 100644 index 00000000000..4537fe7b4cf --- /dev/null +++ b/docs-exp/auth.emailauthcredential._getidtokenresponse.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_getIdTokenResponse](./auth.emailauthcredential._getidtokenresponse.md) + +## EmailAuthCredential.\_getIdTokenResponse() method + +Signature: + +```typescript +_getIdTokenResponse(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md b/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md new file mode 100644 index 00000000000..fe77fa06984 --- /dev/null +++ b/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_getReauthenticationResolver](./auth.emailauthcredential._getreauthenticationresolver.md) + +## EmailAuthCredential.\_getReauthenticationResolver() method + +Signature: + +```typescript +_getReauthenticationResolver(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.emailauthcredential._linktoidtoken.md b/docs-exp/auth.emailauthcredential._linktoidtoken.md new file mode 100644 index 00000000000..a9d83e5bcf6 --- /dev/null +++ b/docs-exp/auth.emailauthcredential._linktoidtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_linkToIdToken](./auth.emailauthcredential._linktoidtoken.md) + +## EmailAuthCredential.\_linkToIdToken() method + +Signature: + +```typescript +_linkToIdToken(auth: AuthCore, idToken: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | +| idToken | string | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.emailauthcredential.email.md b/docs-exp/auth.emailauthcredential.email.md new file mode 100644 index 00000000000..5ff3e67b9f0 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.email.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [email](./auth.emailauthcredential.email.md) + +## EmailAuthCredential.email property + +Signature: + +```typescript +readonly email: string; +``` diff --git a/docs-exp/auth.emailauthcredential.fromjson.md b/docs-exp/auth.emailauthcredential.fromjson.md new file mode 100644 index 00000000000..9b59922d1d9 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [fromJSON](./auth.emailauthcredential.fromjson.md) + +## EmailAuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: object | string): EmailAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +[EmailAuthCredential](./auth.emailauthcredential.md) \| null + diff --git a/docs-exp/auth.emailauthcredential.md b/docs-exp/auth.emailauthcredential.md new file mode 100644 index 00000000000..d4c4de7cb10 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) + +## EmailAuthCredential class + +Signature: + +```typescript +export declare class EmailAuthCredential extends AuthCredential implements externs.AuthCredential +``` +Extends: [AuthCredential](./auth.authcredential.md) + +Implements: externs.[AuthCredential](./auth-types.authcredential.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [email](./auth.emailauthcredential.email.md) | | string | | +| [password](./auth.emailauthcredential.password.md) | | string | | +| [tenantId](./auth.emailauthcredential.tenantid.md) | | string \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_fromEmailAndCode(email, oobCode, tenantId)](./auth.emailauthcredential._fromemailandcode.md) | static | | +| [\_fromEmailAndPassword(email, password)](./auth.emailauthcredential._fromemailandpassword.md) | static | | +| [\_getIdTokenResponse(auth)](./auth.emailauthcredential._getidtokenresponse.md) | | | +| [\_getReauthenticationResolver(auth)](./auth.emailauthcredential._getreauthenticationresolver.md) | | | +| [\_linkToIdToken(auth, idToken)](./auth.emailauthcredential._linktoidtoken.md) | | | +| [fromJSON(json)](./auth.emailauthcredential.fromjson.md) | static | | +| [toJSON()](./auth.emailauthcredential.tojson.md) | | | + diff --git a/docs-exp/auth.emailauthcredential.password.md b/docs-exp/auth.emailauthcredential.password.md new file mode 100644 index 00000000000..4e2cad762a7 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [password](./auth.emailauthcredential.password.md) + +## EmailAuthCredential.password property + +Signature: + +```typescript +readonly password: string; +``` diff --git a/docs-exp/auth.emailauthcredential.tenantid.md b/docs-exp/auth.emailauthcredential.tenantid.md new file mode 100644 index 00000000000..a1394f2c4b6 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.tenantid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [tenantId](./auth.emailauthcredential.tenantid.md) + +## EmailAuthCredential.tenantId property + +Signature: + +```typescript +readonly tenantId: string | null; +``` diff --git a/docs-exp/auth.emailauthcredential.tojson.md b/docs-exp/auth.emailauthcredential.tojson.md new file mode 100644 index 00000000000..2c361c80906 --- /dev/null +++ b/docs-exp/auth.emailauthcredential.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [toJSON](./auth.emailauthcredential.tojson.md) + +## EmailAuthCredential.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth.emailauthprovider.credential.md b/docs-exp/auth.emailauthprovider.credential.md new file mode 100644 index 00000000000..259c895d748 --- /dev/null +++ b/docs-exp/auth.emailauthprovider.credential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [credential](./auth.emailauthprovider.credential.md) + +## EmailAuthProvider.credential() method + +Signature: + +```typescript +static credential(email: string, password: string): EmailAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| email | string | | +| password | string | | + +Returns: + +[EmailAuthCredential](./auth.emailauthcredential.md) + diff --git a/docs-exp/auth.emailauthprovider.credentialwithlink.md b/docs-exp/auth.emailauthprovider.credentialwithlink.md new file mode 100644 index 00000000000..63f44a625f8 --- /dev/null +++ b/docs-exp/auth.emailauthprovider.credentialwithlink.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [credentialWithLink](./auth.emailauthprovider.credentialwithlink.md) + +## EmailAuthProvider.credentialWithLink() method + +Signature: + +```typescript +static credentialWithLink(email: string, emailLink: string): EmailAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| email | string | | +| emailLink | string | | + +Returns: + +[EmailAuthCredential](./auth.emailauthcredential.md) + diff --git a/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md b/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md new file mode 100644 index 00000000000..88cb9fa850d --- /dev/null +++ b/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_link_sign_in_method.md) + +## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly EMAIL_LINK_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_LINK; +``` diff --git a/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md b/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md new file mode 100644 index 00000000000..35e1392dc4f --- /dev/null +++ b/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_password_sign_in_method.md) + +## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly EMAIL_PASSWORD_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_PASSWORD; +``` diff --git a/docs-exp/auth.emailauthprovider.md b/docs-exp/auth.emailauthprovider.md new file mode 100644 index 00000000000..3908a331975 --- /dev/null +++ b/docs-exp/auth.emailauthprovider.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) + +## EmailAuthProvider class + +Signature: + +```typescript +export declare class EmailAuthProvider implements externs.EmailAuthProvider +``` +Implements: externs.[EmailAuthProvider](./auth-types.emailauthprovider.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_link_sign_in_method.md) | static | (not declared) | | +| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_password_sign_in_method.md) | static | (not declared) | | +| [PROVIDER\_ID](./auth.emailauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.emailauthprovider.providerid.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(email, password)](./auth.emailauthprovider.credential.md) | static | | +| [credentialWithLink(email, emailLink)](./auth.emailauthprovider.credentialwithlink.md) | static | | + diff --git a/docs-exp/auth.emailauthprovider.provider_id.md b/docs-exp/auth.emailauthprovider.provider_id.md new file mode 100644 index 00000000000..f0ee1c8473f --- /dev/null +++ b/docs-exp/auth.emailauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [PROVIDER\_ID](./auth.emailauthprovider.provider_id.md) + +## EmailAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.PASSWORD; +``` diff --git a/docs-exp/auth.emailauthprovider.providerid.md b/docs-exp/auth.emailauthprovider.providerid.md new file mode 100644 index 00000000000..78f44363bf5 --- /dev/null +++ b/docs-exp/auth.emailauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthProvider](./auth.emailauthprovider.md) > [providerId](./auth.emailauthprovider.providerid.md) + +## EmailAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.PASSWORD; +``` diff --git a/docs-exp/auth.facebookauthprovider.credential.md b/docs-exp/auth.facebookauthprovider.credential.md new file mode 100644 index 00000000000..afbb7920b65 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.credential.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [credential](./auth.facebookauthprovider.credential.md) + +## FacebookAuthProvider.credential() method + +Signature: + +```typescript +static credential(accessToken: string): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| accessToken | string | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.facebookauthprovider.credentialfromerror.md b/docs-exp/auth.facebookauthprovider.credentialfromerror.md new file mode 100644 index 00000000000..a0db89a729a --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.credentialfromerror.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [credentialFromError](./auth.facebookauthprovider.credentialfromerror.md) + +## FacebookAuthProvider.credentialFromError() method + +Signature: + +```typescript +static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| error | FirebaseError | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.facebookauthprovider.credentialfromresult.md b/docs-exp/auth.facebookauthprovider.credentialfromresult.md new file mode 100644 index 00000000000..30b05a61011 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.credentialfromresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [credentialFromResult](./auth.facebookauthprovider.credentialfromresult.md) + +## FacebookAuthProvider.credentialFromResult() method + +Signature: + +```typescript +static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md b/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md new file mode 100644 index 00000000000..80627f8c3f6 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [FACEBOOK\_SIGN\_IN\_METHOD](./auth.facebookauthprovider.facebook_sign_in_method.md) + +## FacebookAuthProvider.FACEBOOK\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; +``` diff --git a/docs-exp/auth.facebookauthprovider.md b/docs-exp/auth.facebookauthprovider.md new file mode 100644 index 00000000000..79b717981d7 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) + +## FacebookAuthProvider class + +Signature: + +```typescript +export declare class FacebookAuthProvider extends OAuthProvider +``` +Extends: [OAuthProvider](./auth.oauthprovider.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [FACEBOOK\_SIGN\_IN\_METHOD](./auth.facebookauthprovider.facebook_sign_in_method.md) | static | (not declared) | | +| [PROVIDER\_ID](./auth.facebookauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.facebookauthprovider.providerid.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(accessToken)](./auth.facebookauthprovider.credential.md) | static | | +| [credentialFromError(error)](./auth.facebookauthprovider.credentialfromerror.md) | static | | +| [credentialFromResult(userCredential)](./auth.facebookauthprovider.credentialfromresult.md) | static | | + diff --git a/docs-exp/auth.facebookauthprovider.provider_id.md b/docs-exp/auth.facebookauthprovider.provider_id.md new file mode 100644 index 00000000000..22f95748f94 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [PROVIDER\_ID](./auth.facebookauthprovider.provider_id.md) + +## FacebookAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; +``` diff --git a/docs-exp/auth.facebookauthprovider.providerid.md b/docs-exp/auth.facebookauthprovider.providerid.md new file mode 100644 index 00000000000..7af0f4f7b13 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [providerId](./auth.facebookauthprovider.providerid.md) + +## FacebookAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.FACEBOOK; +``` diff --git a/docs-exp/auth.fetchsigninmethodsforemail.md b/docs-exp/auth.fetchsigninmethodsforemail.md new file mode 100644 index 00000000000..4dc3362b6b1 --- /dev/null +++ b/docs-exp/auth.fetchsigninmethodsforemail.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [fetchSignInMethodsForEmail](./auth.fetchsigninmethodsforemail.md) + +## fetchSignInMethodsForEmail() function + +Signature: + +```typescript +export declare function fetchSignInMethodsForEmail(auth: externs.Auth, email: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | + +Returns: + +Promise<string\[\]> + diff --git a/docs-exp/auth.getadditionaluserinfo.md b/docs-exp/auth.getadditionaluserinfo.md new file mode 100644 index 00000000000..126ec9e41ed --- /dev/null +++ b/docs-exp/auth.getadditionaluserinfo.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getAdditionalUserInfo](./auth.getadditionaluserinfo.md) + +## getAdditionalUserInfo() function + +Signature: + +```typescript +export declare function getAdditionalUserInfo(userCredential: externs.UserCredential): externs.AdditionalUserInfo | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[AdditionalUserInfo](./auth-types.additionaluserinfo.md) \| null + diff --git a/docs-exp/auth.getauth.md b/docs-exp/auth.getauth.md new file mode 100644 index 00000000000..0dab35d0fff --- /dev/null +++ b/docs-exp/auth.getauth.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getAuth](./auth.getauth.md) + +## getAuth() function + +Signature: + +```typescript +export declare function getAuth(app?: FirebaseApp): Auth; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| app | [FirebaseApp](./app-types.firebaseapp.md) | | + +Returns: + +[Auth](./auth-types.auth.md) + diff --git a/docs-exp/auth.getidtoken.md b/docs-exp/auth.getidtoken.md new file mode 100644 index 00000000000..3824d79ed81 --- /dev/null +++ b/docs-exp/auth.getidtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getIdToken](./auth.getidtoken.md) + +## getIdToken() function + +Signature: + +```typescript +export declare function getIdToken(user: externs.User, forceRefresh?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| user | externs.[User](./auth-types.user.md) | | +| forceRefresh | boolean | | + +Returns: + +Promise<string> + diff --git a/docs-exp/auth.getidtokenresult.md b/docs-exp/auth.getidtokenresult.md new file mode 100644 index 00000000000..ff8e33424ee --- /dev/null +++ b/docs-exp/auth.getidtokenresult.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getIdTokenResult](./auth.getidtokenresult.md) + +## getIdTokenResult() function + +Signature: + +```typescript +export declare function getIdTokenResult(externUser: externs.User, forceRefresh?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| externUser | externs.[User](./auth-types.user.md) | | +| forceRefresh | boolean | | + +Returns: + +Promise<externs.[IdTokenResult](./auth-types.idtokenresult.md)> + diff --git a/docs-exp/auth.getmultifactorresolver.md b/docs-exp/auth.getmultifactorresolver.md new file mode 100644 index 00000000000..eace552c52b --- /dev/null +++ b/docs-exp/auth.getmultifactorresolver.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getMultiFactorResolver](./auth.getmultifactorresolver.md) + +## getMultiFactorResolver() function + +Signature: + +```typescript +export declare function getMultiFactorResolver(auth: externs.Auth, errorExtern: externs.MultiFactorError): externs.MultiFactorResolver; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| errorExtern | externs.[MultiFactorError](./auth-types.multifactorerror.md) | | + +Returns: + +externs.[MultiFactorResolver](./auth-types.multifactorresolver.md) + diff --git a/docs-exp/auth.getredirectresult.md b/docs-exp/auth.getredirectresult.md new file mode 100644 index 00000000000..823dce7f808 --- /dev/null +++ b/docs-exp/auth.getredirectresult.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [getRedirectResult](./auth.getredirectresult.md) + +## getRedirectResult() function + +Signature: + +```typescript +export declare function getRedirectResult(authExtern: externs.Auth, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| authExtern | externs.[Auth](./auth-types.auth.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md) \| null> + diff --git a/docs-exp/auth.githubauthprovider.credential.md b/docs-exp/auth.githubauthprovider.credential.md new file mode 100644 index 00000000000..19ea0dd2857 --- /dev/null +++ b/docs-exp/auth.githubauthprovider.credential.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [credential](./auth.githubauthprovider.credential.md) + +## GithubAuthProvider.credential() method + +Signature: + +```typescript +static credential(accessToken: string): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| accessToken | string | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.githubauthprovider.credentialfromerror.md b/docs-exp/auth.githubauthprovider.credentialfromerror.md new file mode 100644 index 00000000000..1735880b10d --- /dev/null +++ b/docs-exp/auth.githubauthprovider.credentialfromerror.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [credentialFromError](./auth.githubauthprovider.credentialfromerror.md) + +## GithubAuthProvider.credentialFromError() method + +Signature: + +```typescript +static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| error | FirebaseError | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.githubauthprovider.credentialfromresult.md b/docs-exp/auth.githubauthprovider.credentialfromresult.md new file mode 100644 index 00000000000..0705a1dd58a --- /dev/null +++ b/docs-exp/auth.githubauthprovider.credentialfromresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [credentialFromResult](./auth.githubauthprovider.credentialfromresult.md) + +## GithubAuthProvider.credentialFromResult() method + +Signature: + +```typescript +static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.githubauthprovider.github_sign_in_method.md b/docs-exp/auth.githubauthprovider.github_sign_in_method.md new file mode 100644 index 00000000000..0ceb5771f6f --- /dev/null +++ b/docs-exp/auth.githubauthprovider.github_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [GITHUB\_SIGN\_IN\_METHOD](./auth.githubauthprovider.github_sign_in_method.md) + +## GithubAuthProvider.GITHUB\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; +``` diff --git a/docs-exp/auth.githubauthprovider.md b/docs-exp/auth.githubauthprovider.md new file mode 100644 index 00000000000..137d327bfef --- /dev/null +++ b/docs-exp/auth.githubauthprovider.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) + +## GithubAuthProvider class + +Signature: + +```typescript +export declare class GithubAuthProvider extends OAuthProvider +``` +Extends: [OAuthProvider](./auth.oauthprovider.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [GITHUB\_SIGN\_IN\_METHOD](./auth.githubauthprovider.github_sign_in_method.md) | static | (not declared) | | +| [PROVIDER\_ID](./auth.githubauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.githubauthprovider.providerid.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(accessToken)](./auth.githubauthprovider.credential.md) | static | | +| [credentialFromError(error)](./auth.githubauthprovider.credentialfromerror.md) | static | | +| [credentialFromResult(userCredential)](./auth.githubauthprovider.credentialfromresult.md) | static | | + diff --git a/docs-exp/auth.githubauthprovider.provider_id.md b/docs-exp/auth.githubauthprovider.provider_id.md new file mode 100644 index 00000000000..702ae3425ac --- /dev/null +++ b/docs-exp/auth.githubauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [PROVIDER\_ID](./auth.githubauthprovider.provider_id.md) + +## GithubAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.GITHUB; +``` diff --git a/docs-exp/auth.githubauthprovider.providerid.md b/docs-exp/auth.githubauthprovider.providerid.md new file mode 100644 index 00000000000..7aaaf5165a5 --- /dev/null +++ b/docs-exp/auth.githubauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [providerId](./auth.githubauthprovider.providerid.md) + +## GithubAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.GITHUB; +``` diff --git a/docs-exp/auth.googleauthprovider.credential.md b/docs-exp/auth.googleauthprovider.credential.md new file mode 100644 index 00000000000..5d115aa03df --- /dev/null +++ b/docs-exp/auth.googleauthprovider.credential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [credential](./auth.googleauthprovider.credential.md) + +## GoogleAuthProvider.credential() method + +Signature: + +```typescript +static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| idToken | string \| null | | +| accessToken | string \| null | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.googleauthprovider.credentialfromerror.md b/docs-exp/auth.googleauthprovider.credentialfromerror.md new file mode 100644 index 00000000000..e793b3ba237 --- /dev/null +++ b/docs-exp/auth.googleauthprovider.credentialfromerror.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [credentialFromError](./auth.googleauthprovider.credentialfromerror.md) + +## GoogleAuthProvider.credentialFromError() method + +Signature: + +```typescript +static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| error | FirebaseError | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.googleauthprovider.credentialfromresult.md b/docs-exp/auth.googleauthprovider.credentialfromresult.md new file mode 100644 index 00000000000..50e009cf5a6 --- /dev/null +++ b/docs-exp/auth.googleauthprovider.credentialfromresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [credentialFromResult](./auth.googleauthprovider.credentialfromresult.md) + +## GoogleAuthProvider.credentialFromResult() method + +Signature: + +```typescript +static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.googleauthprovider.google_sign_in_method.md b/docs-exp/auth.googleauthprovider.google_sign_in_method.md new file mode 100644 index 00000000000..1a9fc3251a4 --- /dev/null +++ b/docs-exp/auth.googleauthprovider.google_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [GOOGLE\_SIGN\_IN\_METHOD](./auth.googleauthprovider.google_sign_in_method.md) + +## GoogleAuthProvider.GOOGLE\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; +``` diff --git a/docs-exp/auth.googleauthprovider.md b/docs-exp/auth.googleauthprovider.md new file mode 100644 index 00000000000..008400579d8 --- /dev/null +++ b/docs-exp/auth.googleauthprovider.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) + +## GoogleAuthProvider class + +Signature: + +```typescript +export declare class GoogleAuthProvider extends OAuthProvider +``` +Extends: [OAuthProvider](./auth.oauthprovider.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [GOOGLE\_SIGN\_IN\_METHOD](./auth.googleauthprovider.google_sign_in_method.md) | static | (not declared) | | +| [PROVIDER\_ID](./auth.googleauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.googleauthprovider.providerid.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(idToken, accessToken)](./auth.googleauthprovider.credential.md) | static | | +| [credentialFromError(error)](./auth.googleauthprovider.credentialfromerror.md) | static | | +| [credentialFromResult(userCredential)](./auth.googleauthprovider.credentialfromresult.md) | static | | + diff --git a/docs-exp/auth.googleauthprovider.provider_id.md b/docs-exp/auth.googleauthprovider.provider_id.md new file mode 100644 index 00000000000..912a8dab3da --- /dev/null +++ b/docs-exp/auth.googleauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [PROVIDER\_ID](./auth.googleauthprovider.provider_id.md) + +## GoogleAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; +``` diff --git a/docs-exp/auth.googleauthprovider.providerid.md b/docs-exp/auth.googleauthprovider.providerid.md new file mode 100644 index 00000000000..6b80693aecc --- /dev/null +++ b/docs-exp/auth.googleauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [providerId](./auth.googleauthprovider.providerid.md) + +## GoogleAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.GOOGLE; +``` diff --git a/docs-exp/auth.indexeddblocalpersistence.md b/docs-exp/auth.indexeddblocalpersistence.md new file mode 100644 index 00000000000..9373896af2f --- /dev/null +++ b/docs-exp/auth.indexeddblocalpersistence.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [indexedDBLocalPersistence](./auth.indexeddblocalpersistence.md) + +## indexedDBLocalPersistence variable + +Signature: + +```typescript +indexedDBLocalPersistence: externs.Persistence +``` diff --git a/docs-exp/auth.initializeauth.md b/docs-exp/auth.initializeauth.md new file mode 100644 index 00000000000..eb5e84a4f4b --- /dev/null +++ b/docs-exp/auth.initializeauth.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [initializeAuth](./auth.initializeauth.md) + +## initializeAuth() function + +Signature: + +```typescript +export declare function initializeAuth(app?: FirebaseApp, deps?: Dependencies): externs.Auth; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| app | [FirebaseApp](./app-types.firebaseapp.md) | | +| deps | Dependencies | | + +Returns: + +externs.[Auth](./auth-types.auth.md) + diff --git a/docs-exp/auth.inmemorypersistence.md b/docs-exp/auth.inmemorypersistence.md new file mode 100644 index 00000000000..6f139c69668 --- /dev/null +++ b/docs-exp/auth.inmemorypersistence.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [inMemoryPersistence](./auth.inmemorypersistence.md) + +## inMemoryPersistence variable + +Signature: + +```typescript +inMemoryPersistence: externs.Persistence +``` diff --git a/docs-exp/auth.issigninwithemaillink.md b/docs-exp/auth.issigninwithemaillink.md new file mode 100644 index 00000000000..5bd6fc0e6d6 --- /dev/null +++ b/docs-exp/auth.issigninwithemaillink.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [isSignInWithEmailLink](./auth.issigninwithemaillink.md) + +## isSignInWithEmailLink() function + +Signature: + +```typescript +export declare function isSignInWithEmailLink(auth: externs.Auth, emailLink: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| emailLink | string | | + +Returns: + +boolean + diff --git a/docs-exp/auth.linkwithcredential.md b/docs-exp/auth.linkwithcredential.md new file mode 100644 index 00000000000..0a55932ece5 --- /dev/null +++ b/docs-exp/auth.linkwithcredential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [linkWithCredential](./auth.linkwithcredential.md) + +## linkWithCredential() function + +Signature: + +```typescript +export declare function linkWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| credentialExtern | externs.[AuthCredential](./auth-types.authcredential.md) | | + +Returns: + +Promise<[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.linkwithphonenumber.md b/docs-exp/auth.linkwithphonenumber.md new file mode 100644 index 00000000000..d2b406e922a --- /dev/null +++ b/docs-exp/auth.linkwithphonenumber.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [linkWithPhoneNumber](./auth.linkwithphonenumber.md) + +## linkWithPhoneNumber() function + +Signature: + +```typescript +export declare function linkWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| phoneNumber | string | | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | + +Returns: + +Promise<externs.[ConfirmationResult](./auth-types.confirmationresult.md)> + diff --git a/docs-exp/auth.linkwithpopup.md b/docs-exp/auth.linkwithpopup.md new file mode 100644 index 00000000000..1e516baeda6 --- /dev/null +++ b/docs-exp/auth.linkwithpopup.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [linkWithPopup](./auth.linkwithpopup.md) + +## linkWithPopup() function + +Signature: + +```typescript +export declare function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.linkwithredirect.md b/docs-exp/auth.linkwithredirect.md new file mode 100644 index 00000000000..d456b2a92cf --- /dev/null +++ b/docs-exp/auth.linkwithredirect.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [linkWithRedirect](./auth.linkwithredirect.md) + +## linkWithRedirect() function + +Signature: + +```typescript +export declare function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<never> + diff --git a/docs-exp/auth.md b/docs-exp/auth.md new file mode 100644 index 00000000000..23b8d8451b5 --- /dev/null +++ b/docs-exp/auth.md @@ -0,0 +1,89 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) + +## auth package + +## Classes + +| Class | Description | +| --- | --- | +| [ActionCodeURL](./auth.actioncodeurl.md) | | +| [AuthCredential](./auth.authcredential.md) | | +| [EmailAuthCredential](./auth.emailauthcredential.md) | | +| [EmailAuthProvider](./auth.emailauthprovider.md) | | +| [FacebookAuthProvider](./auth.facebookauthprovider.md) | | +| [GithubAuthProvider](./auth.githubauthprovider.md) | | +| [GoogleAuthProvider](./auth.googleauthprovider.md) | | +| [OAuthCredential](./auth.oauthcredential.md) | | +| [OAuthProvider](./auth.oauthprovider.md) | | +| [PhoneAuthCredential](./auth.phoneauthcredential.md) | | +| [PhoneAuthProvider](./auth.phoneauthprovider.md) | | +| [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md) | | +| [RecaptchaVerifier](./auth.recaptchaverifier.md) | | +| [TwitterAuthProvider](./auth.twitterauthprovider.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [applyActionCode(auth, oobCode)](./auth.applyactioncode.md) | | +| [checkActionCode(auth, oobCode)](./auth.checkactioncode.md) | | +| [confirmPasswordReset(auth, oobCode, newPassword)](./auth.confirmpasswordreset.md) | | +| [createUserWithEmailAndPassword(auth, email, password)](./auth.createuserwithemailandpassword.md) | | +| [deleteUser(user)](./auth.deleteuser.md) | | +| [fetchSignInMethodsForEmail(auth, email)](./auth.fetchsigninmethodsforemail.md) | | +| [getAdditionalUserInfo(userCredential)](./auth.getadditionaluserinfo.md) | | +| [getAuth(app)](./auth.getauth.md) | | +| [getIdToken(user, forceRefresh)](./auth.getidtoken.md) | | +| [getIdTokenResult(externUser, forceRefresh)](./auth.getidtokenresult.md) | | +| [getMultiFactorResolver(auth, errorExtern)](./auth.getmultifactorresolver.md) | | +| [getRedirectResult(authExtern, resolverExtern)](./auth.getredirectresult.md) | | +| [initializeAuth(app, deps)](./auth.initializeauth.md) | | +| [isSignInWithEmailLink(auth, emailLink)](./auth.issigninwithemaillink.md) | | +| [linkWithCredential(userExtern, credentialExtern)](./auth.linkwithcredential.md) | | +| [linkWithPhoneNumber(userExtern, phoneNumber, appVerifier)](./auth.linkwithphonenumber.md) | | +| [linkWithPopup(userExtern, provider, resolverExtern)](./auth.linkwithpopup.md) | | +| [linkWithRedirect(userExtern, provider, resolverExtern)](./auth.linkwithredirect.md) | | +| [multiFactor(user)](./auth.multifactor.md) | | +| [onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.onauthstatechanged.md) | | +| [onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.onidtokenchanged.md) | | +| [parseActionCodeURL(link)](./auth.parseactioncodeurl.md) | | +| [reauthenticateWithCredential(userExtern, credentialExtern)](./auth.reauthenticatewithcredential.md) | | +| [reauthenticateWithPhoneNumber(userExtern, phoneNumber, appVerifier)](./auth.reauthenticatewithphonenumber.md) | | +| [reauthenticateWithPopup(userExtern, provider, resolverExtern)](./auth.reauthenticatewithpopup.md) | | +| [reauthenticateWithRedirect(userExtern, provider, resolverExtern)](./auth.reauthenticatewithredirect.md) | | +| [reload(externUser)](./auth.reload.md) | | +| [sendEmailVerification(userExtern, actionCodeSettings)](./auth.sendemailverification.md) | | +| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.sendpasswordresetemail.md) | | +| [sendSignInLinkToEmail(auth, email, actionCodeSettings)](./auth.sendsigninlinktoemail.md) | | +| [setPersistence(auth, persistence)](./auth.setpersistence.md) | | +| [signInAnonymously(auth)](./auth.signinanonymously.md) | | +| [signInWithCredential(auth, credential)](./auth.signinwithcredential.md) | | +| [signInWithCustomToken(authExtern, customToken)](./auth.signinwithcustomtoken.md) | | +| [signInWithEmailAndPassword(auth, email, password)](./auth.signinwithemailandpassword.md) | | +| [signInWithEmailLink(auth, email, emailLink)](./auth.signinwithemaillink.md) | | +| [signInWithPhoneNumber(auth, phoneNumber, appVerifier)](./auth.signinwithphonenumber.md) | | +| [signInWithPopup(auth, provider, resolverExtern)](./auth.signinwithpopup.md) | | +| [signInWithRedirect(auth, provider, resolverExtern)](./auth.signinwithredirect.md) | | +| [signOut(auth)](./auth.signout.md) | | +| [unlink(userExtern, providerId)](./auth.unlink.md) | This is the externally visible unlink function | +| [updateCurrentUser(auth, user)](./auth.updatecurrentuser.md) | | +| [updateEmail(externUser, newEmail)](./auth.updateemail.md) | | +| [updatePassword(externUser, newPassword)](./auth.updatepassword.md) | | +| [updatePhoneNumber(user, credential)](./auth.updatephonenumber.md) | | +| [updateProfile(externUser, { displayName, photoURL: photoUrl })](./auth.updateprofile.md) | | +| [useDeviceLanguage(auth)](./auth.usedevicelanguage.md) | | +| [verifyBeforeUpdateEmail(userExtern, newEmail, actionCodeSettings)](./auth.verifybeforeupdateemail.md) | | +| [verifyPasswordResetCode(auth, code)](./auth.verifypasswordresetcode.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [browserLocalPersistence](./auth.browserlocalpersistence.md) | | +| [browserPopupRedirectResolver](./auth.browserpopupredirectresolver.md) | | +| [browserSessionPersistence](./auth.browsersessionpersistence.md) | | +| [indexedDBLocalPersistence](./auth.indexeddblocalpersistence.md) | | +| [inMemoryPersistence](./auth.inmemorypersistence.md) | | + diff --git a/docs-exp/auth.multifactor.md b/docs-exp/auth.multifactor.md new file mode 100644 index 00000000000..1e46c923e73 --- /dev/null +++ b/docs-exp/auth.multifactor.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [multiFactor](./auth.multifactor.md) + +## multiFactor() function + +Signature: + +```typescript +export declare function multiFactor(user: externs.User): externs.MultiFactorUser; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| user | externs.[User](./auth-types.user.md) | | + +Returns: + +externs.[MultiFactorUser](./auth-types.multifactoruser.md) + diff --git a/docs-exp/auth.oauthcredential._fromparams.md b/docs-exp/auth.oauthcredential._fromparams.md new file mode 100644 index 00000000000..bc958994759 --- /dev/null +++ b/docs-exp/auth.oauthcredential._fromparams.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_fromParams](./auth.oauthcredential._fromparams.md) + +## OAuthCredential.\_fromParams() method + +Signature: + +```typescript +static _fromParams(params: OAuthCredentialParams): OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | OAuthCredentialParams | | + +Returns: + +[OAuthCredential](./auth.oauthcredential.md) + diff --git a/docs-exp/auth.oauthcredential._getidtokenresponse.md b/docs-exp/auth.oauthcredential._getidtokenresponse.md new file mode 100644 index 00000000000..97fc7971692 --- /dev/null +++ b/docs-exp/auth.oauthcredential._getidtokenresponse.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_getIdTokenResponse](./auth.oauthcredential._getidtokenresponse.md) + +## OAuthCredential.\_getIdTokenResponse() method + +Signature: + +```typescript +_getIdTokenResponse(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.oauthcredential._getreauthenticationresolver.md b/docs-exp/auth.oauthcredential._getreauthenticationresolver.md new file mode 100644 index 00000000000..d998f3049f5 --- /dev/null +++ b/docs-exp/auth.oauthcredential._getreauthenticationresolver.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_getReauthenticationResolver](./auth.oauthcredential._getreauthenticationresolver.md) + +## OAuthCredential.\_getReauthenticationResolver() method + +Signature: + +```typescript +_getReauthenticationResolver(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.oauthcredential._linktoidtoken.md b/docs-exp/auth.oauthcredential._linktoidtoken.md new file mode 100644 index 00000000000..fb8e94ccf8f --- /dev/null +++ b/docs-exp/auth.oauthcredential._linktoidtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_linkToIdToken](./auth.oauthcredential._linktoidtoken.md) + +## OAuthCredential.\_linkToIdToken() method + +Signature: + +```typescript +_linkToIdToken(auth: AuthCore, idToken: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | +| idToken | string | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.oauthcredential.accesstoken.md b/docs-exp/auth.oauthcredential.accesstoken.md new file mode 100644 index 00000000000..2c7a53a9da3 --- /dev/null +++ b/docs-exp/auth.oauthcredential.accesstoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [accessToken](./auth.oauthcredential.accesstoken.md) + +## OAuthCredential.accessToken property + +Signature: + +```typescript +accessToken?: string; +``` diff --git a/docs-exp/auth.oauthcredential.fromjson.md b/docs-exp/auth.oauthcredential.fromjson.md new file mode 100644 index 00000000000..5fe608786a4 --- /dev/null +++ b/docs-exp/auth.oauthcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [fromJSON](./auth.oauthcredential.fromjson.md) + +## OAuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: string | object): OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | string \| object | | + +Returns: + +[OAuthCredential](./auth.oauthcredential.md) \| null + diff --git a/docs-exp/auth.oauthcredential.idtoken.md b/docs-exp/auth.oauthcredential.idtoken.md new file mode 100644 index 00000000000..416e44ede0c --- /dev/null +++ b/docs-exp/auth.oauthcredential.idtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [idToken](./auth.oauthcredential.idtoken.md) + +## OAuthCredential.idToken property + +Signature: + +```typescript +idToken?: string; +``` diff --git a/docs-exp/auth.oauthcredential.md b/docs-exp/auth.oauthcredential.md new file mode 100644 index 00000000000..8463d002dd3 --- /dev/null +++ b/docs-exp/auth.oauthcredential.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) + +## OAuthCredential class + +Signature: + +```typescript +export declare class OAuthCredential extends AuthCredential implements externs.OAuthCredential +``` +Extends: [AuthCredential](./auth.authcredential.md) + +Implements: externs.[OAuthCredential](./auth-types.oauthcredential.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [accessToken](./auth.oauthcredential.accesstoken.md) | | string | | +| [idToken](./auth.oauthcredential.idtoken.md) | | string | | +| [nonce](./auth.oauthcredential.nonce.md) | | string | | +| [secret](./auth.oauthcredential.secret.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_fromParams(params)](./auth.oauthcredential._fromparams.md) | static | | +| [\_getIdTokenResponse(auth)](./auth.oauthcredential._getidtokenresponse.md) | | | +| [\_getReauthenticationResolver(auth)](./auth.oauthcredential._getreauthenticationresolver.md) | | | +| [\_linkToIdToken(auth, idToken)](./auth.oauthcredential._linktoidtoken.md) | | | +| [fromJSON(json)](./auth.oauthcredential.fromjson.md) | static | | +| [toJSON()](./auth.oauthcredential.tojson.md) | | | + diff --git a/docs-exp/auth.oauthcredential.nonce.md b/docs-exp/auth.oauthcredential.nonce.md new file mode 100644 index 00000000000..a3486055025 --- /dev/null +++ b/docs-exp/auth.oauthcredential.nonce.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [nonce](./auth.oauthcredential.nonce.md) + +## OAuthCredential.nonce property + +Signature: + +```typescript +nonce?: string; +``` diff --git a/docs-exp/auth.oauthcredential.secret.md b/docs-exp/auth.oauthcredential.secret.md new file mode 100644 index 00000000000..a5fd3ab596d --- /dev/null +++ b/docs-exp/auth.oauthcredential.secret.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [secret](./auth.oauthcredential.secret.md) + +## OAuthCredential.secret property + +Signature: + +```typescript +secret?: string; +``` diff --git a/docs-exp/auth.oauthcredential.tojson.md b/docs-exp/auth.oauthcredential.tojson.md new file mode 100644 index 00000000000..efa72b2674d --- /dev/null +++ b/docs-exp/auth.oauthcredential.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [toJSON](./auth.oauthcredential.tojson.md) + +## OAuthCredential.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth.oauthprovider._constructor_.md b/docs-exp/auth.oauthprovider._constructor_.md new file mode 100644 index 00000000000..ff89f537fc4 --- /dev/null +++ b/docs-exp/auth.oauthprovider._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [(constructor)](./auth.oauthprovider._constructor_.md) + +## OAuthProvider.(constructor) + +Constructs a new instance of the `OAuthProvider` class + +Signature: + +```typescript +constructor(providerId: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| providerId | string | | + diff --git a/docs-exp/auth.oauthprovider.addscope.md b/docs-exp/auth.oauthprovider.addscope.md new file mode 100644 index 00000000000..8ed187e64e1 --- /dev/null +++ b/docs-exp/auth.oauthprovider.addscope.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [addScope](./auth.oauthprovider.addscope.md) + +## OAuthProvider.addScope() method + +Signature: + +```typescript +addScope(scope: string): externs.AuthProvider; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| scope | string | | + +Returns: + +externs.[AuthProvider](./auth-types.authprovider.md) + diff --git a/docs-exp/auth.oauthprovider.credential.md b/docs-exp/auth.oauthprovider.credential.md new file mode 100644 index 00000000000..a57400bc70d --- /dev/null +++ b/docs-exp/auth.oauthprovider.credential.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [credential](./auth.oauthprovider.credential.md) + +## OAuthProvider.credential() method + +Signature: + +```typescript +credential(params: CredentialParameters): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | CredentialParameters | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.oauthprovider.credentialfromjson.md b/docs-exp/auth.oauthprovider.credentialfromjson.md new file mode 100644 index 00000000000..e9e202558c2 --- /dev/null +++ b/docs-exp/auth.oauthprovider.credentialfromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [credentialFromJSON](./auth.oauthprovider.credentialfromjson.md) + +## OAuthProvider.credentialFromJSON() method + +Signature: + +```typescript +static credentialFromJSON(json: object | string): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.oauthprovider.defaultlanguagecode.md b/docs-exp/auth.oauthprovider.defaultlanguagecode.md new file mode 100644 index 00000000000..139635a85b4 --- /dev/null +++ b/docs-exp/auth.oauthprovider.defaultlanguagecode.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [defaultLanguageCode](./auth.oauthprovider.defaultlanguagecode.md) + +## OAuthProvider.defaultLanguageCode property + +Signature: + +```typescript +defaultLanguageCode: string | null; +``` diff --git a/docs-exp/auth.oauthprovider.getcustomparameters.md b/docs-exp/auth.oauthprovider.getcustomparameters.md new file mode 100644 index 00000000000..541d5d21cec --- /dev/null +++ b/docs-exp/auth.oauthprovider.getcustomparameters.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [getCustomParameters](./auth.oauthprovider.getcustomparameters.md) + +## OAuthProvider.getCustomParameters() method + +Signature: + +```typescript +getCustomParameters(): CustomParameters; +``` +Returns: + +CustomParameters + diff --git a/docs-exp/auth.oauthprovider.getscopes.md b/docs-exp/auth.oauthprovider.getscopes.md new file mode 100644 index 00000000000..f98f4644306 --- /dev/null +++ b/docs-exp/auth.oauthprovider.getscopes.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [getScopes](./auth.oauthprovider.getscopes.md) + +## OAuthProvider.getScopes() method + +Signature: + +```typescript +getScopes(): string[]; +``` +Returns: + +string\[\] + diff --git a/docs-exp/auth.oauthprovider.md b/docs-exp/auth.oauthprovider.md new file mode 100644 index 00000000000..8976004def3 --- /dev/null +++ b/docs-exp/auth.oauthprovider.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) + +## OAuthProvider class + +Signature: + +```typescript +export declare class OAuthProvider implements externs.AuthProvider +``` +Implements: externs.[AuthProvider](./auth-types.authprovider.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(providerId)](./auth.oauthprovider._constructor_.md) | | Constructs a new instance of the OAuthProvider class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [defaultLanguageCode](./auth.oauthprovider.defaultlanguagecode.md) | | string \| null | | +| [providerId](./auth.oauthprovider.providerid.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addScope(scope)](./auth.oauthprovider.addscope.md) | | | +| [credential(params)](./auth.oauthprovider.credential.md) | | | +| [credentialFromJSON(json)](./auth.oauthprovider.credentialfromjson.md) | static | | +| [getCustomParameters()](./auth.oauthprovider.getcustomparameters.md) | | | +| [getScopes()](./auth.oauthprovider.getscopes.md) | | | +| [setCustomParameters(customOAuthParameters)](./auth.oauthprovider.setcustomparameters.md) | | | +| [setDefaultLanguage(languageCode)](./auth.oauthprovider.setdefaultlanguage.md) | | | + diff --git a/docs-exp/auth.oauthprovider.providerid.md b/docs-exp/auth.oauthprovider.providerid.md new file mode 100644 index 00000000000..6ae20dc611f --- /dev/null +++ b/docs-exp/auth.oauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [providerId](./auth.oauthprovider.providerid.md) + +## OAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId: string; +``` diff --git a/docs-exp/auth.oauthprovider.setcustomparameters.md b/docs-exp/auth.oauthprovider.setcustomparameters.md new file mode 100644 index 00000000000..f79b8e251db --- /dev/null +++ b/docs-exp/auth.oauthprovider.setcustomparameters.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [setCustomParameters](./auth.oauthprovider.setcustomparameters.md) + +## OAuthProvider.setCustomParameters() method + +Signature: + +```typescript +setCustomParameters(customOAuthParameters: CustomParameters): externs.AuthProvider; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| customOAuthParameters | CustomParameters | | + +Returns: + +externs.[AuthProvider](./auth-types.authprovider.md) + diff --git a/docs-exp/auth.oauthprovider.setdefaultlanguage.md b/docs-exp/auth.oauthprovider.setdefaultlanguage.md new file mode 100644 index 00000000000..471c56f8d03 --- /dev/null +++ b/docs-exp/auth.oauthprovider.setdefaultlanguage.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [setDefaultLanguage](./auth.oauthprovider.setdefaultlanguage.md) + +## OAuthProvider.setDefaultLanguage() method + +Signature: + +```typescript +setDefaultLanguage(languageCode: string | null): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| languageCode | string \| null | | + +Returns: + +void + diff --git a/docs-exp/auth.onauthstatechanged.md b/docs-exp/auth.onauthstatechanged.md new file mode 100644 index 00000000000..2085ae6d37f --- /dev/null +++ b/docs-exp/auth.onauthstatechanged.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [onAuthStateChanged](./auth.onauthstatechanged.md) + +## onAuthStateChanged() function + +Signature: + +```typescript +export declare function onAuthStateChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | | +| error | ErrorFn | | +| completed | CompleteFn | | + +Returns: + +Unsubscribe + diff --git a/docs-exp/auth.onidtokenchanged.md b/docs-exp/auth.onidtokenchanged.md new file mode 100644 index 00000000000..fc9ba84e3d3 --- /dev/null +++ b/docs-exp/auth.onidtokenchanged.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [onIdTokenChanged](./auth.onidtokenchanged.md) + +## onIdTokenChanged() function + +Signature: + +```typescript +export declare function onIdTokenChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | | +| error | ErrorFn | | +| completed | CompleteFn | | + +Returns: + +Unsubscribe + diff --git a/docs-exp/auth.parseactioncodeurl.md b/docs-exp/auth.parseactioncodeurl.md new file mode 100644 index 00000000000..bb640fec8a7 --- /dev/null +++ b/docs-exp/auth.parseactioncodeurl.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [parseActionCodeURL](./auth.parseactioncodeurl.md) + +## parseActionCodeURL() function + +Signature: + +```typescript +export declare function parseActionCodeURL(link: string): externs.ActionCodeURL | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| link | string | | + +Returns: + +externs.[ActionCodeURL](./auth-types.actioncodeurl.md) \| null + diff --git a/docs-exp/auth.phoneauthcredential._fromtokenresponse.md b/docs-exp/auth.phoneauthcredential._fromtokenresponse.md new file mode 100644 index 00000000000..72f3797ebaa --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._fromtokenresponse.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_fromTokenResponse](./auth.phoneauthcredential._fromtokenresponse.md) + +## PhoneAuthCredential.\_fromTokenResponse() method + +Signature: + +```typescript +static _fromTokenResponse(phoneNumber: string, temporaryProof: string): PhoneAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| phoneNumber | string | | +| temporaryProof | string | | + +Returns: + +[PhoneAuthCredential](./auth.phoneauthcredential.md) + diff --git a/docs-exp/auth.phoneauthcredential._fromverification.md b/docs-exp/auth.phoneauthcredential._fromverification.md new file mode 100644 index 00000000000..e058d1b940a --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._fromverification.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_fromVerification](./auth.phoneauthcredential._fromverification.md) + +## PhoneAuthCredential.\_fromVerification() method + +Signature: + +```typescript +static _fromVerification(verificationId: string, verificationCode: string): PhoneAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| verificationId | string | | +| verificationCode | string | | + +Returns: + +[PhoneAuthCredential](./auth.phoneauthcredential.md) + diff --git a/docs-exp/auth.phoneauthcredential._getidtokenresponse.md b/docs-exp/auth.phoneauthcredential._getidtokenresponse.md new file mode 100644 index 00000000000..5bfaba228b6 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._getidtokenresponse.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_getIdTokenResponse](./auth.phoneauthcredential._getidtokenresponse.md) + +## PhoneAuthCredential.\_getIdTokenResponse() method + +Signature: + +```typescript +_getIdTokenResponse(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<PhoneOrOauthTokenResponse> + diff --git a/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md b/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md new file mode 100644 index 00000000000..9461f379518 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_getReauthenticationResolver](./auth.phoneauthcredential._getreauthenticationresolver.md) + +## PhoneAuthCredential.\_getReauthenticationResolver() method + +Signature: + +```typescript +_getReauthenticationResolver(auth: AuthCore): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.phoneauthcredential._linktoidtoken.md b/docs-exp/auth.phoneauthcredential._linktoidtoken.md new file mode 100644 index 00000000000..e79f0c71282 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._linktoidtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_linkToIdToken](./auth.phoneauthcredential._linktoidtoken.md) + +## PhoneAuthCredential.\_linkToIdToken() method + +Signature: + +```typescript +_linkToIdToken(auth: AuthCore, idToken: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | +| idToken | string | | + +Returns: + +Promise<IdTokenResponse> + diff --git a/docs-exp/auth.phoneauthcredential._makeverificationrequest.md b/docs-exp/auth.phoneauthcredential._makeverificationrequest.md new file mode 100644 index 00000000000..44de591a975 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential._makeverificationrequest.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_makeVerificationRequest](./auth.phoneauthcredential._makeverificationrequest.md) + +## PhoneAuthCredential.\_makeVerificationRequest() method + +Signature: + +```typescript +_makeVerificationRequest(): SignInWithPhoneNumberRequest; +``` +Returns: + +SignInWithPhoneNumberRequest + diff --git a/docs-exp/auth.phoneauthcredential.fromjson.md b/docs-exp/auth.phoneauthcredential.fromjson.md new file mode 100644 index 00000000000..303befdae07 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential.fromjson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [fromJSON](./auth.phoneauthcredential.fromjson.md) + +## PhoneAuthCredential.fromJSON() method + +Signature: + +```typescript +static fromJSON(json: object | string): PhoneAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| json | object \| string | | + +Returns: + +[PhoneAuthCredential](./auth.phoneauthcredential.md) \| null + diff --git a/docs-exp/auth.phoneauthcredential.md b/docs-exp/auth.phoneauthcredential.md new file mode 100644 index 00000000000..4f090f61b3d --- /dev/null +++ b/docs-exp/auth.phoneauthcredential.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) + +## PhoneAuthCredential class + +Signature: + +```typescript +export declare class PhoneAuthCredential extends AuthCredential implements externs.PhoneAuthCredential +``` +Extends: [AuthCredential](./auth.authcredential.md) + +Implements: externs.[PhoneAuthCredential](./auth-types.phoneauthcredential.md) + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_fromTokenResponse(phoneNumber, temporaryProof)](./auth.phoneauthcredential._fromtokenresponse.md) | static | | +| [\_fromVerification(verificationId, verificationCode)](./auth.phoneauthcredential._fromverification.md) | static | | +| [\_getIdTokenResponse(auth)](./auth.phoneauthcredential._getidtokenresponse.md) | | | +| [\_getReauthenticationResolver(auth)](./auth.phoneauthcredential._getreauthenticationresolver.md) | | | +| [\_linkToIdToken(auth, idToken)](./auth.phoneauthcredential._linktoidtoken.md) | | | +| [\_makeVerificationRequest()](./auth.phoneauthcredential._makeverificationrequest.md) | | | +| [fromJSON(json)](./auth.phoneauthcredential.fromjson.md) | static | | +| [toJSON()](./auth.phoneauthcredential.tojson.md) | | | + diff --git a/docs-exp/auth.phoneauthcredential.tojson.md b/docs-exp/auth.phoneauthcredential.tojson.md new file mode 100644 index 00000000000..aeb65eaf380 --- /dev/null +++ b/docs-exp/auth.phoneauthcredential.tojson.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [toJSON](./auth.phoneauthcredential.tojson.md) + +## PhoneAuthCredential.toJSON() method + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + diff --git a/docs-exp/auth.phoneauthprovider._constructor_.md b/docs-exp/auth.phoneauthprovider._constructor_.md new file mode 100644 index 00000000000..116b2f1a9e9 --- /dev/null +++ b/docs-exp/auth.phoneauthprovider._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [(constructor)](./auth.phoneauthprovider._constructor_.md) + +## PhoneAuthProvider.(constructor) + +Constructs a new instance of the `PhoneAuthProvider` class + +Signature: + +```typescript +constructor(auth: AuthCore); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | AuthCore | | + diff --git a/docs-exp/auth.phoneauthprovider.credential.md b/docs-exp/auth.phoneauthprovider.credential.md new file mode 100644 index 00000000000..02d00cc9888 --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.credential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [credential](./auth.phoneauthprovider.credential.md) + +## PhoneAuthProvider.credential() method + +Signature: + +```typescript +static credential(verificationId: string, verificationCode: string): PhoneAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| verificationId | string | | +| verificationCode | string | | + +Returns: + +[PhoneAuthCredential](./auth.phoneauthcredential.md) + diff --git a/docs-exp/auth.phoneauthprovider.credentialfromresult.md b/docs-exp/auth.phoneauthprovider.credentialfromresult.md new file mode 100644 index 00000000000..84d50fd38ce --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.credentialfromresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [credentialFromResult](./auth.phoneauthprovider.credentialfromresult.md) + +## PhoneAuthProvider.credentialFromResult() method + +Signature: + +```typescript +static credentialFromResult(userCredential: externs.UserCredential): externs.AuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[AuthCredential](./auth-types.authcredential.md) \| null + diff --git a/docs-exp/auth.phoneauthprovider.md b/docs-exp/auth.phoneauthprovider.md new file mode 100644 index 00000000000..0aba88cd843 --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) + +## PhoneAuthProvider class + +Signature: + +```typescript +export declare class PhoneAuthProvider implements externs.PhoneAuthProvider +``` +Implements: externs.[PhoneAuthProvider](./auth-types.phoneauthprovider.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(auth)](./auth.phoneauthprovider._constructor_.md) | | Constructs a new instance of the PhoneAuthProvider class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [PHONE\_SIGN\_IN\_METHOD](./auth.phoneauthprovider.phone_sign_in_method.md) | static | (not declared) | | +| [PROVIDER\_ID](./auth.phoneauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.phoneauthprovider.providerid.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(verificationId, verificationCode)](./auth.phoneauthprovider.credential.md) | static | | +| [credentialFromResult(userCredential)](./auth.phoneauthprovider.credentialfromresult.md) | static | | +| [verifyPhoneNumber(phoneOptions, applicationVerifier)](./auth.phoneauthprovider.verifyphonenumber.md) | | | + diff --git a/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md b/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md new file mode 100644 index 00000000000..c6a47a86cef --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [PHONE\_SIGN\_IN\_METHOD](./auth.phoneauthprovider.phone_sign_in_method.md) + +## PhoneAuthProvider.PHONE\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly PHONE_SIGN_IN_METHOD = externs.SignInMethod.PHONE; +``` diff --git a/docs-exp/auth.phoneauthprovider.provider_id.md b/docs-exp/auth.phoneauthprovider.provider_id.md new file mode 100644 index 00000000000..4aa2cfb3f95 --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [PROVIDER\_ID](./auth.phoneauthprovider.provider_id.md) + +## PhoneAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.PHONE; +``` diff --git a/docs-exp/auth.phoneauthprovider.providerid.md b/docs-exp/auth.phoneauthprovider.providerid.md new file mode 100644 index 00000000000..e7fd5e2385e --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [providerId](./auth.phoneauthprovider.providerid.md) + +## PhoneAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.PHONE; +``` diff --git a/docs-exp/auth.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth.phoneauthprovider.verifyphonenumber.md new file mode 100644 index 00000000000..f0985746ac3 --- /dev/null +++ b/docs-exp/auth.phoneauthprovider.verifyphonenumber.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthProvider](./auth.phoneauthprovider.md) > [verifyPhoneNumber](./auth.phoneauthprovider.verifyphonenumber.md) + +## PhoneAuthProvider.verifyPhoneNumber() method + +Signature: + +```typescript +verifyPhoneNumber(phoneOptions: externs.PhoneInfoOptions | string, applicationVerifier: externs.ApplicationVerifier): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| phoneOptions | externs.[PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | | +| applicationVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | + +Returns: + +Promise<string> + diff --git a/docs-exp/auth.phonemultifactorgenerator.assertion.md b/docs-exp/auth.phonemultifactorgenerator.assertion.md new file mode 100644 index 00000000000..ec67f7dd535 --- /dev/null +++ b/docs-exp/auth.phonemultifactorgenerator.assertion.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md) > [assertion](./auth.phonemultifactorgenerator.assertion.md) + +## PhoneMultiFactorGenerator.assertion() method + +Signature: + +```typescript +static assertion(credential: externs.PhoneAuthCredential): externs.PhoneMultiFactorAssertion; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| credential | externs.[PhoneAuthCredential](./auth-types.phoneauthcredential.md) | | + +Returns: + +externs.[PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) + diff --git a/docs-exp/auth.phonemultifactorgenerator.md b/docs-exp/auth.phonemultifactorgenerator.md new file mode 100644 index 00000000000..3b554942994 --- /dev/null +++ b/docs-exp/auth.phonemultifactorgenerator.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md) + +## PhoneMultiFactorGenerator class + +Signature: + +```typescript +export declare class PhoneMultiFactorGenerator implements externs.PhoneMultiFactorGenerator +``` +Implements: externs.[PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [assertion(credential)](./auth.phonemultifactorgenerator.assertion.md) | static | | + diff --git a/docs-exp/auth.reauthenticatewithcredential.md b/docs-exp/auth.reauthenticatewithcredential.md new file mode 100644 index 00000000000..76550ed0700 --- /dev/null +++ b/docs-exp/auth.reauthenticatewithcredential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [reauthenticateWithCredential](./auth.reauthenticatewithcredential.md) + +## reauthenticateWithCredential() function + +Signature: + +```typescript +export declare function reauthenticateWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| credentialExtern | externs.[AuthCredential](./auth-types.authcredential.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.reauthenticatewithphonenumber.md b/docs-exp/auth.reauthenticatewithphonenumber.md new file mode 100644 index 00000000000..47c25c6ecba --- /dev/null +++ b/docs-exp/auth.reauthenticatewithphonenumber.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [reauthenticateWithPhoneNumber](./auth.reauthenticatewithphonenumber.md) + +## reauthenticateWithPhoneNumber() function + +Signature: + +```typescript +export declare function reauthenticateWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| phoneNumber | string | | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | + +Returns: + +Promise<externs.[ConfirmationResult](./auth-types.confirmationresult.md)> + diff --git a/docs-exp/auth.reauthenticatewithpopup.md b/docs-exp/auth.reauthenticatewithpopup.md new file mode 100644 index 00000000000..636e78292e0 --- /dev/null +++ b/docs-exp/auth.reauthenticatewithpopup.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [reauthenticateWithPopup](./auth.reauthenticatewithpopup.md) + +## reauthenticateWithPopup() function + +Signature: + +```typescript +export declare function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.reauthenticatewithredirect.md b/docs-exp/auth.reauthenticatewithredirect.md new file mode 100644 index 00000000000..96aa8ca0d48 --- /dev/null +++ b/docs-exp/auth.reauthenticatewithredirect.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [reauthenticateWithRedirect](./auth.reauthenticatewithredirect.md) + +## reauthenticateWithRedirect() function + +Signature: + +```typescript +export declare function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<never> + diff --git a/docs-exp/auth.recaptchaverifier._constructor_.md b/docs-exp/auth.recaptchaverifier._constructor_.md new file mode 100644 index 00000000000..9808828362a --- /dev/null +++ b/docs-exp/auth.recaptchaverifier._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [(constructor)](./auth.recaptchaverifier._constructor_.md) + +## RecaptchaVerifier.(constructor) + +Constructs a new instance of the `RecaptchaVerifier` class + +Signature: + +```typescript +constructor(containerOrId: HTMLElement | string, parameters: Parameters, auth: AuthCore); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| containerOrId | HTMLElement \| string | | +| parameters | Parameters | | +| auth | AuthCore | | + diff --git a/docs-exp/auth.recaptchaverifier._recaptchaloader.md b/docs-exp/auth.recaptchaverifier._recaptchaloader.md new file mode 100644 index 00000000000..d007fadcd77 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier._recaptchaloader.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [\_recaptchaLoader](./auth.recaptchaverifier._recaptchaloader.md) + +## RecaptchaVerifier.\_recaptchaLoader property + +Signature: + +```typescript +readonly _recaptchaLoader: ReCaptchaLoader; +``` diff --git a/docs-exp/auth.recaptchaverifier._reset.md b/docs-exp/auth.recaptchaverifier._reset.md new file mode 100644 index 00000000000..9eac4ac21fd --- /dev/null +++ b/docs-exp/auth.recaptchaverifier._reset.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [\_reset](./auth.recaptchaverifier._reset.md) + +## RecaptchaVerifier.\_reset() method + +Signature: + +```typescript +_reset(): void; +``` +Returns: + +void + diff --git a/docs-exp/auth.recaptchaverifier.clear.md b/docs-exp/auth.recaptchaverifier.clear.md new file mode 100644 index 00000000000..ba123cbca89 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier.clear.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [clear](./auth.recaptchaverifier.clear.md) + +## RecaptchaVerifier.clear() method + +Signature: + +```typescript +clear(): void; +``` +Returns: + +void + diff --git a/docs-exp/auth.recaptchaverifier.md b/docs-exp/auth.recaptchaverifier.md new file mode 100644 index 00000000000..568087706b6 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) + +## RecaptchaVerifier class + +Signature: + +```typescript +export declare class RecaptchaVerifier implements externs.RecaptchaVerifier, ApplicationVerifier +``` +Implements: externs.[RecaptchaVerifier](./auth-types.recaptchaverifier.md), ApplicationVerifier + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(containerOrId, parameters, auth)](./auth.recaptchaverifier._constructor_.md) | | Constructs a new instance of the RecaptchaVerifier class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_recaptchaLoader](./auth.recaptchaverifier._recaptchaloader.md) | | ReCaptchaLoader | | +| [type](./auth.recaptchaverifier.type.md) | | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_reset()](./auth.recaptchaverifier._reset.md) | | | +| [clear()](./auth.recaptchaverifier.clear.md) | | | +| [render()](./auth.recaptchaverifier.render.md) | | | +| [verify()](./auth.recaptchaverifier.verify.md) | | | + diff --git a/docs-exp/auth.recaptchaverifier.render.md b/docs-exp/auth.recaptchaverifier.render.md new file mode 100644 index 00000000000..8906d27b543 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier.render.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [render](./auth.recaptchaverifier.render.md) + +## RecaptchaVerifier.render() method + +Signature: + +```typescript +render(): Promise; +``` +Returns: + +Promise<number> + diff --git a/docs-exp/auth.recaptchaverifier.type.md b/docs-exp/auth.recaptchaverifier.type.md new file mode 100644 index 00000000000..bbfe066e173 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [type](./auth.recaptchaverifier.type.md) + +## RecaptchaVerifier.type property + +Signature: + +```typescript +readonly type = "recaptcha"; +``` diff --git a/docs-exp/auth.recaptchaverifier.verify.md b/docs-exp/auth.recaptchaverifier.verify.md new file mode 100644 index 00000000000..b43a620c077 --- /dev/null +++ b/docs-exp/auth.recaptchaverifier.verify.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [verify](./auth.recaptchaverifier.verify.md) + +## RecaptchaVerifier.verify() method + +Signature: + +```typescript +verify(): Promise; +``` +Returns: + +Promise<string> + diff --git a/docs-exp/auth.reload.md b/docs-exp/auth.reload.md new file mode 100644 index 00000000000..80b815e6fba --- /dev/null +++ b/docs-exp/auth.reload.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [reload](./auth.reload.md) + +## reload() function + +Signature: + +```typescript +export declare function reload(externUser: externs.User): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| externUser | externs.[User](./auth-types.user.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.sendemailverification.md b/docs-exp/auth.sendemailverification.md new file mode 100644 index 00000000000..48a278b86bf --- /dev/null +++ b/docs-exp/auth.sendemailverification.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [sendEmailVerification](./auth.sendemailverification.md) + +## sendEmailVerification() function + +Signature: + +```typescript +export declare function sendEmailVerification(userExtern: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.sendpasswordresetemail.md b/docs-exp/auth.sendpasswordresetemail.md new file mode 100644 index 00000000000..43dfca24398 --- /dev/null +++ b/docs-exp/auth.sendpasswordresetemail.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [sendPasswordResetEmail](./auth.sendpasswordresetemail.md) + +## sendPasswordResetEmail() function + +Signature: + +```typescript +export declare function sendPasswordResetEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.sendsigninlinktoemail.md b/docs-exp/auth.sendsigninlinktoemail.md new file mode 100644 index 00000000000..22df05cb5cf --- /dev/null +++ b/docs-exp/auth.sendsigninlinktoemail.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [sendSignInLinkToEmail](./auth.sendsigninlinktoemail.md) + +## sendSignInLinkToEmail() function + +Signature: + +```typescript +export declare function sendSignInLinkToEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.setpersistence.md b/docs-exp/auth.setpersistence.md new file mode 100644 index 00000000000..36a154e6e26 --- /dev/null +++ b/docs-exp/auth.setpersistence.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [setPersistence](./auth.setpersistence.md) + +## setPersistence() function + +Signature: + +```typescript +export declare function setPersistence(auth: externs.Auth, persistence: externs.Persistence): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| persistence | externs.[Persistence](./auth-types.persistence.md) | | + +Returns: + +void + diff --git a/docs-exp/auth.signinanonymously.md b/docs-exp/auth.signinanonymously.md new file mode 100644 index 00000000000..a3c8d7be30e --- /dev/null +++ b/docs-exp/auth.signinanonymously.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInAnonymously](./auth.signinanonymously.md) + +## signInAnonymously() function + +Signature: + +```typescript +export declare function signInAnonymously(auth: externs.Auth): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithcredential.md b/docs-exp/auth.signinwithcredential.md new file mode 100644 index 00000000000..bc33d4a27d9 --- /dev/null +++ b/docs-exp/auth.signinwithcredential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithCredential](./auth.signinwithcredential.md) + +## signInWithCredential() function + +Signature: + +```typescript +export declare function signInWithCredential(auth: externs.Auth, credential: externs.AuthCredential): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| credential | externs.[AuthCredential](./auth-types.authcredential.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithcustomtoken.md b/docs-exp/auth.signinwithcustomtoken.md new file mode 100644 index 00000000000..236c14cd1c4 --- /dev/null +++ b/docs-exp/auth.signinwithcustomtoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithCustomToken](./auth.signinwithcustomtoken.md) + +## signInWithCustomToken() function + +Signature: + +```typescript +export declare function signInWithCustomToken(authExtern: externs.Auth, customToken: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| authExtern | externs.[Auth](./auth-types.auth.md) | | +| customToken | string | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithemailandpassword.md b/docs-exp/auth.signinwithemailandpassword.md new file mode 100644 index 00000000000..38cc2a1832f --- /dev/null +++ b/docs-exp/auth.signinwithemailandpassword.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithEmailAndPassword](./auth.signinwithemailandpassword.md) + +## signInWithEmailAndPassword() function + +Signature: + +```typescript +export declare function signInWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | +| password | string | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithemaillink.md b/docs-exp/auth.signinwithemaillink.md new file mode 100644 index 00000000000..e99930a1828 --- /dev/null +++ b/docs-exp/auth.signinwithemaillink.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithEmailLink](./auth.signinwithemaillink.md) + +## signInWithEmailLink() function + +Signature: + +```typescript +export declare function signInWithEmailLink(auth: externs.Auth, email: string, emailLink?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| email | string | | +| emailLink | string | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithphonenumber.md b/docs-exp/auth.signinwithphonenumber.md new file mode 100644 index 00000000000..82768c1b0ee --- /dev/null +++ b/docs-exp/auth.signinwithphonenumber.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithPhoneNumber](./auth.signinwithphonenumber.md) + +## signInWithPhoneNumber() function + +Signature: + +```typescript +export declare function signInWithPhoneNumber(auth: externs.Auth, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| phoneNumber | string | | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | + +Returns: + +Promise<externs.[ConfirmationResult](./auth-types.confirmationresult.md)> + diff --git a/docs-exp/auth.signinwithpopup.md b/docs-exp/auth.signinwithpopup.md new file mode 100644 index 00000000000..3154fdf17d0 --- /dev/null +++ b/docs-exp/auth.signinwithpopup.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithPopup](./auth.signinwithpopup.md) + +## signInWithPopup() function + +Signature: + +```typescript +export declare function signInWithPopup(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<externs.[UserCredential](./auth-types.usercredential.md)> + diff --git a/docs-exp/auth.signinwithredirect.md b/docs-exp/auth.signinwithredirect.md new file mode 100644 index 00000000000..0decff074f2 --- /dev/null +++ b/docs-exp/auth.signinwithredirect.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signInWithRedirect](./auth.signinwithredirect.md) + +## signInWithRedirect() function + +Signature: + +```typescript +export declare function signInWithRedirect(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | +| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | + +Returns: + +Promise<never> + diff --git a/docs-exp/auth.signout.md b/docs-exp/auth.signout.md new file mode 100644 index 00000000000..81de60f223d --- /dev/null +++ b/docs-exp/auth.signout.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [signOut](./auth.signout.md) + +## signOut() function + +Signature: + +```typescript +export declare function signOut(auth: externs.Auth): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.twitterauthprovider.credential.md b/docs-exp/auth.twitterauthprovider.credential.md new file mode 100644 index 00000000000..6d69b167d4f --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.credential.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [credential](./auth.twitterauthprovider.credential.md) + +## TwitterAuthProvider.credential() method + +Signature: + +```typescript +static credential(token: string, secret: string): externs.OAuthCredential; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| token | string | | +| secret | string | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) + diff --git a/docs-exp/auth.twitterauthprovider.credentialfromerror.md b/docs-exp/auth.twitterauthprovider.credentialfromerror.md new file mode 100644 index 00000000000..65415df82a8 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.credentialfromerror.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [credentialFromError](./auth.twitterauthprovider.credentialfromerror.md) + +## TwitterAuthProvider.credentialFromError() method + +Signature: + +```typescript +static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| error | FirebaseError | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.twitterauthprovider.credentialfromresult.md b/docs-exp/auth.twitterauthprovider.credentialfromresult.md new file mode 100644 index 00000000000..1f48a64aa6a --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.credentialfromresult.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [credentialFromResult](./auth.twitterauthprovider.credentialfromresult.md) + +## TwitterAuthProvider.credentialFromResult() method + +Signature: + +```typescript +static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | + +Returns: + +externs.[OAuthCredential](./auth-types.oauthcredential.md) \| null + diff --git a/docs-exp/auth.twitterauthprovider.md b/docs-exp/auth.twitterauthprovider.md new file mode 100644 index 00000000000..82878bcb9e3 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) + +## TwitterAuthProvider class + +Signature: + +```typescript +export declare class TwitterAuthProvider extends OAuthProvider +``` +Extends: [OAuthProvider](./auth.oauthprovider.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [PROVIDER\_ID](./auth.twitterauthprovider.provider_id.md) | static | (not declared) | | +| [providerId](./auth.twitterauthprovider.providerid.md) | | (not declared) | | +| [TWITTER\_SIGN\_IN\_METHOD](./auth.twitterauthprovider.twitter_sign_in_method.md) | static | (not declared) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [credential(token, secret)](./auth.twitterauthprovider.credential.md) | static | | +| [credentialFromError(error)](./auth.twitterauthprovider.credentialfromerror.md) | static | | +| [credentialFromResult(userCredential)](./auth.twitterauthprovider.credentialfromresult.md) | static | | + diff --git a/docs-exp/auth.twitterauthprovider.provider_id.md b/docs-exp/auth.twitterauthprovider.provider_id.md new file mode 100644 index 00000000000..420e0760780 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.provider_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [PROVIDER\_ID](./auth.twitterauthprovider.provider_id.md) + +## TwitterAuthProvider.PROVIDER\_ID property + +Signature: + +```typescript +static readonly PROVIDER_ID = externs.ProviderId.TWITTER; +``` diff --git a/docs-exp/auth.twitterauthprovider.providerid.md b/docs-exp/auth.twitterauthprovider.providerid.md new file mode 100644 index 00000000000..511fd75a0d7 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.providerid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [providerId](./auth.twitterauthprovider.providerid.md) + +## TwitterAuthProvider.providerId property + +Signature: + +```typescript +readonly providerId = externs.ProviderId.TWITTER; +``` diff --git a/docs-exp/auth.twitterauthprovider.twitter_sign_in_method.md b/docs-exp/auth.twitterauthprovider.twitter_sign_in_method.md new file mode 100644 index 00000000000..49c6e2064b3 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider.twitter_sign_in_method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [TWITTER\_SIGN\_IN\_METHOD](./auth.twitterauthprovider.twitter_sign_in_method.md) + +## TwitterAuthProvider.TWITTER\_SIGN\_IN\_METHOD property + +Signature: + +```typescript +static readonly TWITTER_SIGN_IN_METHOD = externs.SignInMethod.TWITTER; +``` diff --git a/docs-exp/auth.unlink.md b/docs-exp/auth.unlink.md new file mode 100644 index 00000000000..9ccb9bec4ca --- /dev/null +++ b/docs-exp/auth.unlink.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [unlink](./auth.unlink.md) + +## unlink() function + +This is the externally visible unlink function + +Signature: + +```typescript +export declare function unlink(userExtern: externs.User, providerId: externs.ProviderId): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| providerId | externs.[ProviderId](./auth-types.providerid.md) | | + +Returns: + +Promise<externs.[User](./auth-types.user.md)> + diff --git a/docs-exp/auth.updatecurrentuser.md b/docs-exp/auth.updatecurrentuser.md new file mode 100644 index 00000000000..c80b7fcadc2 --- /dev/null +++ b/docs-exp/auth.updatecurrentuser.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [updateCurrentUser](./auth.updatecurrentuser.md) + +## updateCurrentUser() function + +Signature: + +```typescript +export declare function updateCurrentUser(auth: externs.Auth, user: externs.User | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| user | externs.[User](./auth-types.user.md) \| null | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.updateemail.md b/docs-exp/auth.updateemail.md new file mode 100644 index 00000000000..23b46b2f4d8 --- /dev/null +++ b/docs-exp/auth.updateemail.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [updateEmail](./auth.updateemail.md) + +## updateEmail() function + +Signature: + +```typescript +export declare function updateEmail(externUser: externs.User, newEmail: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| externUser | externs.[User](./auth-types.user.md) | | +| newEmail | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.updatepassword.md b/docs-exp/auth.updatepassword.md new file mode 100644 index 00000000000..2ab59fd0837 --- /dev/null +++ b/docs-exp/auth.updatepassword.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [updatePassword](./auth.updatepassword.md) + +## updatePassword() function + +Signature: + +```typescript +export declare function updatePassword(externUser: externs.User, newPassword: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| externUser | externs.[User](./auth-types.user.md) | | +| newPassword | string | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.updatephonenumber.md b/docs-exp/auth.updatephonenumber.md new file mode 100644 index 00000000000..b744161c6e8 --- /dev/null +++ b/docs-exp/auth.updatephonenumber.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [updatePhoneNumber](./auth.updatephonenumber.md) + +## updatePhoneNumber() function + +Signature: + +```typescript +export declare function updatePhoneNumber(user: externs.User, credential: externs.PhoneAuthCredential): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| user | externs.[User](./auth-types.user.md) | | +| credential | externs.[PhoneAuthCredential](./auth-types.phoneauthcredential.md) | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.updateprofile.md b/docs-exp/auth.updateprofile.md new file mode 100644 index 00000000000..4e6185bc6ec --- /dev/null +++ b/docs-exp/auth.updateprofile.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [updateProfile](./auth.updateprofile.md) + +## updateProfile() function + +Signature: + +```typescript +export declare function updateProfile(externUser: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| externUser | externs.[User](./auth-types.user.md) | | +| { displayName, photoURL: photoUrl } | Profile | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.usedevicelanguage.md b/docs-exp/auth.usedevicelanguage.md new file mode 100644 index 00000000000..66d97759634 --- /dev/null +++ b/docs-exp/auth.usedevicelanguage.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [useDeviceLanguage](./auth.usedevicelanguage.md) + +## useDeviceLanguage() function + +Signature: + +```typescript +export declare function useDeviceLanguage(auth: externs.Auth): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | + +Returns: + +void + diff --git a/docs-exp/auth.verifybeforeupdateemail.md b/docs-exp/auth.verifybeforeupdateemail.md new file mode 100644 index 00000000000..c2e1bc53ebc --- /dev/null +++ b/docs-exp/auth.verifybeforeupdateemail.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [verifyBeforeUpdateEmail](./auth.verifybeforeupdateemail.md) + +## verifyBeforeUpdateEmail() function + +Signature: + +```typescript +export declare function verifyBeforeUpdateEmail(userExtern: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userExtern | externs.[User](./auth-types.user.md) | | +| newEmail | string | | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | | + +Returns: + +Promise<void> + diff --git a/docs-exp/auth.verifypasswordresetcode.md b/docs-exp/auth.verifypasswordresetcode.md new file mode 100644 index 00000000000..9639e5f5e02 --- /dev/null +++ b/docs-exp/auth.verifypasswordresetcode.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [verifyPasswordResetCode](./auth.verifypasswordresetcode.md) + +## verifyPasswordResetCode() function + +Signature: + +```typescript +export declare function verifyPasswordResetCode(auth: externs.Auth, code: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | externs.[Auth](./auth-types.auth.md) | | +| code | string | | + +Returns: + +Promise<string> + diff --git a/docs-exp/index.md b/docs-exp/index.md index 614494a944b..528eb181002 100644 --- a/docs-exp/index.md +++ b/docs-exp/index.md @@ -10,6 +10,8 @@ | --- | --- | | [@firebase/app](./app.md) | Firebase App | | [@firebase/app-types](./app-types.md) | | +| [@firebase/auth](./auth.md) | | +| [@firebase/auth-types](./auth-types.md) | | | [@firebase/functions](./functions.md) | | | [@firebase/functions-types](./functions-types.md) | | | [@firebase/installations](./installations.md) | | diff --git a/docs-exp/performance.registerperformance.md b/docs-exp/performance.registerperformance.md deleted file mode 100644 index c22c36e551d..00000000000 --- a/docs-exp/performance.registerperformance.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/performance](./performance.md) > [registerPerformance](./performance.registerperformance.md) - -## registerPerformance() function - -Signature: - -```typescript -export declare function registerPerformance(): void; -``` -Returns: - -void - diff --git a/packages-exp/auth-types-exp/api-extractor.json b/packages-exp/auth-types-exp/api-extractor.json index 8a3c6cb251e..42f37a88c4b 100644 --- a/packages-exp/auth-types-exp/api-extractor.json +++ b/packages-exp/auth-types-exp/api-extractor.json @@ -1,10 +1,5 @@ { "extends": "../../config/api-extractor.json", // Point it to your entry point d.ts file. - "mainEntryPointFilePath": "/dist/src/index.d.ts", - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "/dist/.d.ts", - "publicTrimmedFilePath": "/dist/-public.d.ts" - } + "mainEntryPointFilePath": "/index.d.ts" } \ No newline at end of file