File | filestack-js

File representation to unify file object in nodejs and browser

export
class: File

Hierarchy

File

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new File(_file: FileInstance, _sanitizeOptions?: SanitizeOptions): File

- Defined in src/lib/api/upload/file.ts:75
Parameters
- _file: FileInstance
- Optional _sanitizeOptions: SanitizeOptions
Returns File

Properties

container

container: string

handle

handle: string

key

key: string

status

status: FileState

uploadTags

uploadTags: UploadTags

url

url: string

workflows

workflows: any[]

Accessors

customName

set customName(val: ((file: this) => string) | string): void

- Defined in src/lib/api/upload/file.ts:117
Sets custom name using string or function Name will be sanitized

memberof

File

Parameters
- val: ((file: this) => string) | string
Returns void

filename

get filename(): string

- Defined in src/lib/api/upload/file.ts:98
Alias for name getter

readonly

type

{string}

memberof

File

Returns string

mimetype

get mimetype(): string

- Defined in src/lib/api/upload/file.ts:152
Alias for file type

readonly

type

{string}

memberof

File

Returns string

name

get name(): string
set name(val: string): void

- Defined in src/lib/api/upload/file.ts:87
Returns file name

memberof

File

Returns string
- Defined in src/lib/api/upload/file.ts:107
Sets new file name and cleanup extra chars

memberof

File

Parameters
- val: string
Returns void

size

get size(): number

- Defined in src/lib/api/upload/file.ts:162
Returns file size

memberof

File

Returns number

type

get type(): string

- Defined in src/lib/api/upload/file.ts:140
Returns file type

default

'application/octet-stream'

memberof

File

Returns string

Methods

getChunkByMetadata

getChunkByMetadata(meta: FilePartMetadata, offset: number, chunkSize: number, md5Enabled?: boolean): Promise<FileChunk>

- Defined in src/lib/api/upload/file.ts:228
Returns part chunk

memberof

File

Parameters
- meta: FilePartMetadata
- offset: number
- chunkSize: number
- Default value md5Enabled: boolean = true
Returns Promise<FileChunk>

getPartByMetadata

getPartByMetadata(meta: FilePartMetadata, md5Enabled?: boolean): Promise<FilePart>

- Defined in src/lib/api/upload/file.ts:209
Returns part metadata + buffer

memberof

File

Parameters
- meta: FilePartMetadata
- Default value md5Enabled: boolean = true
Returns Promise<FilePart>

getPartMetadata

getPartMetadata(partNum: number, size: number): FilePartMetadata

- Defined in src/lib/api/upload/file.ts:185
Returns part metadata

memberof

File

Parameters
- partNum: number
- size: number
Returns FilePartMetadata

getPartsCount

getPartsCount(size: number): number

- Defined in src/lib/api/upload/file.ts:173
Returns number of parts according to part size

memberof

File

Parameters
- size: number
  
  part size in bytes
Returns number

release

release(): void

- Defined in src/lib/api/upload/file.ts:249
Cleanup file buffer to release memory

memberof

File

Returns void

toJSON

toJSON(): { handle: string; name: string; size: number; status: FileState; type: string; uploadTags: UploadTags; url: string }

- Defined in src/lib/api/upload/file.ts:255
Returns { handle: string; name: string; size: number; status: FileState; type: string; uploadTags: UploadTags; url: string }
- handle: string
- name: string
- size: number
- status: FileState
- type: string
- uploadTags: UploadTags
- url: string