Skip to content

Merge updated index.d.ts and TypeDoc assets to master branch #554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Jun 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c624b8c
Getting the typedoc toolchain to run against index.d.ts
hiranya911 Apr 4, 2019
25bf773
Removing unused templates
hiranya911 Apr 4, 2019
c672634
Adding a npm script
hiranya911 Apr 4, 2019
24646d8
Merge branch 'master' into hkj-typedoc
hiranya911 Apr 23, 2019
db6d4fd
Adding commenting for Admin and Storage. (#510)
egilmorez Apr 24, 2019
935b81b
Adding comments for admin.Messaging and a few others. (#516)
egilmorez Apr 29, 2019
4b6b224
Auto-generating links to re-exported Firestore types (#519)
hiranya911 May 8, 2019
af2922c
Adding comments for Auth classes and updating TOC (#521)
egilmorez May 14, 2019
9fe5c26
Adding TypeDoc comments for Auth methods. (#530)
egilmorez May 23, 2019
84cdb2f
Credential db (#544)
egilmorez May 31, 2019
fc9b65e
Adding comments for admin.projectManagement. (#547)
egilmorez Jun 4, 2019
aab3379
Merging changes with master. (#553)
egilmorez Jun 5, 2019
941cf1b
Getting the typedoc toolchain to run against index.d.ts
hiranya911 Apr 4, 2019
4e1547c
Removing unused templates
hiranya911 Apr 4, 2019
d60b16c
Adding a npm script
hiranya911 Apr 4, 2019
3439674
Adding commenting for Admin and Storage. (#510)
egilmorez Apr 24, 2019
8b160eb
Adding comments for admin.Messaging and a few others. (#516)
egilmorez Apr 29, 2019
1c52f51
Auto-generating links to re-exported Firestore types (#519)
hiranya911 May 8, 2019
cedd520
Adding comments for Auth classes and updating TOC (#521)
egilmorez May 14, 2019
47cd42a
Adding TypeDoc comments for Auth methods. (#530)
egilmorez May 23, 2019
5dc499b
Credential db (#544)
egilmorez May 31, 2019
2d19938
Adding comments for admin.projectManagement. (#547)
egilmorez Jun 4, 2019
e82bc21
Merged with upstream
hiranya911 Jun 5, 2019
cd91392
Adding new line to end of file.
egilmorez Jun 5, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ test/resources/apikey.txt

# Release tarballs should not be checked in
firebase-admin-*.tgz

docgen/html/
9 changes: 9 additions & 0 deletions docgen/content-sources/node/HOME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Firebase Admin Node.js SDK Reference

The Admin SDK lets you interact with Firebase from privileged environments.
You can install it via our [npm package](https://www.npmjs.com/package/firebase-admin).

To get started using the Firebase Admin Node.js SDK, see
[Add the Firebase Admin SDK to your server](https://firebase.google.com/docs/admin/setup).

For source code, see the [Firebase Admin Node.js SDK Github repo](https://github.com/firebase/firebase-admin-node).
181 changes: 181 additions & 0 deletions docgen/content-sources/node/toc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
toc:
- title: "admin"
path: /docs/reference/admin/node/admin
section:
- title: "AppOptions"
path: /docs/reference/admin/node/admin.AppOptions
- title: "FirebaseArrayIndexError"
path: /docs/reference/admin/node/admin.FirebaseArrayIndexError
- title: "FirebaseError"
path: /docs/reference/admin/node/admin.FirebaseError
- title: "GoogleOAuthAccessToken"
path: /docs/reference/admin/node/admin.GoogleOAuthAccessToken
- title: "ServiceAccount"
path: /docs/reference/admin/node/admin.ServiceAccount

- title: "admin.app"
path: /docs/reference/admin/node/admin.app
section:
- title: "App"
path: /docs/reference/admin/node/admin.app.App

- title: "admin.auth"
path: /docs/reference/admin/node/admin.auth
section:
- title: "Auth"
path: /docs/reference/admin/node/admin.auth.Auth
- title: "ActionCodeSettings"
path: /docs/reference/admin/node/admin.auth.ActionCodeSettings
- title: "AuthProviderConfig"
path: /docs/reference/admin/node/admin.auth.AuthProviderConfig
- title: "AuthProviderConfigFilter"
path: /docs/reference/admin/node/admin.auth.AuthProviderConfigFilter
- title: "CreateRequest"
path: /docs/reference/admin/node/admin.auth.CreateRequest
- title: "ListProviderConfigResults"
path: /docs/reference/admin/node/admin.auth.ListProviderConfigResults
- title: "OIDCAuthProviderConfig"
path: /docs/reference/admin/node/admin.auth.OIDCAuthProviderConfig
- title: "OIDCUpdateAuthProviderRequest"
path: /docs/reference/admin/node/admin.auth.OIDCUpdateAuthProviderRequest
- title: "SAMLAuthProviderConfig"
path: /docs/reference/admin/node/admin.auth.SAMLAuthProviderConfig
- title: "SAMLUpdateAuthProviderRequest"
path: /docs/reference/admin/node/admin.auth.SAMLUpdateAuthProviderRequest
- title: "UpdateRequest"
path: /docs/reference/admin/node/admin.auth.UpdateRequest
- title: "UserImportOptions"
path: /docs/reference/admin/node/admin.auth.UserImportOptions
- title: "UserImportRecord"
path: /docs/reference/admin/node/admin.auth.UserImportRecord
- title: "UserImportResult"
path: /docs/reference/admin/node/admin.auth.UserImportResult
- title: "DecodedIdToken"
path: /docs/reference/admin/node/admin.auth.DecodedIdToken
- title: "UserInfo"
path: /docs/reference/admin/node/admin.auth.UserInfo
- title: "UserMetadata"
path: /docs/reference/admin/node/admin.auth.UserMetadata
- title: "UserRecord"
path: /docs/reference/admin/node/admin.auth.UserRecord
- title: "SessionCookieOptions"
path: /docs/reference/admin/node/admin.auth.SessionCookieOptions
- title: "BaseAuth"
path: /docs/reference/admin/node/admin.auth.BaseAuth
- title: "ListUsersResult"
path: /docs/reference/admin/node/admin.auth.ListUsersResult

- title: "admin.credential"
path: /docs/reference/admin/node/admin.credential
section:
- title: "Credential"
path: /docs/reference/admin/node/admin.credential.Credential

- title: "admin.database"
path: /docs/reference/admin/node/admin.database
section:
- title: "Database"
path: /docs/reference/admin/node/admin.database.Database
- title: "DataSnapshot"
path: /docs/reference/admin/node/admin.database.DataSnapshot
- title: "OnDisconnect"
path: /docs/reference/admin/node/admin.database.OnDisconnect
- title: "Query"
path: /docs/reference/admin/node/admin.database.Query
- title: "Reference"
path: /docs/reference/admin/node/admin.database.Reference
- title: "ServerValue"
path: /docs/reference/admin/node/admin.database.ServerValue
- title: "ThenableReference"
path: /docs/reference/admin/node/admin.database.ThenableReference

- title: "admin.firestore"
path: /docs/reference/admin/node/admin.firestore

- title: "admin.instanceId"
path: /docs/reference/admin/node/admin.instanceId
section:
- title: "InstanceId"
path: /docs/reference/admin/node/admin.instanceId.InstanceId

- title: "admin.messaging"
path: /docs/reference/admin/node/admin.messaging
section:
- title: "TopicMessage"
path: /docs/reference/admin/node/TopicMessage
- title: "TokenMessage"
path: /docs/reference/admin/node/TokenMessage
- title: "ConditionMessage"
path: /docs/reference/admin/node/ConditionMessage
- title: "AndroidConfig"
path: /docs/reference/admin/node/admin.messaging.AndroidConfig
- title: "AndroidNotification"
path: /docs/reference/admin/node/admin.messaging.AndroidNotification
- title: "Messaging"
path: /docs/reference/admin/node/admin.messaging.Messaging
- title: "MessagingConditionResponse"
path: /docs/reference/admin/node/admin.messaging.MessagingConditionResponse
- title: "MessagingDeviceGroupResponse"
path: /docs/reference/admin/node/admin.messaging.MessagingDeviceGroupResponse
- title: "MessagingDeviceResult"
path: /docs/reference/admin/node/admin.messaging.MessagingDeviceResult
- title: "MessagingDevicesResponse"
path: /docs/reference/admin/node/admin.messaging.MessagingDevicesResponse
- title: "MessagingOptions"
path: /docs/reference/admin/node/admin.messaging.MessagingOptions
- title: "MessagingPayload"
path: /docs/reference/admin/node/admin.messaging.MessagingPayload
- title: "MessagingTopicResponse"
path: /docs/reference/admin/node/admin.messaging.MessagingTopicResponse
- title: "MessagingTopicManagementResponse"
path: /docs/reference/admin/node/admin.messaging.MessagingTopicManagementResponse
- title: "NotificationMessagePayload"
path: /docs/reference/admin/node/admin.messaging.NotificationMessagePayload
- title: "MulticastMessage"
path: /docs/reference/admin/node/admin.messaging.MulticastMessage
- title: "WebpushNotification"
path: /docs/reference/admin/node/admin.messaging.WebpushNotification
- title: "WebpushFcmOptions"
path: /docs/reference/admin/node/admin.messaging.WebpushFcmOptions
- title: "DataMessagePayload"
path: /docs/reference/admin/node/admin.messaging.DataMessagePayload
- title: "BatchResponse"
path: /docs/reference/admin/node/admin.messaging.BatchResponse
- title: "SendResponse"
path: /docs/reference/admin/node/admin.messaging.SendResponse
- title: "ApnsConfig"
path: /docs/reference/admin/node/admin.messaging.ApnsConfig
- title: "ApnsPayload"
path: /docs/reference/admin/node/admin.messaging.ApnsPayload
- title: "Aps"
path: /docs/reference/admin/node/admin.messaging.Aps
- title: "ApsAlert"
path: /docs/reference/admin/node/admin.messaging.ApsAlert
- title: "CriticalSound"
path: /docs/reference/admin/node/admin.messaging.CriticalSound
- title: "Notification"
path: /docs/reference/admin/node/admin.messaging.Notification
- title: "WebpushConfig"
path: /docs/reference/admin/node/admin.messaging.WebpushConfig

- title: "admin.projectManagement"
path: /docs/reference/admin/node/admin.projectManagement
section:
- title: "AndroidApp"
path: /docs/reference/admin/node/admin.projectManagement.AndroidApp
- title: "AndroidAppMetadata"
path: /docs/reference/admin/node/admin.projectManagement.AndroidAppMetadata
- title: "IosApp"
path: /docs/reference/admin/node/admin.projectManagement.IosApp
- title: "IosAppMetadata"
path: /docs/reference/admin/node/admin.projectManagement.IosAppMetadata
- title: "ProjectManagement"
path: /docs/reference/admin/node/admin.projectManagement.ProjectManagement
- title: "ShaCertificate"
path: /docs/reference/admin/node/admin.projectManagement.ShaCertificate

- title: "admin.storage"
path: /docs/reference/admin/node/admin.storage
section:
- title: "Storage"
path: /docs/reference/admin/node/admin.storage.Storage
Loading