docs: common with @publicApi tags (#26595)

PR Close #26595
This commit is contained in:
Pete Bacon Darwin
2018-10-19 15:06:08 +01:00
committed by Alex Rickabaugh
parent 42c331bbf2
commit 0918adf39d
43 changed files with 87 additions and 97 deletions

View File

@ -11,7 +11,7 @@ import {HttpHeaders} from './headers';
/**
* Type enumeration for the different kinds of `HttpEvent`.
*
*
* @publicApi
*/
export enum HttpEventType {
/**
@ -48,7 +48,7 @@ export enum HttpEventType {
/**
* Base interface for progress events.
*
*
* @publicApi
*/
export interface HttpProgressEvent {
/**
@ -71,7 +71,7 @@ export interface HttpProgressEvent {
/**
* A download progress event.
*
*
* @publicApi
*/
export interface HttpDownloadProgressEvent extends HttpProgressEvent {
type: HttpEventType.DownloadProgress;
@ -98,7 +98,7 @@ export interface HttpUploadProgressEvent extends HttpProgressEvent {
* when a request may be retried multiple times, to distinguish between
* retries on the final event stream.
*
*
* @publicApi
*/
export interface HttpSentEvent { type: HttpEventType.Sent; }
@ -108,7 +108,7 @@ export interface HttpSentEvent { type: HttpEventType.Sent; }
* Grouping all custom events under this type ensures they will be handled
* and forwarded by all implementations of interceptors.
*
*
* @publicApi
*/
export interface HttpUserEvent<T> { type: HttpEventType.User; }
@ -130,7 +130,7 @@ export interface HttpJsonParseError {
*
* Typed according to the expected type of the response.
*
*
* @publicApi
*/
export type HttpEvent<T> =
HttpSentEvent | HttpHeaderResponse | HttpResponse<T>| HttpProgressEvent | HttpUserEvent<T>;
@ -138,7 +138,7 @@ export type HttpEvent<T> =
/**
* Base class for both `HttpResponse` and `HttpHeaderResponse`.
*
*
* @publicApi
*/
export abstract class HttpResponseBase {
/**
@ -207,7 +207,7 @@ export abstract class HttpResponseBase {
* `HttpHeaderResponse` is a `HttpEvent` available on the response
* event stream, only when progress events are requested.
*
*
* @publicApi
*/
export class HttpHeaderResponse extends HttpResponseBase {
/**
@ -248,7 +248,7 @@ export class HttpHeaderResponse extends HttpResponseBase {
* `HttpResponse` is a `HttpEvent` available on the response event
* stream.
*
*
* @publicApi
*/
export class HttpResponse<T> extends HttpResponseBase {
/**
@ -298,7 +298,7 @@ export class HttpResponse<T> extends HttpResponseBase {
* will contain either a wrapped Error object or the error response returned
* from the server.
*
*
* @publicApi
*/
export class HttpErrorResponse extends HttpResponseBase implements Error {
readonly name = 'HttpErrorResponse';