@rxap/open-api
Version:
This package provides tools for working with OpenAPI specifications in Angular applications. It includes services for configuring and loading OpenAPI definitions, validating requests and responses against schemas, and handling errors. It also offers utili
202 lines (101 loc) • 4.33 kB
Markdown
[@rxap/open-api](../wiki/globals) / OpenApiHttpResponseError
# Class: OpenApiHttpResponseError
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:4](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L4)
## Extends
- `HttpErrorResponse`
## Constructors
### new OpenApiHttpResponseError()
> **new OpenApiHttpResponseError**(`httpErrorResponse`, `metadata`): [`OpenApiHttpResponseError`](../wiki/Class.OpenApiHttpResponseError)
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:6](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L6)
#### Parameters
##### httpErrorResponse
`HttpErrorResponse`
##### metadata
[`OpenApiMetaData`](../wiki/Interface.OpenApiMetaData)
#### Returns
[`OpenApiHttpResponseError`](../wiki/Class.OpenApiHttpResponseError)
#### Overrides
`HttpErrorResponse.constructor`
## Properties
### error
> `readonly` **error**: `any`
Defined in: node\_modules/@angular/common/http/index.d.ts:3370
#### Inherited from
`HttpErrorResponse.error`
***
### headers
> `readonly` **headers**: `HttpHeaders`
Defined in: node\_modules/@angular/common/http/index.d.ts:4102
All response headers.
#### Inherited from
`HttpErrorResponse.headers`
***
### httpErrorResponse
> `readonly` **httpErrorResponse**: `HttpErrorResponse`
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:7](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L7)
***
### message
> `readonly` **message**: `string`
Defined in: node\_modules/@angular/common/http/index.d.ts:3369
#### Inherited from
`HttpErrorResponse.message`
***
### metadata
> `readonly` **metadata**: [`OpenApiMetaData`](../wiki/Interface.OpenApiMetaData)
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:8](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L8)
***
### name
> `readonly` **name**: `"HttpErrorResponse"` = `"HttpErrorResponse"`
Defined in: node\_modules/@angular/common/http/index.d.ts:3368
#### Inherited from
`HttpErrorResponse.name`
***
### ok
> `readonly` **ok**: `false` = `false`
Defined in: node\_modules/@angular/common/http/index.d.ts:3374
Errors are never okay, even when the status code is in the 2xx success range.
#### Inherited from
`HttpErrorResponse.ok`
***
### status
> `readonly` **status**: `number`
Defined in: node\_modules/@angular/common/http/index.d.ts:4106
Response status code.
#### Inherited from
`HttpErrorResponse.status`
***
### statusText
> `readonly` **statusText**: `string`
Defined in: node\_modules/@angular/common/http/index.d.ts:4112
Textual description of response status code, defaults to OK.
Do not depend on this.
#### Inherited from
`HttpErrorResponse.statusText`
***
### type
> `readonly` **type**: `ResponseHeader` \| `Response`
Defined in: node\_modules/@angular/common/http/index.d.ts:4124
Type of the response, narrowed to either the full response or the header.
#### Inherited from
`HttpErrorResponse.type`
***
### url
> `readonly` **url**: `null` \| `string`
Defined in: node\_modules/@angular/common/http/index.d.ts:4116
URL of the resource retrieved, or null if not available.
#### Inherited from
`HttpErrorResponse.url`
## Accessors
### operationId
#### Get Signature
> **get** **operationId**(): `string`
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:23](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L23)
##### Returns
`string`
***
### serverId
#### Get Signature
> **get** **serverId**(): `undefined` \| `string`
Defined in: [packages/angular/open-api/src/lib/open-api-http-response.error.ts:27](https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/open-api/src/lib/open-api-http-response.error.ts#L27)
##### Returns
`undefined` \| `string`