Class YSweetError

An error returned by the y-sweet SDK.

Hierarchy

Error
- YSweetError

Index

Constructors

Properties

cause message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace fromMessage getMessage

Constructors

constructor

new YSweetError(cause): YSweetError
Create a new YSweetError.
Parameters
- cause: YSweetErrorPayload
  An object representing metadata associated with the error.
Returns YSweetError
See
YSweetErrorPayload
Overrides Error.constructor
- Defined in src/error.ts:17

Properties

cause

cause: YSweetErrorPayload

An object representing metadata associated with the error.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

- (err, stackTraces): any
- Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

`Static` fromMessage

fromMessage(messageString): YSweetError
In development, next.js passes error objects to the client but strips out everything but the message field. This method allows us to reconstruct the original error object.
Parameters
- messageString: string
  The error message string to reconstruct a payload from.
Returns YSweetError
A YSweetError object.

See
Next.js docs
- Defined in src/error.ts:55

`Static` getMessage

getMessage(payload): string
Convert the message to an error string that can be displayed to the user.

The error string can also be used with YSweetError.fromMessage to reconstruct the payload object, which is useful in the context of Next.js, which will only pass an error string from the server to the client.
Parameters
- payload: YSweetErrorPayload
  The payload object to convert to a string.
Returns string
A string representation of the error.
- Defined in src/error.ts:31