5 lines
30 KiB
JSON
5 lines
30 KiB
JSON
{
|
|
"id": "api/common/http/HttpErrorResponse",
|
|
"title": "HttpErrorResponse",
|
|
"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/HttpErrorResponse\", \"name\": \"HttpErrorResponse\" } }\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...#L305-L350\" 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#L305-L350\" 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=\"httperrorresponse\">HttpErrorResponse<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpErrorResponse#httperrorresponse\"><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>A response that represents an error or failure, either from a\nnon-successful HTTP status, an error while executing the request,\nor some other failure which occurred during the parsing of the response.</p>\n\n <p><a href=\"api/common/http/HttpErrorResponse#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/common/http/HttpErrorResponse\" class=\"code-anchor\">HttpErrorResponse</a> extends <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase\">HttpResponseBase</a> implements <a class=\"code-anchor\" href=\"\">Error</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpErrorResponse#constructor()\"><span class=\"member-name\">constructor</span>(init: { error?: any; headers?: HttpHeaders; status?: number; statusText?: string; url?: string; })</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpErrorResponse#name\"><span class=\"member-name\">name</span>: 'HttpErrorResponse'</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpErrorResponse#message\"><span class=\"member-name\">message</span>: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpErrorResponse#error\"><span class=\"member-name\">error</span>: any | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpErrorResponse#ok\"><span class=\"member-name\">ok</span>: false</a>\n\n // inherited from <a class=\"code-anchor\" href=\"api/common/http/HttpResponseBase\">common/http/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\n</section>\n\n\n \n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpErrorResponse#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>Any error returned on the <code>Observable</code> response stream will be\nwrapped in an <code><a href=\"api/common/http/HttpErrorResponse\" class=\"code-anchor\">HttpErrorResponse</a></code> to provide additional context about\nthe state of the HTTP layer when the error occurred. The error property\nwill contain either a wrapped Error object or the error response returned\nfrom the server.</p>\n\n \n</section>\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/HttpErrorResponse#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 \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: { error?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; status?: number; statusText?: string; url?: string; })</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 </tbody>\n</table>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \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/HttpErrorResponse#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=\"name\"></a>\n <code class=\"\"><span class=\"member-name\">name</span>: '<a href=\"api/common/http/HttpErrorResponse\" class=\"code-anchor\">HttpErrorResponse</a>'</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"message\"></a>\n <code class=\"\"><span class=\"member-name\">message</span>: string</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"error\"></a>\n <code class=\"\"><span class=\"member-name\">error</span>: any | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \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>: false</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Errors are never okay, even when the status code is in the 2xx success range.</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/HttpResponseBase\n - api/common/http/testing/TestRequest\n - guide/http\n - guide/testing-services\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/http\n - api/common/http/HttpErrorResponse#constructor\n - api/common/http/HttpErrorResponse#constructor()\n - api/common/http/HttpErrorResponse#description\n - api/common/http/HttpErrorResponse#error\n - api/common/http/HttpErrorResponse#httperrorresponse\n - api/common/http/HttpErrorResponse#message\n - api/common/http/HttpErrorResponse#name\n - api/common/http/HttpErrorResponse#ok\n - api/common/http/HttpErrorResponse#properties\n - api/common/http/HttpHeaders\n - api/common/http/HttpResponseBase\n - api/common/http/HttpResponseBase#constructor()\n - api/common/http/HttpResponseBase#headers\n - api/common/http/HttpResponseBase#ok\n - api/common/http/HttpResponseBase#status\n - api/common/http/HttpResponseBase#statusText\n - api/common/http/HttpResponseBase#type\n - api/common/http/HttpResponseBase#url\n - https://github.com/angular/angular/edit/master/packages/common/http/src/response.ts?message=docs(common)%3A%20describe%20your%20change...#L305-L350\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/response.ts#L305-L350\n-->"
|
|
} |