Class InvalidFilenameError

Hierarchy

Error
- InvalidFilenameError

Index

Constructors

Properties

cause? message name stack?

Accessors

filename reason segment

Methods

Constructors

constructor

new InvalidFilenameError(
options: InvalidFilenameErrorOptions,
): InvalidFilenameError
Parameters
- options: InvalidFilenameErrorOptions
Returns InvalidFilenameError
Overrides Error.constructor
- Defined in utils/filename-validation.ts:45

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

Accessors

filename

get filename(): string
The filename that was validated

Returns string
- Defined in utils/filename-validation.ts:52

reason

get reason(): TInvalidFilenameErrorReason
Reason why the validation failed

Returns TInvalidFilenameErrorReason
- Defined in utils/filename-validation.ts:59

segment

get segment(): string
Part of the filename that caused this error

Returns string
- Defined in utils/filename-validation.ts:66

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