Creates a new filesystem error.
Optional
messageOrUri: string | UriMessage or uri.
Readonly
codeA code that identifies this error.
Possible values are names of errors, like FileNotFound
,
or Unknown
for unspecified errors.
Optional
stackStatic
stackThe 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.
Static
captureCreates a .stack
property on targetObject
, which when accessed returns
a string representing the location in the code at which
Error.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 constructorOpt
argument accepts a function. If given, all frames
above constructorOpt
, including constructorOpt
, will be omitted from the
generated stack trace.
The constructorOpt
argument 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();
Optional
constructorOpt: FunctionStatic
FileCreate an error to signal that a file or folder already exists, e.g. when creating but not overwriting a file.
Optional
messageOrUri: string | UriMessage or uri.
Static
FileCreate an error to signal that a file is a folder.
Optional
messageOrUri: string | UriMessage or uri.
Static
FileCreate an error to signal that a file is not a folder.
Optional
messageOrUri: string | UriMessage or uri.
Static
FileCreate an error to signal that a file or folder wasn't found.
Optional
messageOrUri: string | UriMessage or uri.
Static
NoCreate an error to signal that an operation lacks required permissions.
Optional
messageOrUri: string | UriMessage or uri.
Static
prepareStatic
UnavailableCreate an error to signal that the file system is unavailable or too busy to complete a request.
Optional
messageOrUri: string | UriMessage or uri.
A type that filesystem providers should use to signal errors.
This class has factory methods for common error-cases, like
FileNotFound
when a file or folder doesn't exist, use them like so:throw vscode.FileSystemError.FileNotFound(someUri);