Skip to content

Commit 564cbe5

Browse files
egilmorezegilmorez
authored
Merge updated index.d.ts and TypeDoc assets to master branch (#554)
* Getting the typedoc toolchain to run against index.d.ts * Removing unused templates * Adding a npm script * Adding commenting for Admin and Storage. (#510) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding comments for admin.Messaging and a few others. (#516) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Auto-generating links to re-exported Firestore types (#519) * Adding comments for Auth classes and updating TOC (#521) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding TypeDoc comments for Auth methods. (#530) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding comments for Auth methods. * Addressing feedback from bojeil-goole. * Second attempt to view and address *all* comments from bojeil-google. * Removing unnecessary whitespace. * Fixing what we think and hope is the last typo in this pull request. * Credential db (#544) * Adding comments for credential and database classes/methods. * Fixing typo in example. * Adding changes requested by hiranya911. * Fixing a typo. * Fixing the typo fixes. * Adding comments for admin.projectManagement. (#547) * Adding comments for admin.projectManagement. * Fixing misplaced comments for appId metadata. * Merging changes with master. (#553) * Getting the typedoc toolchain to run against index.d.ts * Removing unused templates * Adding a npm script * Adding commenting for Admin and Storage. (#510) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding comments for admin.Messaging and a few others. (#516) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Auto-generating links to re-exported Firestore types (#519) * Adding comments for Auth classes and updating TOC (#521) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding TypeDoc comments for Auth methods. (#530) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding comments for Auth methods. * Addressing feedback from bojeil-goole. * Second attempt to view and address *all* comments from bojeil-google. * Removing unnecessary whitespace. * Fixing what we think and hope is the last typo in this pull request. * Credential db (#544) * Adding comments for credential and database classes/methods. * Fixing typo in example. * Adding changes requested by hiranya911. * Fixing a typo. * Fixing the typo fixes. * Adding comments for admin.projectManagement. (#547) * Adding comments for admin.projectManagement. * Fixing misplaced comments for appId metadata. * Adding new line to end of file.
1 parent 9e86633 commit 564cbe5

19 files changed

+7390
-407
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ test/resources/apikey.txt
1616

1717
# Release tarballs should not be checked in
1818
firebase-admin-*.tgz
19+
20+
docgen/html/

‎docgen/content-sources/node/HOME.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Firebase Admin Node.js SDK Reference
2+
3+
The Admin SDK lets you interact with Firebase from privileged environments.
4+
You can install it via our [npm package](https://www.npmjs.com/package/firebase-admin).
5+
6+
To get started using the Firebase Admin Node.js SDK, see
7+
[Add the Firebase Admin SDK to your server](https://firebase.google.com/docs/admin/setup).
8+
9+
For source code, see the [Firebase Admin Node.js SDK Github repo](https://github.com/firebase/firebase-admin-node).

‎docgen/content-sources/node/toc.yaml

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
toc:
2+
- title: "admin"
3+
path: /docs/reference/admin/node/admin
4+
section:
5+
- title: "AppOptions"
6+
path: /docs/reference/admin/node/admin.AppOptions
7+
- title: "FirebaseArrayIndexError"
8+
path: /docs/reference/admin/node/admin.FirebaseArrayIndexError
9+
- title: "FirebaseError"
10+
path: /docs/reference/admin/node/admin.FirebaseError
11+
- title: "GoogleOAuthAccessToken"
12+
path: /docs/reference/admin/node/admin.GoogleOAuthAccessToken
13+
- title: "ServiceAccount"
14+
path: /docs/reference/admin/node/admin.ServiceAccount
15+
16+
- title: "admin.app"
17+
path: /docs/reference/admin/node/admin.app
18+
section:
19+
- title: "App"
20+
path: /docs/reference/admin/node/admin.app.App
21+
22+
- title: "admin.auth"
23+
path: /docs/reference/admin/node/admin.auth
24+
section:
25+
- title: "Auth"
26+
path: /docs/reference/admin/node/admin.auth.Auth
27+
- title: "ActionCodeSettings"
28+
path: /docs/reference/admin/node/admin.auth.ActionCodeSettings
29+
- title: "AuthProviderConfig"
30+
path: /docs/reference/admin/node/admin.auth.AuthProviderConfig
31+
- title: "AuthProviderConfigFilter"
32+
path: /docs/reference/admin/node/admin.auth.AuthProviderConfigFilter
33+
- title: "CreateRequest"
34+
path: /docs/reference/admin/node/admin.auth.CreateRequest
35+
- title: "ListProviderConfigResults"
36+
path: /docs/reference/admin/node/admin.auth.ListProviderConfigResults
37+
- title: "OIDCAuthProviderConfig"
38+
path: /docs/reference/admin/node/admin.auth.OIDCAuthProviderConfig
39+
- title: "OIDCUpdateAuthProviderRequest"
40+
path: /docs/reference/admin/node/admin.auth.OIDCUpdateAuthProviderRequest
41+
- title: "SAMLAuthProviderConfig"
42+
path: /docs/reference/admin/node/admin.auth.SAMLAuthProviderConfig
43+
- title: "SAMLUpdateAuthProviderRequest"
44+
path: /docs/reference/admin/node/admin.auth.SAMLUpdateAuthProviderRequest
45+
- title: "UpdateRequest"
46+
path: /docs/reference/admin/node/admin.auth.UpdateRequest
47+
- title: "UserImportOptions"
48+
path: /docs/reference/admin/node/admin.auth.UserImportOptions
49+
- title: "UserImportRecord"
50+
path: /docs/reference/admin/node/admin.auth.UserImportRecord
51+
- title: "UserImportResult"
52+
path: /docs/reference/admin/node/admin.auth.UserImportResult
53+
- title: "DecodedIdToken"
54+
path: /docs/reference/admin/node/admin.auth.DecodedIdToken
55+
- title: "UserInfo"
56+
path: /docs/reference/admin/node/admin.auth.UserInfo
57+
- title: "UserMetadata"
58+
path: /docs/reference/admin/node/admin.auth.UserMetadata
59+
- title: "UserRecord"
60+
path: /docs/reference/admin/node/admin.auth.UserRecord
61+
- title: "SessionCookieOptions"
62+
path: /docs/reference/admin/node/admin.auth.SessionCookieOptions
63+
- title: "BaseAuth"
64+
path: /docs/reference/admin/node/admin.auth.BaseAuth
65+
- title: "ListUsersResult"
66+
path: /docs/reference/admin/node/admin.auth.ListUsersResult
67+
68+
- title: "admin.credential"
69+
path: /docs/reference/admin/node/admin.credential
70+
section:
71+
- title: "Credential"
72+
path: /docs/reference/admin/node/admin.credential.Credential
73+
74+
- title: "admin.database"
75+
path: /docs/reference/admin/node/admin.database
76+
section:
77+
- title: "Database"
78+
path: /docs/reference/admin/node/admin.database.Database
79+
- title: "DataSnapshot"
80+
path: /docs/reference/admin/node/admin.database.DataSnapshot
81+
- title: "OnDisconnect"
82+
path: /docs/reference/admin/node/admin.database.OnDisconnect
83+
- title: "Query"
84+
path: /docs/reference/admin/node/admin.database.Query
85+
- title: "Reference"
86+
path: /docs/reference/admin/node/admin.database.Reference
87+
- title: "ServerValue"
88+
path: /docs/reference/admin/node/admin.database.ServerValue
89+
- title: "ThenableReference"
90+
path: /docs/reference/admin/node/admin.database.ThenableReference
91+
92+
- title: "admin.firestore"
93+
path: /docs/reference/admin/node/admin.firestore
94+
95+
- title: "admin.instanceId"
96+
path: /docs/reference/admin/node/admin.instanceId
97+
section:
98+
- title: "InstanceId"
99+
path: /docs/reference/admin/node/admin.instanceId.InstanceId
100+
101+
- title: "admin.messaging"
102+
path: /docs/reference/admin/node/admin.messaging
103+
section:
104+
- title: "TopicMessage"
105+
path: /docs/reference/admin/node/TopicMessage
106+
- title: "TokenMessage"
107+
path: /docs/reference/admin/node/TokenMessage
108+
- title: "ConditionMessage"
109+
path: /docs/reference/admin/node/ConditionMessage
110+
- title: "AndroidConfig"
111+
path: /docs/reference/admin/node/admin.messaging.AndroidConfig
112+
- title: "AndroidNotification"
113+
path: /docs/reference/admin/node/admin.messaging.AndroidNotification
114+
- title: "Messaging"
115+
path: /docs/reference/admin/node/admin.messaging.Messaging
116+
- title: "MessagingConditionResponse"
117+
path: /docs/reference/admin/node/admin.messaging.MessagingConditionResponse
118+
- title: "MessagingDeviceGroupResponse"
119+
path: /docs/reference/admin/node/admin.messaging.MessagingDeviceGroupResponse
120+
- title: "MessagingDeviceResult"
121+
path: /docs/reference/admin/node/admin.messaging.MessagingDeviceResult
122+
- title: "MessagingDevicesResponse"
123+
path: /docs/reference/admin/node/admin.messaging.MessagingDevicesResponse
124+
- title: "MessagingOptions"
125+
path: /docs/reference/admin/node/admin.messaging.MessagingOptions
126+
- title: "MessagingPayload"
127+
path: /docs/reference/admin/node/admin.messaging.MessagingPayload
128+
- title: "MessagingTopicResponse"
129+
path: /docs/reference/admin/node/admin.messaging.MessagingTopicResponse
130+
- title: "MessagingTopicManagementResponse"
131+
path: /docs/reference/admin/node/admin.messaging.MessagingTopicManagementResponse
132+
- title: "NotificationMessagePayload"
133+
path: /docs/reference/admin/node/admin.messaging.NotificationMessagePayload
134+
- title: "MulticastMessage"
135+
path: /docs/reference/admin/node/admin.messaging.MulticastMessage
136+
- title: "WebpushNotification"
137+
path: /docs/reference/admin/node/admin.messaging.WebpushNotification
138+
- title: "WebpushFcmOptions"
139+
path: /docs/reference/admin/node/admin.messaging.WebpushFcmOptions
140+
- title: "DataMessagePayload"
141+
path: /docs/reference/admin/node/admin.messaging.DataMessagePayload
142+
- title: "BatchResponse"
143+
path: /docs/reference/admin/node/admin.messaging.BatchResponse
144+
- title: "SendResponse"
145+
path: /docs/reference/admin/node/admin.messaging.SendResponse
146+
- title: "ApnsConfig"
147+
path: /docs/reference/admin/node/admin.messaging.ApnsConfig
148+
- title: "ApnsPayload"
149+
path: /docs/reference/admin/node/admin.messaging.ApnsPayload
150+
- title: "Aps"
151+
path: /docs/reference/admin/node/admin.messaging.Aps
152+
- title: "ApsAlert"
153+
path: /docs/reference/admin/node/admin.messaging.ApsAlert
154+
- title: "CriticalSound"
155+
path: /docs/reference/admin/node/admin.messaging.CriticalSound
156+
- title: "Notification"
157+
path: /docs/reference/admin/node/admin.messaging.Notification
158+
- title: "WebpushConfig"
159+
path: /docs/reference/admin/node/admin.messaging.WebpushConfig
160+
161+
- title: "admin.projectManagement"
162+
path: /docs/reference/admin/node/admin.projectManagement
163+
section:
164+
- title: "AndroidApp"
165+
path: /docs/reference/admin/node/admin.projectManagement.AndroidApp
166+
- title: "AndroidAppMetadata"
167+
path: /docs/reference/admin/node/admin.projectManagement.AndroidAppMetadata
168+
- title: "IosApp"
169+
path: /docs/reference/admin/node/admin.projectManagement.IosApp
170+
- title: "IosAppMetadata"
171+
path: /docs/reference/admin/node/admin.projectManagement.IosAppMetadata
172+
- title: "ProjectManagement"
173+
path: /docs/reference/admin/node/admin.projectManagement.ProjectManagement
174+
- title: "ShaCertificate"
175+
path: /docs/reference/admin/node/admin.projectManagement.ShaCertificate
176+
177+
- title: "admin.storage"
178+
path: /docs/reference/admin/node/admin.storage
179+
section:
180+
- title: "Storage"
181+
path: /docs/reference/admin/node/admin.storage.Storage

0 commit comments

Comments
 (0)