Adding TypeDoc comments for Admin and Storage. #509
Conversation
|
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
|
Closing due to CLA issue with new machine. Seems simpler to just re-create the request from scratch. |
| code: string; | ||
| /** |
There was a problem hiding this comment.
Lets add some spacing here, to separate it from the previous block. Here and elsewhere.
| @@ -86,6 +262,21 @@ declare namespace admin.app { | |||
| messaging(): admin.messaging.Messaging; | |||
| projectManagement(): admin.projectManagement.ProjectManagement; | |||
| storage(): admin.storage.Storage; | |||
| /** | |||
| * Renders this app unusable and frees the resources of all associated | |||
| * services. | |||
There was a problem hiding this comment.
Couple of developers have pointed out that we should explain this method a bit more in our documentation (see #489 for example). Can we add a line here indicating that when running the SDK locally, this method must be called to ensure graceful termination of the process?
| @@ -703,6 +902,35 @@ declare namespace admin.instanceId { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
This should be added to the projectManagement() method above to avoid repeating: https://firebase-dot-devsite.googleplex.com/docs/reference/admin/node/admin.projectManagement
Here are a couple of the first areas of coverage for our eventual TypeDoc generation scheme.
Staged at:
https://firebase-dot-devsite.googleplex.com/docs/reference/admin/node/admin
https://firebase-dot-devsite.googleplex.com/docs/reference/admin/node/admin.storage
Thanks!