Minor JSDoc tweaks

This commit is contained in:
Adam Harvey
2020-12-10 16:03:25 -05:00
parent 3e981aa51d
commit 26518c1d68
3 changed files with 4 additions and 5 deletions
@@ -31,7 +31,7 @@ export type DiscoveryApi = {
/**
* Returns the HTTP base backend URL for a given plugin, without a trailing slash.
*
* This method must always be called just before making a request. as opposed to
* This method must always be called just before making a request, as opposed to
* fetching the URL when constructing an API client. That is to ensure that more
* flexible routing patterns can be supported.
*
@@ -42,10 +42,10 @@ export type ErrorContext = {
* to report errors for collection by error reporting services.
*
* If an error can be displayed inline, e.g. as feedback in a form, that should be
* preferred over relying on this API to display the error. The main use of this api
* preferred over relying on this API to display the error. The main use of this API
* for displaying errors should be for asynchronous errors, such as a failing background process.
*
* Even if an error is displayed inline, it should still be reported through this api
* Even if an error is displayed inline, it should still be reported through this API
* if it would be useful to collect or log it for debugging purposes, but with
* the hidden flag set. For example, an error arising from form field validation
* should probably not be reported, while a failed REST call would be useful to report.
@@ -30,6 +30,7 @@ export type IdentityApi = {
*/
getUserId(): string;
// TODO: getProfile(): Promise<Profile> - We want this to be async when added, but needs more work.
/**
* The profile of the signed in user.
*/
@@ -43,8 +44,6 @@ export type IdentityApi = {
*/
getIdToken(): Promise<string | undefined>;
// TODO: getProfile(): Promise<Profile> - We want this to be async when added, but needs more work.
/**
* Sign out the current user
*/