Class NavApiError

Raised when NAV replies with a GeneralErrorResponse, or with any other non-success HTTP status.

Hierarchy (View Summary)

NavError
- NavApiError

Index

Constructors

Properties

errorCode? funcCode? responseBody status validationMessages

Constructors

constructor

new NavApiError(
    init: {
        errorCode?: string;
        funcCode?: string;
        message: string;
        responseBody?: string;
        status: number;
        validationMessages?: NavValidationMessage[];
    },
): NavApiError
Parameters
- init: {
      errorCode?: string;
      funcCode?: string;
      message: string;
      responseBody?: string;
      status: number;
      validationMessages?: NavValidationMessage[];
  }
Returns NavApiError
Overrides NavError.constructor
- Defined in packages/core/src/errors.ts:55

Properties

`Optional` `Readonly`errorCode

errorCode?: string

result/errorCode, e.g. INVALID_SECURITY_USER.

`Optional` `Readonly`funcCode

funcCode?: string

result/funcCode, e.g. ERROR.

`Readonly`responseBody

responseBody: string

Raw response body, kept for logging and bug reports.

`Readonly`status

status: number

HTTP status code of the response.

`Readonly`validationMessages

validationMessages: NavValidationMessage[]

Validation messages NAV attached to the error.