Skip to main content

fileValidationHelper

Workspace API


Workspace API / helpers/fileValidationHelper

helpers/fileValidationHelper

Interfaces

FileValidationResult

Defined in: helpers/fileValidationHelper.ts:13

Properties

valid

valid: boolean

Defined in: helpers/fileValidationHelper.ts:14

error?

optional error: string

Defined in: helpers/fileValidationHelper.ts:15

sanitizedFilename?

optional sanitizedFilename: string

Defined in: helpers/fileValidationHelper.ts:16

fileSize?

optional fileSize: number

Defined in: helpers/fileValidationHelper.ts:17

contentType?

optional contentType: string

Defined in: helpers/fileValidationHelper.ts:18

Functions

validateFileUpload()

validateFileUpload(filename, contentType, fileSize, log): FileValidationResult

Defined in: helpers/fileValidationHelper.ts:24

Validate file upload request

Parameters

filename

string

contentType

string

fileSize

number

log

Logger = logger

Returns

FileValidationResult


sanitizeFilename()

sanitizeFilename(filename): string

Defined in: helpers/fileValidationHelper.ts:100

Sanitize filename to prevent security issues

Parameters

filename

string

Returns

string


containsPathTraversal()

containsPathTraversal(filename): boolean

Defined in: helpers/fileValidationHelper.ts:132

Check if filename contains path traversal attempts

Parameters

filename

string

Returns

boolean


containsExecutableExtension()

containsExecutableExtension(filename): boolean

Defined in: helpers/fileValidationHelper.ts:151

Check if filename has executable extension

Parameters

filename

string

Returns

boolean


getFileExtension()

getFileExtension(filename): string

Defined in: helpers/fileValidationHelper.ts:167

Get file extension from filename

Parameters

filename

string

Returns

string


formatFileSize()

formatFileSize(bytes): string

Defined in: helpers/fileValidationHelper.ts:178

Format file size in human readable format

Parameters

bytes

number

Returns

string


generateUniqueFilename()

generateUniqueFilename(originalFilename): string

Defined in: helpers/fileValidationHelper.ts:194

Generate unique filename to prevent conflicts

Parameters

originalFilename

string

Returns

string


validateFileContent()

validateFileContent(buffer, expectedContentType): boolean

Defined in: helpers/fileValidationHelper.ts:206

Validate file content by checking magic numbers (basic file type validation)

Parameters

buffer

Buffer

expectedContentType

string

Returns

boolean


detectFileType()

detectFileType(buffer): string

Defined in: helpers/fileValidationHelper.ts:240

Get file type from buffer (basic detection)

Parameters

buffer

Buffer

Returns

string


isFileSafe()

isFileSafe(buffer, _filename, contentType): boolean

Defined in: helpers/fileValidationHelper.ts:270

Check if file is safe to upload based on content analysis

Parameters

buffer

Buffer

_filename

string

contentType

string

Returns

boolean