Optional
message: stringReadonly
codeA code that identifies this error.
Possible values are names of errors, like NotFound
,
or Unknown
for unspecified errors from the language model itself. In the latter case the
cause
-property will contain the actual error.
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
BlockedThe requestor is blocked from using this language model.
Optional
message: stringStatic
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
NoThe requestor does not have permissions to use this language model
Optional
message: stringStatic
NotStatic
prepare
An error type for language model specific errors.
Consumers of language models should check the code property to determine specific failure causes, like
if(someError.code === vscode.LanguageModelError.NotFound.name) {...}
for the case of referring to an unknown language model. For unspecified errors thecause
-property will contain the actual error.Stubbed