Atlas

Appearance

Class: NotAnEmailError ​

Defined in: packages/errors/src/index.ts:62

Error thrown when provided email is invalid or not allowed.

Example ​

typescript
if (!isValidEmail(email)) {
  throw new NotAnEmailError('Registration not possible', {
    cause: 'Invalid email format'
  });
}

Extends ​

Constructors ​

Constructor ​

new NotAnEmailError(message?, opts?): NotAnEmailError

Defined in: packages/errors/src/index.ts:63

Parameters ​

message? ​

string = 'Registration not possible'

opts? ​

ErrorOptions

Returns ​

NotAnEmailError

Overrides ​

ApplicationError.constructor

Properties ​

cause ​

readonly cause: string | undefined

Defined in: packages/errors/src/base.ts:28

Human-readable cause of the error

Inherited from ​

ApplicationError.cause

code ​

readonly code: string

Defined in: packages/errors/src/base.ts:24

Machine-readable error code

Inherited from ​

ApplicationError.code

details? ​

readonly optional details?: unknown

Defined in: packages/errors/src/base.ts:30

Additional details for debugging

Inherited from ​

ApplicationError.details

httpStatus ​

readonly httpStatus: number

Defined in: packages/errors/src/base.ts:26

HTTP status code

Inherited from ​

ApplicationError.httpStatus

message ​

message: string

Defined in: node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from ​

ApplicationError.message

name ​

name: string

Defined in: node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from ​

ApplicationError.name

stack? ​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

ApplicationError.stack