Class FtSerializationException

Exception thrown during fielded text serialization/deserialization.

Hierarchy

Error
- FtSerializationException

Index

Constructors

Properties

cause? message name stack?

Accessors

error fieldIndex fieldName sequenceItemIndex sequenceName

Methods

Constructors

constructor

new FtSerializationException(
    error: FtSerializationError,
    fieldOrMessage: string | FtField | undefined,
    messageOrInner?: string | Error,
    innerException?: Error,
): FtSerializationException
Parameters
- error: FtSerializationError
- fieldOrMessage: string | FtField | undefined
- OptionalmessageOrInner: string | Error
- OptionalinnerException: Error
Returns FtSerializationException
Overrides Error.constructor
- Defined in lib/src/types/errors/ft-serialization-exception.ts:15

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

Accessors

error

get error(): FtSerializationError
Returns FtSerializationError
- Defined in lib/src/types/errors/ft-serialization-exception.ts:67

fieldIndex

get fieldIndex(): number
Returns number
- Defined in lib/src/types/errors/ft-serialization-exception.ts:75

fieldName

get fieldName(): string | undefined
Returns string | undefined
- Defined in lib/src/types/errors/ft-serialization-exception.ts:71

sequenceItemIndex

get sequenceItemIndex(): number
Returns number
- Defined in lib/src/types/errors/ft-serialization-exception.ts:83

sequenceName

get sequenceName(): string | undefined
Returns string | undefined
- Defined in lib/src/types/errors/ft-serialization-exception.ts:79

Methods

`Static`isError

isError(error: unknown): error is Error
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
- error: unknown
Returns error is Error
Inherited from Error.isError
- Defined in node_modules/typescript/lib/lib.esnext.error.d.ts:21