UnimplementedErrorclass

new UnimplementedError(message?: string, options: BaseErrorOptions = {})
ParamType
messagestring
Optional human-readable description of the missing implementation.
optionsBaseErrorOptions
Options for BaseError that provide additional helpful error functionality. Defaults to {}
    .callerAnyCaller
Modify the stack to trim off lines after a certain calling function.
Return
UnimplementedError
Error thrown when functionality is called but is not implemented by an interface.

Error thrown when functionality is called but is not implemented by an interface.

Thrown when a method or feature is not implemented — for example an abstract method left for a subclass to override, or a provider stub that has not been filled in yet.

Usage

ts
import { UnimplementedError } from "shelving/error";

class BaseProvider {
  save(): Promise<void> {
    throw new UnimplementedError("save() is not implemented");
  }
}

See shelving/error for shared behaviour — attaching context fields, caller trimming, and catching by type.

Examples

throw new UnimplementedError("Not supported by this provider");