5 lines
31 KiB
JSON
5 lines
31 KiB
JSON
{
|
|
"id": "api/common/http/HttpResponseBase",
|
|
"title": "HttpResponseBase",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/common\", \"name\": \"@angular/common\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/http\", \"name\": \"@angular/common/http\" } },\n { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/common/http/HttpResponseBase\", \"name\": \"HttpResponseBase\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a> > <a href=\"api/common/http\">@angular/common/http</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/response.ts?message=docs(common)%3A%20describe%20your%20change...#L141-L205\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/response.ts#L141-L205\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"httpresponsebase\">HttpResponseBase<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpResponseBase#httpresponsebase\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Base class for both <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> and <code><a href=\"api/common/http/HttpHeaderResponse\" class=\"code-anchor\">HttpHeaderResponse</a></code>.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/common/http/HttpResponseBase\" class=\"code-anchor\">HttpResponseBase</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#constructor()\"><span class=\"member-name\">constructor</span>(init: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string; }, defaultStatus: number = HttpStatusCode.Ok, defaultStatusText: string = 'OK')</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#headers\"><span class=\"member-name\">headers</span>: HttpHeaders</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#status\"><span class=\"member-name\">status</span>: number</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#statusText\"><span class=\"member-name\">statusText</span>: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#url\"><span class=\"member-name\">url</span>: string | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#ok\"><span class=\"member-name\">ok</span>: boolean</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase#type\"><span class=\"member-name\">type</span>: HttpEventType.Response | HttpEventType.ResponseHeader</a>\n}\n</code-example>\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"subclasses\">Subclasses<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpResponseBase#subclasses\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/common/http/HttpErrorResponse\" class=\"code-anchor\">HttpErrorResponse</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/common/http/HttpHeaderResponse\" class=\"code-anchor\">HttpHeaderResponse</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </div>\n \n\n</section>\n\n\n \n\n \n \n \n\n\n\n\n\n\n<h2 id=\"constructor\">Constructor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpResponseBase#constructor\"><i class=\"material-icons\">link</i></a></h2>\n<a id=\"constructor()\"></a>\n<table class=\"is-full-width method-table constructor\">\n \n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Super-constructor for all responses.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(init: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; status?: number; statusText?: string; url?: string; }, defaultStatus: number = <a href=\"api/common/http/HttpStatusCode#Ok\" class=\"code-anchor\">HttpStatusCode.Ok</a>, defaultStatusText: string = 'OK')</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>init</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>defaultStatus</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a></code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code><a href=\"api/common/http/HttpStatusCode#Ok\" class=\"code-anchor\">HttpStatusCode.Ok</a></code>.</p>\n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>defaultStatusText</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>'OK'</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n <tr>\n <td class=\"description\">\n <p>The single parameter accepted is an initialization hash. Any properties\nof the response passed there will override the default values.</p>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n\n\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpResponseBase#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"headers\"></a>\n <code class=\"\"><span class=\"member-name\">headers</span>: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>All response headers.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"status\"></a>\n <code class=\"\"><span class=\"member-name\">status</span>: number</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Response status code.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"statusText\"></a>\n <code class=\"\"><span class=\"member-name\">statusText</span>: string</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Textual description of response status code, defaults to OK.</p>\n\n <p>Do not depend on this.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"url\"></a>\n <code class=\"\"><span class=\"member-name\">url</span>: string | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>URL of the resource retrieved, or null if not available.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"ok\"></a>\n <code class=\"\"><span class=\"member-name\">ok</span>: boolean</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Whether the status code falls in the 2xx range.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"type\"></a>\n <code class=\"\"><span class=\"member-name\">type</span>: <a href=\"api/common/http/HttpEventType#Response\" class=\"code-anchor\">HttpEventType.Response</a> | <a href=\"api/common/http/HttpEventType#ResponseHeader\" class=\"code-anchor\">HttpEventType.ResponseHeader</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Type of the response, narrowed to either the full response or the header.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/common/http\n - api/common/http/HttpErrorResponse\n - api/common/http/HttpHeaderResponse\n - api/common/http/HttpResponse\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/DecimalPipe\n - api/common/http\n - api/common/http/HttpErrorResponse\n - api/common/http/HttpEventType#Response\n - api/common/http/HttpEventType#ResponseHeader\n - api/common/http/HttpHeaderResponse\n - api/common/http/HttpHeaders\n - api/common/http/HttpResponse\n - api/common/http/HttpResponseBase#constructor\n - api/common/http/HttpResponseBase#constructor()\n - api/common/http/HttpResponseBase#headers\n - api/common/http/HttpResponseBase#httpresponsebase\n - api/common/http/HttpResponseBase#ok\n - api/common/http/HttpResponseBase#properties\n - api/common/http/HttpResponseBase#status\n - api/common/http/HttpResponseBase#statusText\n - api/common/http/HttpResponseBase#subclasses\n - api/common/http/HttpResponseBase#type\n - api/common/http/HttpResponseBase#url\n - api/common/http/HttpStatusCode#Ok\n - https://github.com/angular/angular/edit/master/packages/common/http/src/response.ts?message=docs(common)%3A%20describe%20your%20change...#L141-L205\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/response.ts#L141-L205\n-->"
|
|
} |