@rxap/ngx-error
Version:
This package provides a comprehensive error handling solution for Angular applications, including interceptors, services, and UI components to display different types of errors in a user-friendly dialog. It supports handling of generic errors, HTTP errors
208 lines (104 loc) • 6.92 kB
Markdown
[**/ngx-error v19.2.0**](../README.md)
***
[/ngx-error](../globals.md) / OpenApiHttpResponseErrorDialogData
# Interface: OpenApiHttpResponseErrorDialogData
Defined in: [open-api-http-response-error/open-api-http-response-error-dialog-data.ts:4](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/open-api-http-response-error/open-api-http-response-error-dialog-data.ts#L4)
## Extends
- [`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md)
## Properties
### body?
> `optional` **body**: `any`
Defined in: [any-http-error/any-http-error-dialog-data.ts:8](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L8)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`body`](AnyHttpErrorDialogData.md#body)
***
### error
> **error**: `any`
Defined in: [any-http-error/any-http-error-dialog-data.ts:10](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L10)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`error`](AnyHttpErrorDialogData.md#error)
***
### headers
> **headers**: `Record`\<`string`, `string`[]\>
Defined in: [any-http-error/any-http-error-dialog-data.ts:17](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L17)
All response headers.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`headers`](AnyHttpErrorDialogData.md#headers)
***
### message
> **message**: `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:11](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L11)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`message`](AnyHttpErrorDialogData.md#message)
***
### metadata
> **metadata**: `OpenApiMetaData`
Defined in: [open-api-http-response-error/open-api-http-response-error-dialog-data.ts:5](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/open-api-http-response-error/open-api-http-response-error-dialog-data.ts#L5)
***
### method
> **method**: `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:7](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L7)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`method`](AnyHttpErrorDialogData.md#method)
***
### name
> **name**: `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:12](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L12)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`name`](AnyHttpErrorDialogData.md#name)
***
### ok
> **ok**: `boolean`
Defined in: [any-http-error/any-http-error-dialog-data.ts:35](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L35)
Whether the status code falls in the 2xx range.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`ok`](AnyHttpErrorDialogData.md#ok)
***
### operationId
> **operationId**: `string`
Defined in: [open-api-http-response-error/open-api-http-response-error-dialog-data.ts:6](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/open-api-http-response-error/open-api-http-response-error-dialog-data.ts#L6)
***
### serverId?
> `optional` **serverId**: `string`
Defined in: [open-api-http-response-error/open-api-http-response-error-dialog-data.ts:7](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/open-api-http-response-error/open-api-http-response-error-dialog-data.ts#L7)
***
### stack?
> `optional` **stack**: `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:9](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L9)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`stack`](AnyHttpErrorDialogData.md#stack)
***
### status
> **status**: `number`
Defined in: [any-http-error/any-http-error-dialog-data.ts:21](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L21)
Response status code.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`status`](AnyHttpErrorDialogData.md#status)
***
### statusText
> **statusText**: `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:27](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L27)
Textual description of response status code, defaults to OK.
Do not depend on this.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`statusText`](AnyHttpErrorDialogData.md#statustext)
***
### timestamp
> **timestamp**: `number`
Defined in: [any-http-error/any-http-error-dialog-data.ts:13](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L13)
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`timestamp`](AnyHttpErrorDialogData.md#timestamp)
***
### type
> **type**: `ResponseHeader` \| `Response`
Defined in: [any-http-error/any-http-error-dialog-data.ts:39](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L39)
Type of the response, narrowed to either the full response or the header.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`type`](AnyHttpErrorDialogData.md#type)
***
### url
> **url**: `null` \| `string`
Defined in: [any-http-error/any-http-error-dialog-data.ts:31](https://gitlab.com/rxap/packages/-/blob/36b0e9732b24717840935712e316593ff6aba795/packages/angular/error/src/lib/any-http-error/any-http-error-dialog-data.ts#L31)
URL of the resource retrieved, or null if not available.
#### Inherited from
[`AnyHttpErrorDialogData`](AnyHttpErrorDialogData.md).[`url`](AnyHttpErrorDialogData.md#url)