Class ApiError

Readonly_tag

Optionalcause

code

context

Readonlymessage

Readonlyname

Optionalstack

Staticcode

Static OptionalprepareStackTrace

StaticstackTraceLimit

StaticcaptureStackTrace

• captureStackTrace(targetObject: object, constructorOpt?: Function): void

  Parameters

  • targetObject: object
  • OptionalconstructorOpt: Function

  Returns void

Staticextend

• extend<Code extends string = string>(code: Code, message?: string): any

  Type Parameters

  • Code extends string = string

  Parameters

  • code: Code
  • Optionalmessage: string

  Returns any

Staticis

• is(error: unknown): error is BaseError<string>

  Parameters

  • error: unknown

  Returns error is BaseError<string>

StaticisError

• isError(error: unknown): error is Error

  Parameters

  • error: unknown

  Returns error is Error

Staticwrap

• wrap(
      options?: Omit<BaseErrorOptions, "cause"> & { ifTypeDiffers?: boolean },
  ): (
      error: unknown,
  ) => {
      _tag: "API";
      cause?: unknown;
      code: "API";
      context: Record<string, unknown>;
      message: string;
      name: "API";
      stack?: string;
  }

  Parameters

  • Optionaloptions: Omit<BaseErrorOptions, "cause"> & { ifTypeDiffers?: boolean }

  Returns (
      error: unknown,
  ) => {
      _tag: "API";
      cause?: unknown;
      code: "API";
      context: Record<string, unknown>;
      message: string;
      name: "API";
      stack?: string;
  }