Skip to content

Commit 438aa88

Browse files
committed
fix: Regenerated docs with #1459
1 parent d346407 commit 438aa88

30 files changed

+78
-65
lines changed

docgen/markdown/firebase-admin.app-check.appcheck.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export declare class AppCheck
1919

2020
| Method | Modifiers | Description |
2121
| --- | --- | --- |
22-
| [createToken(appId, options)](./firebase-admin.app-check.appcheck.md#appcheckcreatetoken) | | Creates a new that can be sent back to a client. |
22+
| [createToken(appId, options)](./firebase-admin.app-check.appcheck.md#appcheckcreatetoken) | | Creates a new [AppCheckToken](./firebase-admin.app-check.appchecktoken.md#appchecktoken_interface) that can be sent back to a client. |
2323
| [verifyToken(appCheckToken)](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) | | Verifies a Firebase App Check token (JWT). If the token is valid, the promise is fulfilled with the token's decoded claims; otherwise, the promise is rejected. |
2424

2525
## AppCheck.app
@@ -32,7 +32,7 @@ readonly app: App;
3232

3333
## AppCheck.createToken()
3434

35-
Creates a new that can be sent back to a client.
35+
Creates a new [AppCheckToken](./firebase-admin.app-check.appchecktoken.md#appchecktoken_interface) that can be sent back to a client.
3636

3737
<b>Signature:</b>
3838

docgen/markdown/firebase-admin.app.appoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface AppOptions
1313

1414
| Property | Type | Description |
1515
| --- | --- | --- |
16-
| [credential](./firebase-admin.app.appoptions.md#appoptionscredential) | [Credential](./firebase-admin.app.credential.md#credential_interface) | A object used to authenticate the Admin SDK.<!-- -->See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples. |
16+
| [credential](./firebase-admin.app.appoptions.md#appoptionscredential) | [Credential](./firebase-admin.app.credential.md#credential_interface) | A [Credential](./firebase-admin.app.credential.md#credential_interface) object used to authenticate the Admin SDK.<!-- -->See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples. |
1717
| [databaseAuthVariableOverride](./firebase-admin.app.appoptions.md#appoptionsdatabaseauthvariableoverride) | object \| null | The object to use as the [auth](https://firebase.google.com/docs/reference/security/database/#auth) variable in your Realtime Database Rules when the Admin SDK reads from or writes to the Realtime Database. This allows you to downscope the Admin SDK from its default full read and write privileges.<!-- -->You can pass <code>null</code> to act as an unauthenticated client.<!-- -->See [Authenticate with limited privileges](https://firebase.google.com/docs/database/admin/start#authenticate-with-limited-privileges) for detailed documentation and code samples. |
1818
| [databaseURL](./firebase-admin.app.appoptions.md#appoptionsdatabaseurl) | string | The URL of the Realtime Database from which to read and write data. |
1919
| [httpAgent](./firebase-admin.app.appoptions.md#appoptionshttpagent) | Agent | An [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent) to be used when making outgoing HTTP calls. This Agent instance is used by all services that make REST calls (e.g. <code>auth</code>, <code>messaging</code>, <code>projectManagement</code>).<!-- -->Realtime Database and Firestore use other means of communicating with the backend servers, so they do not use this HTTP Agent. <code>Credential</code> instances also do not use this HTTP Agent, but instead support specifying an HTTP Agent in the corresponding factory methods. |
@@ -23,7 +23,7 @@ export interface AppOptions
2323

2424
## AppOptions.credential
2525

26-
A object used to authenticate the Admin SDK.
26+
A [Credential](./firebase-admin.app.credential.md#credential_interface) object used to authenticate the Admin SDK.
2727

2828
See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples.
2929

docgen/markdown/firebase-admin.app.credential.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{% block body %}
44
Interface that provides Google OAuth2 access tokens used to authenticate with Firebase services.
55

6-
In most cases, you will not need to implement this yourself and can instead use the default implementations provided by .
6+
In most cases, you will not need to implement this yourself and can instead use the default implementations provided by the `firebase-admin/app` module.
77

88
<b>Signature:</b>
99

docgen/markdown/firebase-admin.app.firebaseerror.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface FirebaseError
1515
| --- | --- | --- |
1616
| [code](./firebase-admin.app.firebaseerror.md#firebaseerrorcode) | string | Error codes are strings using the following format: <code>&quot;service/string-code&quot;</code>. Some examples include <code>&quot;auth/invalid-uid&quot;</code> and <code>&quot;messaging/invalid-recipient&quot;</code>.<!-- -->While the message for a given error can change, the code will remain the same between backward-compatible versions of the Firebase SDK. |
1717
| [message](./firebase-admin.app.firebaseerror.md#firebaseerrormessage) | string | An explanatory message for the error that just occurred.<!-- -->This message is designed to be helpful to you, the developer. Because it generally does not convey meaningful information to end users, this message should not be displayed in your application. |
18-
| [stack](./firebase-admin.app.firebaseerror.md#firebaseerrorstack) | string | A string value containing the execution backtrace when the error originally occurred.<!-- -->This information can be useful to you and can be sent to to help explain the cause of an error. |
18+
| [stack](./firebase-admin.app.firebaseerror.md#firebaseerrorstack) | string | A string value containing the execution backtrace when the error originally occurred.<!-- -->This information can be useful to you and can be sent to [Firebase Support](https://firebase.google.com/support) to help explain the cause of an error. |
1919

2020
## Methods
2121

@@ -51,7 +51,7 @@ message: string;
5151

5252
A string value containing the execution backtrace when the error originally occurred.
5353

54-
This information can be useful to you and can be sent to to help explain the cause of an error.
54+
This information can be useful to you and can be sent to [Firebase Support](https://firebase.google.com/support) to help explain the cause of an error.
5555

5656
<b>Signature:</b>
5757

docgen/markdown/firebase-admin.app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Firebase App and SDK initialization.
2121
| --- | --- |
2222
| [App](./firebase-admin.app.app.md#app_interface) | A Firebase app holds the initialization information for a collection of services. |
2323
| [AppOptions](./firebase-admin.app.appoptions.md#appoptions_interface) | Available options to pass to [initializeApp()](./firebase-admin.app.md#initializeapp)<!-- -->. |
24-
| [Credential](./firebase-admin.app.credential.md#credential_interface) | Interface that provides Google OAuth2 access tokens used to authenticate with Firebase services.<!-- -->In most cases, you will not need to implement this yourself and can instead use the default implementations provided by . |
24+
| [Credential](./firebase-admin.app.credential.md#credential_interface) | Interface that provides Google OAuth2 access tokens used to authenticate with Firebase services.<!-- -->In most cases, you will not need to implement this yourself and can instead use the default implementations provided by the <code>firebase-admin/app</code> module. |
2525
| [FirebaseArrayIndexError](./firebase-admin.app.firebasearrayindexerror.md#firebasearrayindexerror_interface) | Composite type which includes both a <code>FirebaseError</code> object and an index which can be used to get the errored item. |
2626
| [FirebaseError](./firebase-admin.app.firebaseerror.md#firebaseerror_interface) | <code>FirebaseError</code> is a subclass of the standard JavaScript <code>Error</code> object. In addition to a message string and stack trace, it contains a string code. |
2727
| [GoogleOAuthAccessToken](./firebase-admin.app.googleoauthaccesstoken.md#googleoauthaccesstoken_interface) | Interface for Google OAuth 2.0 access tokens. |

docgen/markdown/firebase-admin.app_n.app.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{% block body %}
44
A Firebase app holds the initialization information for a collection of services.
55

6-
Do not call this constructor directly. Instead, use to create an app.
6+
Do not call this constructor directly. Instead, use [initializeApp()](./firebase-admin.app.md#initializeapp) to create an app.
77

88
<b>Signature:</b>
99

@@ -123,6 +123,7 @@ installations(): installations.Installations;
123123
124124
> Warning: This API is now obsolete.
125125
>
126+
> Use [Installations](./firebase-admin.installations.installations.md#installations_class) instead.
126127
>
127128
128129
<b>Signature:</b>

docgen/markdown/firebase-admin.app_n.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ export declare namespace app
1111
1212
| Interface | Description |
1313
| --- | --- |
14-
| [App](./firebase-admin.app_n.app.md#appapp_interface) | A Firebase app holds the initialization information for a collection of services.<!-- -->Do not call this constructor directly. Instead, use to create an app. |
14+
| [App](./firebase-admin.app_n.app.md#appapp_interface) | A Firebase app holds the initialization information for a collection of services.<!-- -->Do not call this constructor directly. Instead, use [initializeApp()](./firebase-admin.app.md#initializeapp) to create an app. |
1515
1616
{% endblock body %}

docgen/markdown/firebase-admin.appoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface AppOptions
1313

1414
| Property | Type | Description |
1515
| --- | --- | --- |
16-
| [credential](./firebase-admin.appoptions.md#appoptionscredential) | Credential | A object used to authenticate the Admin SDK.<!-- -->See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples. |
16+
| [credential](./firebase-admin.appoptions.md#appoptionscredential) | Credential | A [Credential](./firebase-admin.app.credential.md#credential_interface) object used to authenticate the Admin SDK.<!-- -->See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples. |
1717
| [databaseAuthVariableOverride](./firebase-admin.appoptions.md#appoptionsdatabaseauthvariableoverride) | object \| null | The object to use as the [auth](https://firebase.google.com/docs/reference/security/database/#auth) variable in your Realtime Database Rules when the Admin SDK reads from or writes to the Realtime Database. This allows you to downscope the Admin SDK from its default full read and write privileges.<!-- -->You can pass <code>null</code> to act as an unauthenticated client.<!-- -->See [Authenticate with limited privileges](https://firebase.google.com/docs/database/admin/start#authenticate-with-limited-privileges) for detailed documentation and code samples. |
1818
| [databaseURL](./firebase-admin.appoptions.md#appoptionsdatabaseurl) | string | The URL of the Realtime Database from which to read and write data. |
1919
| [httpAgent](./firebase-admin.appoptions.md#appoptionshttpagent) | Agent | An [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent) to be used when making outgoing HTTP calls. This Agent instance is used by all services that make REST calls (e.g. <code>auth</code>, <code>messaging</code>, <code>projectManagement</code>).<!-- -->Realtime Database and Firestore use other means of communicating with the backend servers, so they do not use this HTTP Agent. <code>Credential</code> instances also do not use this HTTP Agent, but instead support specifying an HTTP Agent in the corresponding factory methods. |
@@ -23,7 +23,7 @@ export interface AppOptions
2323

2424
## AppOptions.credential
2525

26-
A object used to authenticate the Admin SDK.
26+
A [Credential](./firebase-admin.app.credential.md#credential_interface) object used to authenticate the Admin SDK.
2727

2828
See [Initialize the SDK](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) for detailed documentation and code samples.
2929

docgen/markdown/firebase-admin.auth.authproviderconfigfilter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends "_internal/templates/reference.html" %}
22
{% block title %}AuthProviderConfigFilter interface{% endblock title %}
33
{% block body %}
4-
The filter interface used for listing provider configurations. This is used when specifying how to list configured identity providers via .
4+
The filter interface used for listing provider configurations. This is used when specifying how to list configured identity providers via [BaseAuth.listProviderConfigs()](./firebase-admin.auth.baseauth.md#baseauthlistproviderconfigs)<!-- -->.
55

66
<b>Signature:</b>
77

docgen/markdown/firebase-admin.auth.baseauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
505505

506506
| Parameter | Type | Description |
507507
| --- | --- | --- |
508-
| identifiers | [UserIdentifier](./firebase-admin.auth.md#useridentifier)<!-- -->\[\] | The identifiers used to indicate which user records should be returned. Must have &lt;<!-- -->= 100 entries. |
508+
| identifiers | [UserIdentifier](./firebase-admin.auth.md#useridentifier)<!-- -->\[\] | The identifiers used to indicate which user records should be returned. Must not have more than 100 entries. |
509509

510510
<b>Returns:</b>
511511

docgen/markdown/firebase-admin.auth.decodedidtoken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends "_internal/templates/reference.html" %}
22
{% block title %}DecodedIdToken interface{% endblock title %}
33
{% block body %}
4-
Interface representing a decoded Firebase ID token, returned from the method.
4+
Interface representing a decoded Firebase ID token, returned from the [BaseAuth.verifyIdToken()](./firebase-admin.auth.baseauth.md#baseauthverifyidtoken) method.
55

66
Firebase ID tokens are OpenID Connect spec-compliant JSON Web Tokens (JWTs). See the \[ID Token section of the OpenID Connect spec\](http://openid.net/specs/openid-connect-core-1\_0.html\#IDToken) for more information about the specific properties below.
77

docgen/markdown/firebase-admin.auth.listproviderconfigresults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends "_internal/templates/reference.html" %}
22
{% block title %}ListProviderConfigResults interface{% endblock title %}
33
{% block body %}
4-
The response interface for listing provider configs. This is only available when listing all identity providers' configurations via .
4+
The response interface for listing provider configs. This is only available when listing all identity providers' configurations via [BaseAuth.listProviderConfigs()](./firebase-admin.auth.baseauth.md#baseauthlistproviderconfigs)<!-- -->.
55

66
<b>Signature:</b>
77

docgen/markdown/firebase-admin.auth.listusersresult.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends "_internal/templates/reference.html" %}
22
{% block title %}ListUsersResult interface{% endblock title %}
33
{% block body %}
4-
Interface representing the object returned from a operation. Contains the list of users for the current batch and the next page token if available.
4+
Interface representing the object returned from a [BaseAuth.listUsers()](./firebase-admin.auth.baseauth.md#baseauthlistusers) operation. Contains the list of users for the current batch and the next page token if available.
55

66
<b>Signature:</b>
77

@@ -14,7 +14,7 @@ export interface ListUsersResult
1414
| Property | Type | Description |
1515
| --- | --- | --- |
1616
| [pageToken](./firebase-admin.auth.listusersresult.md#listusersresultpagetoken) | string | The next page token if available. This is needed for the next batch download. |
17-
| [users](./firebase-admin.auth.listusersresult.md#listusersresultusers) | [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class)<!-- -->\[\] | The list of objects for the current downloaded batch. |
17+
| [users](./firebase-admin.auth.listusersresult.md#listusersresultusers) | [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class)<!-- -->\[\] | The list of [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class) objects for the current downloaded batch. |
1818

1919
## ListUsersResult.pageToken
2020

@@ -28,7 +28,7 @@ pageToken?: string;
2828

2929
## ListUsersResult.users
3030

31-
The list of objects for the current downloaded batch.
31+
The list of [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class) objects for the current downloaded batch.
3232

3333
<b>Signature:</b>
3434

0 commit comments

Comments
 (0)