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 lib/api/upload/file.ts:69
Parameters
- _file: FileInstance
- Optional _sanitizeOptions: SanitizeOptions
Returns File

Properties

container

container: string

handle

handle: string

key

key: string

status

status: FileState

url

url: string

workflows

workflows: any[]

Accessors

customName

customName:

Sets custom name using string or function Name will be sanitized

memberof: File

filename

filename:

Alias for name getter

readonly
type: {string}
memberof: File

mimetype

mimetype:

Alias for file type

readonly
type: {string}
memberof: File

name

name:

Returns file name Sets new file name and cleanup extra chars

memberof: File
memberof: File

size

size:

Returns file size

memberof: File

type

type:

Returns file type

default: 'application/octet-stream'
memberof: File

Methods

getChunkByMetadata

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

- Defined in lib/api/upload/file.ts:222
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 lib/api/upload/file.ts:203
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 lib/api/upload/file.ts:179
Returns part metadata

memberof

File

Parameters
- partNum: number
- size: number
Returns FilePartMetadata

getPartsCount

getPartsCount(size: number): number

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

memberof

File

Parameters
- size: number
  
  part size in bytes
Returns number

release

release(): void

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

memberof

File

Returns void

toJSON

toJSON(): object

- Defined in lib/api/upload/file.ts:249
Returns object
- handle: string
- name: string
- size: number
- status: FileState
- type: string
- url: string