Class FileSizeError

An error that will be created if a user tries to upload a file that is either:

less than the FileValidationOptions.minFileSize
greater than the FileValidationOptions.maxFileSize
including the file would be greater than the FileValidationOptions.totalFileSize

remarks: @since 2.9.0

Hierarchy

GenericFileError
- FileSizeError

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileSizeError(files: readonly File[], type: "max" | "min" | "total", limit: number): FileSizeError

Overrides GenericFileError.constructor
- Defined in packages/form/src/file-input/utils.ts:143
Parameters
- files: readonly File[]
  
  The list of files that have the file size error
- type: "max" | "min" | "total"
  
  The file size error type
- limit: number
  
  The number of bytes allowed based on the type
Returns FileSizeError

Properties

files

files: readonly File[]

key

key: string

A unique key generated by nanoid that can be used as a React key

limit

limit: number

message

message: string

name

name: string

Optional reason

reason: string

Optional stack

stack: string

type

type: "max" | "min" | "total"

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

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

Inherited from GenericFileError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4
Create .stack property on a target object

Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void

Static Optional prepareStackTrace

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Inherited from GenericFileError.prepareStackTrace
- Defined in node_modules/@types/node/globals.d.ts:11
Optional override for formatting stack traces

see

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

Parameters
- err: Error
- stackTraces: CallSite[]
Returns any

Generated using TypeDoc