NodeAuthError class
- Extends
-
AuthError
Constructors
| Node |
Inherited Properties
| correlation |
CorrelationId associated with the error |
| error |
Short string denoting error |
| error |
Detailed description of error |
| message | |
| name | |
| stack | |
| sub |
Describes the subclass of an error |
Methods
| create |
Creates an error thrown if loopback server address is of type string. |
| create |
Creates an error thrown if a loopback server already exists when attempting to create another one. |
| create |
Creates an error thrown if the loopback server times out registering the auth code listener. |
| create |
Creates an error thrown if the server response does not contain an auth code. |
| create |
Creates an error thrown if the loopback server has not been spun up yet. |
| create |
Creates an error thrown when the state is not present. |
| create |
Creates an error thrown if the loopback server is unable to get a url. |
Inherited Methods
| create |
Creates an error for post request failures. |
| create |
Creates an error that is thrown when something unexpected happens in the library. |
| set |
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: stringProperty Value
string
Inherited From AuthError.correlationId
errorCode
Short string denoting error
errorCode: stringProperty Value
string
Inherited From AuthError.errorCode
errorMessage
Detailed description of error
errorMessage: stringProperty Value
string
Inherited From AuthError.errorMessage
message
message: stringProperty Value
string
Inherited From Error.message
name
name: stringProperty Value
string
Inherited From Error.name
stack
stack?: stringProperty Value
string
Inherited From Error.stack
subError
Describes the subclass of an error
subError: stringProperty Value
string
Inherited From AuthError.subError
Method Details
createInvalidLoopbackAddressTypeError()
Creates an error thrown if loopback server address is of type string.
static function createInvalidLoopbackAddressTypeError(): NodeAuthErrorReturns
createLoopbackServerAlreadyExistsError()
Creates an error thrown if a loopback server already exists when attempting to create another one.
static function createLoopbackServerAlreadyExistsError(): NodeAuthErrorReturns
createLoopbackServerTimeoutError()
Creates an error thrown if the loopback server times out registering the auth code listener.
static function createLoopbackServerTimeoutError(): NodeAuthErrorReturns
createNoAuthCodeInResponseError()
Creates an error thrown if the server response does not contain an auth code.
static function createNoAuthCodeInResponseError(): NodeAuthErrorReturns
createNoLoopbackServerExistsError()
Creates an error thrown if the loopback server has not been spun up yet.
static function createNoLoopbackServerExistsError(): NodeAuthErrorReturns
createStateNotFoundError()
Creates an error thrown when the state is not present.
static function createStateNotFoundError(): NodeAuthErrorReturns
createUnableToLoadRedirectUrlError()
Creates an error thrown if the loopback server is unable to get a url.
static function createUnableToLoadRedirectUrlError(): NodeAuthErrorReturns
Inherited Method Details
createPostRequestFailed(string)
Creates an error for post request failures.
static function createPostRequestFailed(errDesc: string): AuthErrorParameters
- 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): AuthErrorParameters
- errDesc
-
string
Returns
AuthError
Inherited From AuthError.createUnexpectedError
setCorrelationId(string)
function setCorrelationId(correlationId: string)Parameters
- correlationId
-
string
Inherited From AuthError.setCorrelationId