Class LoginError
Hierarchy
- Error
- LoginError
Properties
Optionalcause
The cause of the error.
Readonlyerrors
A list of connection errors that prevented the connection to the Archipelago server.
message
name
Optionalstack
StaticstackTraceLimit
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Methods
StaticcaptureStackTrace
-
Creates a
.stackproperty ontargetObject, which when accessed returns a string representing the location in the code at whichError.captureStackTrace()was called.const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.The optional
constructorOptargument accepts a function. If given, all frames aboveconstructorOpt, includingconstructorOpt, will be omitted from the generated stack trace.The
constructorOptargument is useful for hiding implementation details of error generation from the user. For instance:function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
- targetObject: object
OptionalconstructorOpt: Function
Returns void
-
Create .stack property on a target object
Parameters
- targetObject: object
OptionalconstructorOpt: Function
Returns void
StaticisError
-
Check if a value is an instance of Error
Parameters
- value: unknown
The value to check
Returns value is Error
True if the value is an instance of Error, false otherwise
- value: unknown
StaticprepareStackTrace
-
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
The
LoginErrorobject represents an error when attempting to log into an Archipelago session, but authentication failed. The server returns a list of known issues found while attempting to connect.