NodeAuthError class

Package:

@azure/msal-node

Extends

AuthError

Constructors

NodeAuthError(string, string)

Inherited Properties

correlationId	CorrelationId associated with the error
errorCode	Short string denoting error
errorMessage	Detailed description of error
message
name
stack
subError	Describes the subclass of an error

Methods

createInvalidLoopbackAddressTypeError()	Creates an error thrown if loopback server address is of type string.
createLoopbackServerAlreadyExistsError()	Creates an error thrown if a loopback server already exists when attempting to create another one.
createLoopbackServerTimeoutError()	Creates an error thrown if the loopback server times out registering the auth code listener.
createNoAuthCodeInResponseError()	Creates an error thrown if the server response does not contain an auth code.
createNoLoopbackServerExistsError()	Creates an error thrown if the loopback server has not been spun up yet.
createStateNotFoundError()	Creates an error thrown when the state is not present.
createUnableToLoadRedirectUrlError()	Creates an error thrown if the loopback server is unable to get a url.

Inherited Methods

createPostRequestFailed(string)	Creates an error for post request failures.
createUnexpectedError(string)	Creates an error that is thrown when something unexpected happens in the library.
setCorrelationId(string)

Constructor Details

NodeAuthError(string, string)

new NodeAuthError(errorCode: string, errorMessage?: string)

Parameters

errorCode

string

errorMessage

string

Inherited Property Details

correlationId

CorrelationId associated with the error

correlationId: string

Property Value

string

Inherited From AuthError.correlationId

errorCode

Short string denoting error

errorCode: string

Property Value

string

Inherited From AuthError.errorCode

errorMessage

Detailed description of error

errorMessage: string

Property Value

string

Inherited From AuthError.errorMessage

message

message: string

Property Value

string

Inherited From Error.message

name

name: string

Property Value

string

Inherited From Error.name

stack

stack?: string

Property Value

string

Inherited From Error.stack

subError

Describes the subclass of an error

subError: string

Property Value

string

Inherited From AuthError.subError

Method Details

createInvalidLoopbackAddressTypeError()

Creates an error thrown if loopback server address is of type string.

static function createInvalidLoopbackAddressTypeError(): NodeAuthError

Returns

NodeAuthError

createLoopbackServerAlreadyExistsError()

Creates an error thrown if a loopback server already exists when attempting to create another one.

static function createLoopbackServerAlreadyExistsError(): NodeAuthError

Returns

NodeAuthError

createLoopbackServerTimeoutError()

Creates an error thrown if the loopback server times out registering the auth code listener.

static function createLoopbackServerTimeoutError(): NodeAuthError

Returns

NodeAuthError

createNoAuthCodeInResponseError()

Creates an error thrown if the server response does not contain an auth code.

static function createNoAuthCodeInResponseError(): NodeAuthError

Returns

NodeAuthError

createNoLoopbackServerExistsError()

Creates an error thrown if the loopback server has not been spun up yet.

static function createNoLoopbackServerExistsError(): NodeAuthError

Returns

NodeAuthError

createStateNotFoundError()

Creates an error thrown when the state is not present.

static function createStateNotFoundError(): NodeAuthError

Returns

NodeAuthError

createUnableToLoadRedirectUrlError()

Creates an error thrown if the loopback server is unable to get a url.

static function createUnableToLoadRedirectUrlError(): NodeAuthError

Returns

NodeAuthError

Inherited Method Details

createPostRequestFailed(string)

Creates an error for post request failures.

static function createPostRequestFailed(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createPostRequestFailed

createUnexpectedError(string)

Creates an error that is thrown when something unexpected happens in the library.

static function createUnexpectedError(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createUnexpectedError

setCorrelationId(string)

function setCorrelationId(correlationId: string)

Parameters

correlationId

string

Inherited From AuthError.setCorrelationId