Sign Up Free
Log In

Interfaces

Interface AnimationParams

Hierarchy

  • AnimationParams

Defined in lib/filelink.ts:215

Index

align?
background?
delay?
fit?
height?
loop?
width?

Properties

align

Optional

align?: AlignOptions

Defined in lib/filelink.ts:221

background

Optional

background?: string

Defined in lib/filelink.ts:222

delay

Optional

delay?: number

Defined in lib/filelink.ts:216

fit

Optional

fit?: FitOptions

Defined in lib/filelink.ts:220

height

Optional

height?: number

Defined in lib/filelink.ts:219

loop

Optional

loop?: number

Defined in lib/filelink.ts:217

width

Optional

width?: number

Defined in lib/filelink.ts:218

Interface AsciiParams

Hierarchy

  • AsciiParams

Defined in lib/filelink.ts:398

Index

background?
colored?
foreground?
reverse?
size?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:399

colored

Optional

colored?: boolean

Defined in lib/filelink.ts:401

foreground

Optional

foreground?: string

Defined in lib/filelink.ts:400

reverse

Optional

reverse?: boolean

Defined in lib/filelink.ts:403

size

Optional

size?: number

Defined in lib/filelink.ts:402

Interface BlackwhiteParams

Hierarchy

  • BlackwhiteParams

Defined in lib/filelink.ts:347

Index

threshold

Properties

threshold

threshold: number

Defined in lib/filelink.ts:348

Interface BlurFacesParams

Hierarchy

  • BlurFacesParams

Defined in lib/filelink.ts:267

Index

amount?
blur?
buffer?
faces?
maxsize?
minsize?
type?

Properties

amount

Optional

amount?: number

Defined in lib/filelink.ts:272

blur

Optional

blur?: number

Defined in lib/filelink.ts:273

buffer

Optional

buffer?: number

Defined in lib/filelink.ts:271

faces

Optional

faces?: string | number

Defined in lib/filelink.ts:268

maxsize

Optional

maxsize?: number

Defined in lib/filelink.ts:270

minsize

Optional

minsize?: number

Defined in lib/filelink.ts:269

type

Optional

type?: ShapeType

Defined in lib/filelink.ts:274

Interface BlurParams

Hierarchy

  • BlurParams

Defined in lib/filelink.ts:343

Index

amount

Properties

amount

amount: number

Defined in lib/filelink.ts:344

Interface BorderParams

Hierarchy

  • BorderParams

Defined in lib/filelink.ts:312

Index

background?
color?
width?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:315

color

Optional

color?: string

Defined in lib/filelink.ts:314

width

Optional

width?: number

Defined in lib/filelink.ts:313

Interface CacheParams

Hierarchy

  • CacheParams

Defined in lib/filelink.ts:430

Index

cache?
expiry

Properties

cache

Optional

cache?: boolean

Defined in lib/filelink.ts:431

expiry

expiry: number

Defined in lib/filelink.ts:432

Interface CircleParams

Hierarchy

  • CircleParams

Defined in lib/filelink.ts:308

Index

background

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:309

Interface ClientOptions

Hierarchy

  • ClientOptions

Indexable

[option: string]: any

Defined in lib/client.ts:52

Index

cname?
forwardErrors?
security?
sessionCache?

Properties

cname

Optional

cname?: string

Domain to use for all URLs. Requires the custom CNAME addon. If this is enabled then you must also set up your own OAuth applications for each cloud source you wish to use in the picker.

Defined in lib/client.ts:66

forwardErrors

Optional

forwardErrors?: boolean
Enable forwarding error logs to sentry

Default

false

Defined in lib/client.ts:78

security

Optional

security?: Security

Security object with policy and signature keys. Can be used to limit client capabilities and protect public URLs. It is intended to be used with server-side policy and signature generation. Read about security policies.

Defined in lib/client.ts:60

sessionCache

Optional

sessionCache?: boolean
Enable/disable caching of the cloud session token. Default is false. This ensures that users will be remembered on your domain when calling the cloud API from the browser. Please be aware that tokens stored in localStorage are accessible by other scripts on the same domain.

Defined in lib/client.ts:72

Interface CollageParams

Hierarchy

  • CollageParams

Defined in lib/filelink.ts:383

Index

color?
files
fit?
height?
margin?
width?

Properties

color

Optional

color?: string

Defined in lib/filelink.ts:387

files

files: [string]

Defined in lib/filelink.ts:389

fit

Optional

fit?: FitOptions

Defined in lib/filelink.ts:388

height

Optional

height?: number

Defined in lib/filelink.ts:386

margin

Optional

margin?: number

Defined in lib/filelink.ts:384

width

Optional

width?: number

Defined in lib/filelink.ts:385

Interface CompressParams

Hierarchy

  • CompressParams

Defined in lib/filelink.ts:318

Index

metadata

Properties

metadata

Optional

metadata?: boolean

Defined in lib/filelink.ts:319

Interface CropFacesParams

Hierarchy

  • CropFacesParams

Defined in lib/filelink.ts:249

Index

buffer?
faces?
height?
mode?
width?

Properties

buffer

Optional

buffer?: number

Defined in lib/filelink.ts:254

faces

faces?: string | number

Defined in lib/filelink.ts:253

height

Optional

height?: number

Defined in lib/filelink.ts:252

mode

Optional

mode?: CropfacesType

Defined in lib/filelink.ts:250

width

Optional

width?: number

Defined in lib/filelink.ts:251

Interface CropParams

Hierarchy

  • CropParams

Defined in lib/filelink.ts:232

Index

dim

Properties

dim

dim: [number, number, number, number]

Defined in lib/filelink.ts:233

Interface DetectFacesParams

Hierarchy

  • DetectFacesParams

Defined in lib/filelink.ts:242

Index

color?
export?
maxsize?
minsize?

Properties

color

Optional

color?: string

Defined in lib/filelink.ts:245

export

export?: boolean

Defined in lib/filelink.ts:246

maxsize

Optional

maxsize?: number

Defined in lib/filelink.ts:244

minsize

Optional

minsize?: number

Defined in lib/filelink.ts:243

Interface EnhanceParams

Hierarchy

  • EnhanceParams

Defined in lib/filelink.ts:489

Index

preset

Properties

preset

Optional

preset?: EnhancePreset

Defined in lib/filelink.ts:490

Interface FallbackParams

Hierarchy

  • FallbackParams

Defined in lib/filelink.ts:503

Index

cache
handle

Properties

cache

Optional

cache?: number

Defined in lib/filelink.ts:505

handle

Optional

handle: string

Defined in lib/filelink.ts:504

Interface FsAuthConfig

Hierarchy

  • FsAuthConfig

Defined in lib/request/types.ts:37

Index

password
username

Properties

password

password: string

Defined in lib/request/types.ts:39

username

username: string

Defined in lib/request/types.ts:38

Interface FsRequestHeaders

Hierarchy

  • FsRequestHeaders

Defined in lib/request/types.ts:37

Indexable

[name: string]: string

Defined in lib/request/types.ts:42

Interface FsRequestOptions

Hierarchy

  • FsRequestOptions

Defined in lib/request/types.ts:58

Index

auth?
blobResponse?
cache?
cancelToken?
data?
filestackHeaders?
headers?
method?
mode?
onProgress?
params?
redirect?
retry?
runtime?
timeout?
url?

Properties

auth

Optional

auth?: FsAuthConfig

Defined in lib/request/types.ts:73

blobResponse

Optional

blobResponse?: boolean

Defined in lib/request/types.ts:68

cache

Optional

cache?: RequestCache

Defined in lib/request/types.ts:63

cancelToken

Optional

cancelToken?: FsCancelToken

Defined in lib/request/types.ts:70

data

Optional

data?: any

Defined in lib/request/types.ts:60

filestackHeaders

Optional

filestackHeaders?: boolean

Defined in lib/request/types.ts:66

headers

Optional

headers?: FsRequestHeaders

Defined in lib/request/types.ts:67

method

Optional

method?: FsHttpMethod

Defined in lib/request/types.ts:61

mode

Optional

mode?: RequestMode

Defined in lib/request/types.ts:62

onProgress

Optional

onProgress?: ((pr: ProgressEvent<EventTarget>) => any)

Type declaration

  • (pr: ProgressEvent<EventTarget>): any

Parameters

  • pr: ProgressEvent<EventTarget>

Returns any

Defined in lib/request/types.ts:72

params

Optional

params?: FsRequestParams

Defined in lib/request/types.ts:65

redirect

Optional

redirect?: RequestRedirect

Defined in lib/request/types.ts:64

retry

Optional

retry?: FsRetryConfig

Defined in lib/request/types.ts:71

runtime

Optional

runtime?: FsRequestRuntime

Defined in lib/request/types.ts:74

timeout

Optional

timeout?: number

Defined in lib/request/types.ts:69

url

Optional

url?: string

Defined in lib/request/types.ts:59

Interface FsRequestParams

Hierarchy

  • FsRequestParams

Indexable

[name: string]: string | number

Defined in lib/request/types.ts:46

Interface FsRequestRuntime

Hierarchy

  • FsRequestRuntime

Indexable

[name: string]: any

Defined in lib/request/types.ts:53

Index

retryCount?

Properties

retryCount

Optional

retryCount?: number

Defined in lib/request/types.ts:54

Interface FsResponse

Hierarchy

  • FsResponse

Defined in lib/request/types.ts:77

Index

config
data
headers
status
statusText

Properties

config

config: FsRequestOptions

Defined in lib/request/types.ts:82

data

data: any

Defined in lib/request/types.ts:81

headers

headers: any

Defined in lib/request/types.ts:80

status

status: number

Defined in lib/request/types.ts:78

statusText

statusText: string

Defined in lib/request/types.ts:79

Interface FsRetryConfig

Hierarchy

  • FsRetryConfig

Defined in lib/request/types.ts:30

Index

onRetry?
retry
retryFactor?
retryMaxTime?

Properties

onRetry

Optional

onRetry?: ((requestConfig: any) => void)

Type declaration

  • (requestConfig: any): void

Parameters

  • requestConfig: any

Returns void

Defined in lib/request/types.ts:32

retry

retry: number

Defined in lib/request/types.ts:31

retryFactor

Optional

retryFactor?: number

Defined in lib/request/types.ts:34

retryMaxTime

Optional

retryMaxTime?: number

Defined in lib/request/types.ts:33

Interface MetadataOptions

Hierarchy

  • MetadataOptions

Index

cloud?
container
exif?
filename?
height?
location?
md5?
mimetype?
path?
sha1?
sha224?
sha256?
sha384?
sha512?
size?
sourceUrl?
uploaded?
width?
writeable?

Properties

cloud

Optional

cloud?: boolean

Defined in lib/api/file.ts:69

container

Optional

container?: boolean

Defined in lib/api/file.ts:79

exif

Optional

exif?: boolean

Defined in lib/api/file.ts:80

filename

Optional

filename?: boolean

Defined in lib/api/file.ts:64

height

Optional

height?: boolean

Defined in lib/api/file.ts:66

location

Optional

location?: boolean

Defined in lib/api/file.ts:77

md5

Optional

md5?: boolean

Defined in lib/api/file.ts:71

mimetype

Optional

mimetype?: boolean

Defined in lib/api/file.ts:63

path

Optional

path?: boolean

Defined in lib/api/file.ts:78

sha1

Optional

sha1?: boolean

Defined in lib/api/file.ts:72

sha224

Optional

sha224?: boolean

Defined in lib/api/file.ts:73

sha256

Optional

sha256?: boolean

Defined in lib/api/file.ts:74

sha384

Optional

sha384?: boolean

Defined in lib/api/file.ts:75

sha512

Optional

sha512?: boolean

Defined in lib/api/file.ts:76

size

Optional

size?: boolean

Defined in lib/api/file.ts:62

sourceUrl

Optional

sourceUrl?: boolean

Defined in lib/api/file.ts:70

uploaded

Optional

uploaded?: boolean

Defined in lib/api/file.ts:67

width

Optional

width?: boolean

Defined in lib/api/file.ts:65

writeable

Optional

writeable?: boolean

Defined in lib/api/file.ts:68

Interface MinifyCssParams

Hierarchy

  • MinifyCssParams

Defined in lib/filelink.ts:508

Index

gzip?
level?

Properties

gzip

Optional

gzip?: boolean

Defined in lib/filelink.ts:509

level

Optional

level?: number

Defined in lib/filelink.ts:510

Interface MinifyJsParams

Hierarchy

  • MinifyJsParams

Defined in lib/filelink.ts:513

Index

gzip?
keep_class_name?
keep_fn_name?
mangle?
merge_vars?
remove_console?
remove_undefined?
targets?
use_babel_polyfill?

Properties

gzip

Optional

gzip?: boolean

Defined in lib/filelink.ts:514

keep_class_name

Optional

keep_class_name?: boolean

Defined in lib/filelink.ts:517

keep_fn_name

Optional

keep_fn_name?: boolean

Defined in lib/filelink.ts:516

mangle

Optional

mangle?: boolean

Defined in lib/filelink.ts:518

merge_vars

Optional

merge_vars?: boolean

Defined in lib/filelink.ts:519

remove_console

Optional

remove_console?: boolean

Defined in lib/filelink.ts:520

remove_undefined

Optional

remove_undefined?: boolean

Defined in lib/filelink.ts:521

targets

Optional

targets?: string

Defined in lib/filelink.ts:522

use_babel_polyfill

Optional

use_babel_polyfill?: boolean

Defined in lib/filelink.ts:515

Interface ModulateParams

Hierarchy

  • ModulateParams

Defined in lib/filelink.ts:363

Index

brightness?
hue?
saturation?

Properties

brightness

Optional

brightness?: number

Defined in lib/filelink.ts:364

hue

Optional

hue?: number

Defined in lib/filelink.ts:365

saturation

Optional

saturation?: number

Defined in lib/filelink.ts:366

Interface OilPaintParams

Hierarchy

  • OilPaintParams

Defined in lib/filelink.ts:359

Index

amount

Properties

amount

Optional

amount: number

Defined in lib/filelink.ts:360

Interface OutputParams

Hierarchy

  • OutputParams

Defined in lib/filelink.ts:415

Index

background?
colorspace?
compress?
density?
docinfo?
format
page?
pageformat?
pageorientation?
quality?
secure?
strip?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:423

colorspace

Optional

colorspace?: string

Defined in lib/filelink.ts:417

compress

Optional

compress?: boolean

Defined in lib/filelink.ts:421

density

Optional

density?: number

Defined in lib/filelink.ts:422

docinfo

Optional

docinfo?: boolean

Defined in lib/filelink.ts:425

format

format: string

Defined in lib/filelink.ts:416

page

Optional

page?: number

Defined in lib/filelink.ts:420

pageformat

Optional

pageformat?: string

Defined in lib/filelink.ts:426

pageorientation

Optional

pageorientation?: string

Defined in lib/filelink.ts:427

quality

Optional

quality?: number

Defined in lib/filelink.ts:419

secure

Optional

secure?: boolean

Defined in lib/filelink.ts:424

strip

Optional

strip?: boolean

Defined in lib/filelink.ts:418

Interface PartialBlurParams

Hierarchy

  • PartialBlurParams

Defined in lib/filelink.ts:376

Index

amount
blur?
objects?
type?

Properties

amount

amount: number

Defined in lib/filelink.ts:377

blur

Optional

blur?: number

Defined in lib/filelink.ts:378

objects

Optional

objects?: [[number, number, number, number]]

Defined in lib/filelink.ts:380

type

Optional

type?: ShapeType

Defined in lib/filelink.ts:379

Interface PartialPixelateParams

Hierarchy

  • PartialPixelateParams

Defined in lib/filelink.ts:369

Index

amount?
blur?
objects?
type?

Properties

amount

Optional

amount?: number

Defined in lib/filelink.ts:370

blur

Optional

blur?: number

Defined in lib/filelink.ts:371

objects

Optional

objects?: [[number, number, number, number]]

Defined in lib/filelink.ts:373

type

Optional

type?: ShapeType

Defined in lib/filelink.ts:372

Interface PdfConvertParams

Hierarchy

  • PdfConvertParams

Defined in lib/filelink.ts:497

Index

pageformat?
pageorientation?
pages?

Properties

pageformat

Optional

pageformat?: string

Defined in lib/filelink.ts:499

pageorientation

Optional

pageorientation?: string

Defined in lib/filelink.ts:498

pages

Optional

pages?: (string | number)[]

Defined in lib/filelink.ts:500

Interface PdfInfoParams

Hierarchy

  • PdfInfoParams

Defined in lib/filelink.ts:493

Index

colorinfo?

Properties

colorinfo

Optional

colorinfo?: boolean

Defined in lib/filelink.ts:494

Interface PickerFileMetadata

Hierarchy

  • PickerFileMetadata

Defined in lib/picker.ts:101

Index

alt
container?
cropped?
filename
handle
key?
mimetype
originalFile?
originalPath
rotated?
size
source
status?
uploadId
url

Properties

alt

alt: string
Alt text for images

Defined in lib/picker.ts:161

container

Optional

container?: string
The cloud container for the uploaded file.

Defined in lib/picker.ts:105

cropped

Optional

cropped?: PickerCroppedData
Position and size information for cropped images.

Defined in lib/picker.ts:109

filename

filename: string
Name of the file.

Defined in lib/picker.ts:113

handle

handle: string
Filestack handle for the uploaded file.

Defined in lib/picker.ts:117

key

Optional

key?: string
The hash-prefixed cloud storage path.

Defined in lib/picker.ts:121

mimetype

mimetype: string
The MIME type of the file.

Defined in lib/picker.ts:125

originalFile

Optional

originalFile?: object | File
Properties of the local binary file. Also see the pick option exposeOriginalFile if you want the underlying File object.

Defined in lib/picker.ts:129

originalPath

originalPath: string
The origin of the file, e.g. /Folder/file.jpg.

Defined in lib/picker.ts:133

rotated

Optional

rotated?: PickerRotatedData
Direction and value information for rotated images.

Defined in lib/picker.ts:137

size

size: number
Size in bytes of the uploaded file.

Defined in lib/picker.ts:141

source

source: string
The source from where the file was picked.

Defined in lib/picker.ts:145

status

Optional

status?: string
Indicates Filestack transit status.

Defined in lib/picker.ts:149

uploadId

uploadId: string
A uuid for tracking this file in callbacks.

Defined in lib/picker.ts:153

url

url: string
The Filestack CDN URL for the uploaded file.

Defined in lib/picker.ts:157

Interface PickerInstance

Hierarchy

  • PickerInstance

Defined in lib/picker.ts:24

Index

cancel
close
crop
open

Properties

cancel

cancel: (() => Promise<void>)

Type declaration

  • (): Promise<void>
    Cancel picker uploads. This operation is idempotent.

Returns Promise<void>

Defined in lib/picker.ts:33

close

close: (() => Promise<void>)

Type declaration

  • (): Promise<void>
    Close picker. This operation is idempotent.
Returns Promise<void>

Defined in lib/picker.ts:28

crop

crop: ((files: any[]) => Promise<void>)

Type declaration

  • (files: any[]): Promise<void>
    Specify a list of files to open in the picker for cropping
Example
// <input id="fileSelect" type="file">

const inputEl = document.getElementById('fileSelect');
const picker = client.picker({
  onUploadDone: res => console.log(res),
});

inputEl.addEventListener('change', (e) => {
  picker.crop(e.target.files);
});

// Or pass an array of URL strings
const urls = [
  'https://d1wtqaffaaj63z.cloudfront.net/images/fox_in_forest1.jpg',
  'https://d1wtqaffaaj63z.cloudfront.net/images/sail.jpg',
];
picker.crop(urls);
Parameters
  • files: any[]

Returns Promise<void>

Defined in lib/picker.ts:65

open

open: (() => Promise<void>)

Type declaration

  • (): Promise<void>
    Open picker. This operation is idempotent.

Returns Promise<void>

Defined in lib/picker.ts:38

Interface PickerOptions

Hierarchy

  • PickerOptions

Defined in lib/picker.ts:369

Index

accept?
acceptFn?
allowManualRetry?
cleanupImageExif?
concurrency?
container?
customAuthText?
customSourceContainer?
customSourceName?
customSourcePath?
customText?
disableAltText?
disableDirectoryUpload?
disableStorageKey?
disableThumbnails?
disableTransformer?
displayMode?
dropPane?
errorsTimeout?
exposeOriginalFile?
fromSources?
globalDropZone?
hideModalWhenUploading?
imageDim?
imageMax?
imageMin?
lang?
maxFiles?
maxSize?
minFiles?
miniUploader?
modalSize?
multipleFileUpload?
onCancel?
onClose?
onFileCropped?
onFileSelected?
onFileUploadCancel?
onFileUploadFailed?
onFileUploadFinished?
onFileUploadProgress?
onFileUploadStarted?
onOpen?
onUploadDone?
onUploadStarted?
pasteMode?
rootId?
startUploadingWhenMaxFilesReached?
storeTo?
supportEmail?
transformations?
transformationsUI?
uploadConfig?
uploadInBackground?
useSentryBreadcrumbs?
videoResolution?
viewType?
websearch?

Properties

accept

Optional

accept?: string | string[]
Restrict file types that are allowed to be picked. Formats accepted:
  • .pdf <- any file extension
  • image/jpeg <- any mime type commonly known by browsers
  • image/* <- accept all types of images
  • video/* <- accept all types of video files
  • audio/* <- accept all types of audio files
  • application/* <- accept all types of application files
  • text/* <- accept all types of text files

Defined in lib/picker.ts:380

acceptFn

Optional

acceptFn?: ((PickerFileMetadata: any, PickerAcceptFnOptions: any) => Promise<string>)

Type declaration

  • (PickerFileMetadata: any, PickerAcceptFnOptions: any): Promise<string>
    Custom accept check function
acceptFn: (file, options) => {
  return options.mimeFromMagicBytes(file.originalFile).then((res) => { // we can check mimetype from magic bytes
    //console.log(options.mimeFromExtension(file.originalFile.name)); // or check extension from filestack extensions database
    // throw new Error('Cannot accept that file') // we can throw exception to block file upload
    // return Promise.reject('Cannot accept that file'') // or reject a promise
    return Promise.resolve();
  });
}
Parameters
  • PickerFileMetadata: any
  • PickerAcceptFnOptions: any
Returns Promise<string>

Defined in lib/picker.ts:394

allowManualRetry

Optional

allowManualRetry?: boolean
Prevent modal close on upload failure and allow users to retry.

Defined in lib/picker.ts:398

cleanupImageExif

Optional

cleanupImageExif?: boolean | {
    keepICCandAPP?: boolean;
    keepOrientation?: boolean;
}
Turn on cleaning JPEG image exif. Method can keep image orientation or color profiles
cleanupImageExif: {
  keepOrientation: true,
  keepICCandAPP: true
}

Defined in lib/picker.ts:444

concurrency

Optional

concurrency?: number
Max number of files to upload concurrently. Default is 4.

Defined in lib/picker.ts:485

container

Optional

container?: string | Node

Container where picker should be appended. Only relevant for inline and dropPane display modes.

Defined in lib/picker.ts:433

customAuthText

Optional

customAuthText?: CustomAuthTextOptions

Customize the text on the cloud authentication screen in Picker. Use a cloud source name (see fromSources) or a ‘default’ as a key, then put your custom notice or consent to the ‘top’ or the ‘bottom’ key to show it respectivly above or under ‘Connect button’.

customAuthText: {
  // use it for every cloud authentication screen
  default: {
    top: [
      'default top first line',
      'default top second line'
    ],
    bottom: [
      'default bottom first line',
      'default bottom second line'
    ]
  },
  // override a default bottom text for only gmail
  gmail: {
    bottom: [
      'We need your permission to access your data and',
      'process it with our machine learning system.'
    ]
  }
}

Defined in lib/picker.ts:477

customSourceContainer

Optional

customSourceContainer?: string
Set the default container for your custom source.

Defined in lib/picker.ts:489

customSourceName

Optional

customSourceName?: string
Set the display name for the custom source.

Defined in lib/picker.ts:497

customSourcePath

Optional

customSourcePath?: string
Set the default path for your custom source container.

Defined in lib/picker.ts:493

customText

Optional

customText?: PickerCustomText

Provide an object for mapping picker strings to your own strings. Strings surrounded by brackets, { foobar }, are interpolated with runtime values. Source labels are also available to override, e.g. Facebook, Instagram, Dropbox, etc.

Defined in lib/picker.ts:503

disableAltText

Optional

disableAltText?: boolean
Disables alt text view/edit in the summary screen.

Defined in lib/picker.ts:519

disableDirectoryUpload

Optional

disableDirectoryUpload?: boolean
Disable/Enable possibility to upload directories.

Defined in lib/picker.ts:730

disableStorageKey

Optional

disableStorageKey?: boolean
When true removes the hash prefix on stored files.

Defined in lib/picker.ts:511

disableThumbnails

Optional

disableThumbnails?: boolean
Disables local image thumbnail previews in the summary screen.

Defined in lib/picker.ts:523

disableTransformer

Optional

disableTransformer?: boolean
When true removes ability to edit images.

Defined in lib/picker.ts:515

displayMode

Optional

displayMode?: PickerDisplayMode

Picker display mode, one of 'inline', 'overlay', 'dropPane' – default is 'overlay'.

Defined in lib/picker.ts:481

dropPane

Optional

dropPane?: PickerDropPaneOptions

Configure the drop pane behavior, i.e. when displayMode is dropPane.

Defined in lib/picker.ts:527

errorsTimeout

Optional

errorsTimeout?: number
Timeout for error messages

Defined in lib/picker.ts:585

exposeOriginalFile

Optional

exposeOriginalFile?: boolean

When true the originalFile metadata will be the actual File object instead of a POJO

Defined in lib/picker.ts:531

fromSources

Optional

fromSources?: string[]

Valid sources are:

  • local_file_system – Default
  • url – Default
  • imagesearch – Default
  • facebook – Default
  • instagram – Default
  • googledrive – Default
  • dropbox – Default
  • webcam – Uses device menu on mobile. Not currently supported in Safari and IE.
  • video – Uses device menu on mobile. Not currently supported in Safari and IE.
  • audio – Uses device menu on mobile. Not currently supported in Safari and IE.
  • box
  • github
  • gmail
  • googlephotos
  • onedrive
  • onedriveforbusiness
  • customsource – Configure this in your Filestack Dev Portal.
  • unsplash

Defined in lib/picker.ts:420

globalDropZone

Optional

globalDropZone?: boolean
Toggle the drop zone to be active on all views. Default is active only on local file source.

Defined in lib/picker.ts:535

hideModalWhenUploading

Optional

hideModalWhenUploading?: boolean

Hide the picker modal UI once uploading begins. Defaults to false.

Defined in lib/picker.ts:539

imageDim

Optional

imageDim?: [number, number]
Specify image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Local and cropped images will be resized (upscaled or downscaled) to the specified dimensions before uploading. The original height to width ratio is maintained. To resize all images based on the width, set [width, null], e.g. [800, null]. For the height set [null, height], e.g. [null, 600].

Defined in lib/picker.ts:547

imageMax

Optional

imageMax?: [number, number]

Specify maximum image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Images bigger than the specified dimensions will be resized to the maximum size while maintaining the original aspect ratio. The output will not be exactly 800×600 unless the imageMax matches the aspect ratio of the original image.

Defined in lib/picker.ts:553

imageMin

Optional

imageMin?: [number, number]

Specify minimum image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Images smaller than the specified dimensions will be upscaled to the minimum size while maintaining the original aspect ratio. The output will not be exactly 800×600 unless the imageMin matches the aspect ratio of the original image.

Defined in lib/picker.ts:559

lang

Optional

lang?: string

Sets locale. Accepts: ca, da, de, en, es, fr, he, it, ja, ko, nl, no, pl, pt, sv, ru, vi, zh, tr

Defined in lib/picker.ts:563

maxFiles

Optional

maxFiles?: number

Maximum number of files allowed to upload. Defaults to 1.

Defined in lib/picker.ts:571

maxSize

Optional

maxSize?: number

Restrict selected files to a maximum number of bytes. (e.g. 10 * 1024 * 1024 for 10MB limit).

Defined in lib/picker.ts:575

minFiles

Optional

minFiles?: number

Minimum number of files required to start uploading. Defaults to 1.

Defined in lib/picker.ts:567

miniUploader

Optional

miniUploader?: boolean
Enable/Disable Mini Uploader

Defined in lib/picker.ts:734

modalSize

Optional

modalSize?: [number, number]
Specify [width, height] in pixels of the desktop modal.

Defined in lib/picker.ts:589

multipleFileUpload

Optional

multipleFileUpload?: boolean

Enable/Disable possibility to multiple file upload

Defined in lib/picker.ts:738

onCancel

Optional

onCancel?: PickerUploadDoneCallback
Called when all uploads in a pick are cancelled.

Defined in lib/picker.ts:593

onClose

Optional

onClose?: (() => void)

Type declaration

  • (): void
    Called when the UI is exited.

Returns void

Defined in lib/picker.ts:597

onFileCropped

Optional

onFileCropped?: PickerFileCallback
Called when file is cropped in picker

Defined in lib/picker.ts:663

onFileSelected

Optional

onFileSelected?: PickerFileCallback
Called whenever user selects a file.

Example

// Using to veto file selection
// If you throw any error in this function it will reject the file selection.
// The error message will be displayed to the user as an alert.
onFileSelected(file) {
  if (file.size > 1000 * 1000) {
    throw new Error('File too big, select something smaller than 1MB');
  }
}

// Using to change selected file name
// NOTE: This currently only works for local uploads
onFileSelected(file) {
  // It's important to return a new file by the end of this function.
  return { ...file, name: 'foo' };
}

The callback function can also return a Promise to allow asynchronous validation logic. You can pass a file object to resolve for changing the file name, it will behave the same as when the file is returned from the non-async callback.

onFileSelected(file) {
  return new Promise((resolve, reject) => {
    // Do something async
    resolve();
    // Or reject the selection with reject()
  });
}

Defined in lib/picker.ts:639

onFileUploadCancel

Optional

onFileUploadCancel?: PickerFileCancelCallback
Called when a file upload has been canceled.

Defined in lib/picker.ts:643

onFileUploadFailed

Optional

onFileUploadFailed?: PickerFileErrorCallback
Called when uploading a file fails.

Defined in lib/picker.ts:655

onFileUploadFinished

Optional

onFileUploadFinished?: PickerFileCallback
Called when a file is done uploading.

Defined in lib/picker.ts:651

onFileUploadProgress

Optional

onFileUploadProgress?: PickerFileProgressCallback
Called during multi-part upload progress events. Local files only.

Defined in lib/picker.ts:659

onFileUploadStarted

Optional

onFileUploadStarted?: PickerFileWithTokenCallback
Called when a file begins uploading.

Defined in lib/picker.ts:647

onOpen

Optional

onOpen?: ((handle: PickerInstance) => void)

Type declaration

Parameters

Returns void

Defined in lib/picker.ts:602

onUploadDone

Optional

onUploadDone?: PickerUploadDoneCallback
Called when all files have been uploaded.

Defined in lib/picker.ts:671

onUploadStarted

Optional

onUploadStarted?: PickerUploadStartedCallback
Called when uploading starts (user initiates uploading).

Defined in lib/picker.ts:667

pasteMode

Optional

pasteMode?: {
    pasteToFirstInViewPort?: boolean;
    pasteToFirstInstance?: boolean;
}
Specify which Picker instance should respond to paste event. By default only hovered instance responds to event.

Param

If none instance is hovered take first picker instance fully visible in viewport

Param

If none instance is hovered take first picker instance that is initialized

Paste To First In View Port

is checked first

Type declaration

  • Optional pasteToFirstInViewPort?: boolean
  • Optional pasteToFirstInstance?: boolean

Defined in lib/picker.ts:723

rootId

Optional

rootId?: string
Define a unique id for the application mount point. May be useful for more advanced use cases. For example, if you wish to have more than one picker instance open at once, then each will need their own unique rootId.

Note: This option is ignored when displayMode is dropPane.

Defined in lib/picker.ts:681

startUploadingWhenMaxFilesReached

Optional

startUploadingWhenMaxFilesReached?: boolean

Whether to start uploading automatically when maxFiles is hit. Defaults to false.

Defined in lib/picker.ts:685

storeTo

Optional

storeTo?: PickerStoreOptions
Options for file storage.

Defined in lib/picker.ts:689

supportEmail

Optional

supportEmail?: string
set support email to display in case of error

Defined in lib/picker.ts:507

transformations

Optional

transformations?: PickerTransformationOptions
Specify options for images passed to the crop UI.

Defined in lib/picker.ts:693

transformationsUI

Optional

transformationsUI?: boolean

Whether to use the new transformations UI. Defaults to false.

Defined in lib/picker.ts:697

uploadConfig

Optional

uploadConfig?: UploadOptions
Options for local file uploads.

Defined in lib/picker.ts:701

uploadInBackground

Optional

uploadInBackground?: boolean

Start uploading immediately on file selection. Defaults to true.

Important

The feature is can be enabled only if crop is disabled – disableTransformer: true

Defined in lib/picker.ts:706

useSentryBreadcrumbs

Optional

useSentryBreadcrumbs?: boolean

Use Sentry Breadcrumbs mechanism to log information about occured errors. It can override global objects like console, error etc. Defaults to true.

Defined in lib/picker.ts:715

videoResolution

Optional

videoResolution?: string

Sets the resolution of recorded video. One of “320×240”, “640×480” or “1280×720”. Default is "640x480".

Defined in lib/picker.ts:710

viewType

Optional

viewType?: "list" | "grid"
Default view type option for file browser

Defined in lib/picker.ts:580

websearch

Optional

websearch?: object
Provide default text value for Image Search
websearch: {
  predefinedText: 'Sample text'
}

Defined in lib/picker.ts:429

Interface PickerResponse

Hierarchy

  • PickerResponse

Defined in lib/picker.ts:171

Index

filesFailed
filesUploaded

Properties

filesFailed

filesFailed: PickerFileMetadata[]

Defined in lib/picker.ts:173

filesUploaded

filesUploaded: PickerFileMetadata[]

Defined in lib/picker.ts:172

Interface PickerUploadDoneCallback

Hierarchy

  • PickerUploadDoneCallback
PickerUploadDoneCallback(files: PickerResponse): void

Parameters

Returns void

Defined in lib/picker.ts:200

Interface PixelateFacesParams

Hierarchy

  • PixelateFacesParams

Defined in lib/filelink.ts:257

Index

amount?
blur?
buffer?
faces?
maxsize?
minsize?
type?

Properties

amount

Optional

amount?: number

Defined in lib/filelink.ts:262

blur

Optional

blur?: number

Defined in lib/filelink.ts:263

buffer

Optional

buffer?: number

Defined in lib/filelink.ts:261

faces

Optional

faces?: string | number

Defined in lib/filelink.ts:258

maxsize

Optional

maxsize?: number

Defined in lib/filelink.ts:260

minsize

Optional

minsize?: number

Defined in lib/filelink.ts:259

type

Optional

type?: ShapeType

Defined in lib/filelink.ts:264

Interface PixelateParams

Hierarchy

  • PixelateParams

Defined in lib/filelink.ts:355

Index

amount

Properties

amount

amount: number

Defined in lib/filelink.ts:356

Interface PolaroidParams

Hierarchy

  • PolaroidParams

Defined in lib/filelink.ts:289

Index

background?
color?
rotate?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:292

color

Optional

color?: string

Defined in lib/filelink.ts:290

rotate

Optional

rotate?: number

Defined in lib/filelink.ts:291

Interface PreviewOptions

Hierarchy

  • PreviewOptions

Defined in lib/api/preview.ts:23

Index

css?
id

Properties

css

Optional

css?: string
URL to custom CSS

Defined in lib/api/preview.ts:32

id

id: string
Id for DOM element to embed preview into. Omit this to open the preview in a new tab

Defined in lib/api/preview.ts:28

Interface ProgressiveJpgParams

Hierarchy

  • ProgressiveJpgParams

Defined in lib/filelink.ts:328

Index

metadata
quality

Properties

metadata

metadata: boolean

Defined in lib/filelink.ts:330

quality

quality: number

Defined in lib/filelink.ts:329

Interface QualityParams

Hierarchy

  • QualityParams

Defined in lib/filelink.ts:406

Index

value

Properties

value

value: number

Defined in lib/filelink.ts:407

Interface ResizeParams

Hierarchy

  • ResizeParams

Defined in lib/filelink.ts:225

Index

align?
fit?
height?
width?

Properties

align

Optional

align?: AlignOptions

Defined in lib/filelink.ts:229

fit

Optional

fit?: FitOptions

Defined in lib/filelink.ts:228

height

Optional

height?: number

Defined in lib/filelink.ts:227

width

Optional

width?: number

Defined in lib/filelink.ts:226

Interface RetrieveOptions

Hierarchy

  • RetrieveOptions

Defined in lib/api/file.ts:135

Index

cache?
dl?
extension?
head?
metadata?

Properties

cache

Optional

cache?: boolean

Defined in lib/api/file.ts:140

dl

Optional

dl?: boolean

Defined in lib/api/file.ts:138

extension

Optional

extension?: string

Defined in lib/api/file.ts:139

head

Optional

head?: boolean

Defined in lib/api/file.ts:137

metadata

Optional

metadata?: boolean

Defined in lib/api/file.ts:136

Interface RotateParams

Hierarchy

  • RotateParams

Defined in lib/api/file.ts:135

Index

background?
color?
deg

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:239

color

Optional

color?: string

Defined in lib/filelink.ts:238

deg

deg: string | number

Defined in lib/filelink.ts:237

Interface RoundedCornersParams

Hierarchy

  • RoundedCornersParams

Defined in lib/filelink.ts:277

Index

background?
blur?
radius?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:280

blur

Optional

blur?: number

Defined in lib/filelink.ts:279

radius

Optional

radius?: number

Defined in lib/filelink.ts:278

Interface Security

Hierarchy

  • Security

Defined in lib/client.ts:47

Index

policy
signature

Properties

policy

policy: string

Defined in lib/client.ts:48

signature

signature: string

Defined in lib/client.ts:49

Interface SecurityOptions

Configures a security policy

See

https://www.filestack.com/docs/concepts/security

Hierarchy

  • SecurityOptions

Defined in lib/api/security.ts:23

Index

call?
container?
expiry
handle?
maxSize?
minSize?
path?
url?

Properties

call

Optional

call?: any[]

Defined in lib/api/security.ts:25

container

Optional

container?: string

Defined in lib/api/security.ts:31

expiry

expiry: number

Defined in lib/api/security.ts:24

handle

Optional

handle?: string

Defined in lib/api/security.ts:26

maxSize

Optional

maxSize?: number

Defined in lib/api/security.ts:28

minSize

Optional

minSize?: number

Defined in lib/api/security.ts:29

path

Optional

path?: string

Defined in lib/api/security.ts:30

url

Optional

url?: string

Defined in lib/api/security.ts:27

Interface SecurityParams

Hierarchy

  • SecurityParams

Defined in lib/filelink.ts:410

Index

policy
signature?

Properties

policy

policy: string

Defined in lib/filelink.ts:411

signature

Optional

signature?: string

Defined in lib/filelink.ts:412

Interface SepiaParams

Hierarchy

  • SepiaParams

Defined in lib/filelink.ts:351

Index

tone

Properties

tone

tone: number

Defined in lib/filelink.ts:352

Interface ShadowParams

Hierarchy

  • ShadowParams

Defined in lib/filelink.ts:410

Index

background?
blur?
color?
opacity?
vector?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:305

blur

Optional

blur?: number

Defined in lib/filelink.ts:301

color

Optional

color?: string

Defined in lib/filelink.ts:304

opacity

Optional

opacity?: number

Defined in lib/filelink.ts:302

vector

Optional

vector?: [number, number]

Defined in lib/filelink.ts:303

Interface SharpenParams

Hierarchy

  • SharpenParams

Defined in lib/filelink.ts:339

Index

amount

Properties

amount

amount: number

Defined in lib/filelink.ts:340

Interface SmartCropParams

Hierarchy

  • SmartCropParams

Defined in lib/filelink.ts:333

Index

height
mode
width

Properties

height

height: number

Defined in lib/filelink.ts:336

mode

mode: SmartCropMode

Defined in lib/filelink.ts:334

width

width: number

Defined in lib/filelink.ts:335

Interface StoreBaseParams

Hierarchy

  • StoreBaseParams

Defined in lib/filelink.ts:195

Index

access?
container?
disableStorageKey?
location?
path?
region?

Properties

access

Optional

access?: string

Defined in lib/filelink.ts:200

container

Optional

container?: string

Defined in lib/filelink.ts:198

disableStorageKey

Optional

disableStorageKey?: boolean

Defined in lib/filelink.ts:201

location

Optional

location?: string

Defined in lib/filelink.ts:196

path

Optional

path?: string

Defined in lib/filelink.ts:197

region

Optional

region?: string

Defined in lib/filelink.ts:199

Interface TornEdgesParams

Hierarchy

  • TornEdgesParams

Defined in lib/filelink.ts:295

Index

background?
spread?

Properties

background

Optional

background?: string

Defined in lib/filelink.ts:297

spread

Optional

spread?: [number, number]

Defined in lib/filelink.ts:296

Interface TransformOptions

See

https://www.filestack.com/docs/image-transformations

Hierarchy

  • TransformOptions

Defined in lib/api/transform.ts:218

Index

ascii?
blackwhite?
blur?
blur_faces?
border?
cache?
circle?
collage?
compress?
crop?
crop_faces?
detect_faces?
enchance?
flip?
flop?
imagesize?
modulate?
monochrome?
negative?
no_metadata?
oil_paint?
output?
partial_blur?
partial_pixelate?
pdfconvert?
pdfinfo?
pixelate?
pixelate_faces?
pjpg?
polaroid?
quality?
redeye?
resize?
rotate?
rounded_corners?
security?
sepia?
sfw?
shadow?
sharpen?
smart_crop?
store?
tags?
torn_edges?
upscale?
urlscreenshot?
video_convert?
vignette?
watermark?

Properties

ascii

Optional

ascii?: true | {
    background?: string;
    colored?: boolean;
    foreground?: string;
    reverse?: boolean;
    size?: number;
}

Defined in lib/api/transform.ts:380

blackwhite

Optional

blackwhite?: true | {
    threshold: number;
}

Defined in lib/api/transform.ts:338

blur

Optional

blur?: true | {
    amount: number;
}

Defined in lib/api/transform.ts:335

blur_faces

Optional

blur_faces?: {
    amount?: number;
    blur?: number;
    buffer?: number;
    faces?: string | number;
    maxsize?: number;
    minsize?: number;
    type?: EShapeType;
}

Type declaration

  • Optional amount?: number
  • Optional blur?: number
  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional maxsize?: number
  • Optional minsize?: number
  • Optional type?: EShapeType

Defined in lib/api/transform.ts:289

border

Optional

border?: true | {
    background?: string;
    color?: string;
    width?: number;
}

Defined in lib/api/transform.ts:327

cache

Optional

cache?: {
    cache?: boolean;
    expiry: number;
}

Type declaration

  • Optional cache?: boolean
  • expiry: number

Defined in lib/api/transform.ts:408

circle

Optional

circle?: true | {
    background?: string;
}

Defined in lib/api/transform.ts:324

collage

Optional

collage?: {
    color?: string;
    files: [string];
    fit?: EFitOptions;
    height?: number;
    margin?: number;
    width?: number;
}

Type declaration

  • Optional color?: string
  • files: [string]
  • Optional fit?: EFitOptions
  • Optional height?: number
  • Optional margin?: number
  • Optional width?: number

Defined in lib/api/transform.ts:367

compress

Optional

compress?: boolean

Defined in lib/api/transform.ts:220

crop

Optional

crop?: {
    dim: [number, number, number, number];
}

Type declaration

  • dim: [number, number, number, number]

Defined in lib/api/transform.ts:259

crop_faces

Optional

crop_faces?: {
    buffer?: number;
    faces?: string | number;
    height?: number;
    mode?: ECropfacesType;
    width?: number;
}

Type declaration

  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional height?: number
  • Optional mode?: ECropfacesType
  • Optional width?: number

Defined in lib/api/transform.ts:273

detect_faces

Optional

detect_faces?: true | {
    color?: string;
    export?: boolean;
    maxsize?: number;
    minsize?: number;
}

Defined in lib/api/transform.ts:267

enchance

Optional

enchance?: boolean

Defined in lib/api/transform.ts:238

flip

Optional

flip?: boolean

Defined in lib/api/transform.ts:219

flop

Optional

flop?: boolean

Defined in lib/api/transform.ts:221

imagesize

Optional

imagesize?: boolean

Defined in lib/api/transform.ts:237

modulate

Optional

modulate?: true | {
    brightness?: number;
    hue?: number;
    saturation?: number;
}

Defined in lib/api/transform.ts:350

monochrome

Optional

monochrome?: boolean

Defined in lib/api/transform.ts:240

negative

Optional

negative?: boolean

Defined in lib/api/transform.ts:241

no_metadata

Optional

no_metadata?: boolean

Defined in lib/api/transform.ts:222

oil_paint

Optional

oil_paint?: true | {
    amount: number;
}

Defined in lib/api/transform.ts:347

output

Optional

output?: {
    background?: string;
    colorspace?: string;
    compress?: boolean;
    density?: number;
    docinfo?: boolean;
    format: string;
    page?: number;
    pageformat?: string;
    pageorientation?: string;
    quality?: number;
    secure?: boolean;
    strip?: boolean;
}

Type declaration

  • Optional background?: string
  • Optional colorspace?: string
  • Optional compress?: boolean
  • Optional density?: number
  • Optional docinfo?: boolean
  • format: string
  • Optional page?: number
  • Optional pageformat?: string
  • Optional pageorientation?: string
  • Optional quality?: number
  • Optional secure?: boolean
  • Optional strip?: boolean

Defined in lib/api/transform.ts:394

partial_blur

Optional

partial_blur?: {
    amount: number;
    blur?: number;
    objects?: [[number, number, number, number]];
    type?: EShapeType;
}

Type declaration

  • amount: number
  • Optional blur?: number
  • Optional objects?: [[number, number, number, number]]
  • Optional type?: EShapeType

Defined in lib/api/transform.ts:361

partial_pixelate

Optional

partial_pixelate?: {
    amount?: number;
    blur?: number;
    objects?: [[number, number, number, number]];
    type?: EShapeType;
}

Type declaration

  • Optional amount: number
  • Optional blur?: number
  • Optional objects?: [[number, number, number, number]]
  • Optional type?: EShapeType

Defined in lib/api/transform.ts:355

pdfconvert

Optional

pdfconvert?: {
    pageformat?: string;
    pageorientation?: string;
    pages?: (string | number)[];
}

Type declaration

  • Optional pageformat?: string
  • Optional pageorientation?: string
  • Optional pages?: (string | number)[]

Defined in lib/api/transform.ts:457

pdfinfo

Optional

pdfinfo?: true | {
    colorinfo?: boolean;
}

Defined in lib/api/transform.ts:454

pixelate

Optional

pixelate?: true | {
    amount: number;
}

Defined in lib/api/transform.ts:344

pixelate_faces

Optional

pixelate_faces?: {
    amount?: number;
    blur?: number;
    buffer?: number;
    faces?: string | number;
    maxsize?: number;
    minsize?: number;
    type?: EShapeType;
}

Type declaration

  • Optional amount?: number
  • Optional blur?: number
  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional maxsize?: number
  • Optional minsize?: number
  • Optional type?: EShapeType

Defined in lib/api/transform.ts:280

pjpg

Optional

pjpg?: {
    metadata: boolean;
    quality: number;
}

Type declaration

  • metadata: boolean
  • quality: number

Defined in lib/api/transform.ts:223

polaroid

Optional

polaroid?: true | {
    background?: string;
    color?: string;
    rotate?: number;
}

Defined in lib/api/transform.ts:308

quality

Optional

quality?: {
    value: number;
}

Type declaration

  • value: number

Defined in lib/api/transform.ts:387

redeye

Optional

redeye?: boolean

Defined in lib/api/transform.ts:239

resize

Optional

resize?: {
    align?: EAlignFacesOptions;
    fit?: EFitOptions;
    height?: number;
    width?: number;
}

Type declaration

Defined in lib/api/transform.ts:253

rotate

Optional

rotate?: {
    background?: string;
    color?: string;
    deg: string | number;
}

Type declaration

  • Optional background?: string
  • Optional color?: string
  • deg: string | number

Defined in lib/api/transform.ts:262

rounded_corners

Optional

rounded_corners?: true | {
    background?: string;
    blur?: number;
    radius?: number;
}

Defined in lib/api/transform.ts:298

security

Optional

security?: {
    policy: string;
    signature?: string;
}

Type declaration

  • policy: string
  • Optional signature?: string

Defined in lib/api/transform.ts:390

sepia

Optional

sepia?: true | {
    tone: number;
}

Defined in lib/api/transform.ts:341

sfw

Optional

sfw?: boolean

Defined in lib/api/transform.ts:243

shadow

Optional

shadow?: true | {
    background?: string;
    blur?: number;
    color?: string;
    opacity?: number;
    vector?: [number, number];
}

Defined in lib/api/transform.ts:317

sharpen

Optional

sharpen?: true | {
    amount: number;
}

Defined in lib/api/transform.ts:332

smart_crop

Optional

smart_crop?: {
    height: number;
    mode?: ESmartCropMode;
    width: number;
}

Type declaration

Defined in lib/api/transform.ts:227

store

Optional

store?: {
    access?: string;
    base64decode?: boolean;
    container?: string;
    filename?: string;
    location?: string;
    path?: string;
    region?: string;
}

Type declaration

  • Optional access?: string
  • Optional base64decode?: boolean
  • Optional container?: string
  • Optional filename?: string
  • Optional location?: string
  • Optional path?: string
  • Optional region?: string

Defined in lib/api/transform.ts:244

tags

Optional

tags?: boolean

Defined in lib/api/transform.ts:242

torn_edges

Optional

torn_edges?: true | {
    background?: string;
    spread?: [number, number];
}

Defined in lib/api/transform.ts:313

upscale

Optional

upscale?: true | {
    noise?: ENoiseType;
    style?: EStyleType;
    upscale?: boolean;
}

Defined in lib/api/transform.ts:375

urlscreenshot

Optional

urlscreenshot?: true | {
    agent?: EUrlscreenshotAgent;
    delay?: number;
    device?: string;
    height?: number;
    mode?: EUrlscreenshotMode;
    orientation?: EUrlscreenshotOrientation;
    width?: number;
}

Defined in lib/api/transform.ts:445

video_convert

Optional

video_convert?: {
    access?: EVideoAccess;
    aspect_mode: EVideoAccessMode;
    audio_bitrate?: number;
    audio_channels?: number;
    audio_codec?: EAudioTypes;
    audio_sample_rate?: number;
    clip_length?: string;
    clip_offset?: string;
    container?: string;
    extname?: string;
    filename?: string;
    force?: boolean;
    fps?: number;
    height?: number;
    keyframe_interval?: number;
    location?: EVideoLocations;
    path?: string;
    preset?: EVideoTypes;
    title?: string;
    two_pass?: boolean;
    upscale: boolean;
    video_bitrate?: number;
    watermark_bottom?: number;
    watermark_height?: number;
    watermark_left?: number;
    watermark_right?: number;
    watermark_top?: number;
    watermark_url?: string;
    watermark_width?: number;
    width?: number;
}

Type declaration

  • Optional access?: EVideoAccess
  • aspect_mode: EVideoAccessMode
  • Optional audio_bitrate?: number
  • Optional audio_channels?: number
  • Optional audio_codec?: EAudioTypes
  • Optional audio_sample_rate?: number
  • Optional clip_length?: string
  • Optional clip_offset?: string
  • Optional container?: string
  • Optional extname?: string
  • Optional filename?: string
  • Optional force?: boolean
  • Optional fps?: number
  • Optional height?: number
  • Optional keyframe_interval?: number
  • Optional location?: EVideoLocations
  • Optional path?: string
  • Optional preset?: EVideoTypes
  • Optional title?: string
  • Optional two_pass?: boolean
  • upscale: boolean
  • Optional video_bitrate?: number
  • Optional watermark_bottom?: number
  • Optional watermark_height?: number
  • Optional watermark_left?: number
  • Optional watermark_right?: number
  • Optional watermark_top?: number
  • Optional watermark_url?: string
  • Optional watermark_width?: number
  • Optional width?: number

Defined in lib/api/transform.ts:413

vignette

Optional

vignette?: {
    amount?: number;
    background?: string;
    blurmode?: EBlurMode;
}

Type declaration

  • Optional amount?: number
  • Optional background?: string
  • Optional blurmode?: EBlurMode

Defined in lib/api/transform.ts:303

watermark

Optional

watermark?: {
    files: string;
    position?: EImageWatermarkPosition | EImageWatermarkPosition[];
    size?: number;
}

Type declaration

Defined in lib/api/transform.ts:232

Interface URLScreenshotParams

Hierarchy

  • URLScreenshotParams

Defined in lib/filelink.ts:468

Index

agent?
delay?
device?
height?
mode?
orientation?
width?

Properties

agent

Optional

agent?: URLScreenshotAgent

Defined in lib/filelink.ts:469

delay

Optional

delay?: number

Defined in lib/filelink.ts:473

device

Optional

device?: string

Defined in lib/filelink.ts:475

height

Optional

height?: number

Defined in lib/filelink.ts:471

mode

Optional

mode?: URLScreenshotMode

Defined in lib/filelink.ts:472

orientation

Optional

orientation?: URLScreenshotOrientation

Defined in lib/filelink.ts:474

width

Optional

width?: number

Defined in lib/filelink.ts:470

Interface UploadOptions

Hierarchy

  • UploadOptions

Defined in lib/api/upload/types.ts:22

Index

altText?
concurrency?
disableIntegrityCheck?
intelligent?
intelligentChunkSize?
onProgress?
onRetry?
partSize?
progressInterval?
retry?
retryFactor?
retryMaxTime?
tags?
timeout?

Properties

altText

Optional

altText?: string

Defined in lib/api/upload/types.ts:85

concurrency

Optional

concurrency?: number

Defined in lib/filelink.ts:473

device

Optional

device?: string
Maximum amount of part jobs to run concurrently. Default is 3.

Defined in lib/api/upload/types.ts:30

disableIntegrityCheck

Optional

disableIntegrityCheck?: boolean
Disable checking integrity of uploaded files. On slower devices it can boost upload performance (disable counting md5 from file parts)

Defined in lib/api/upload/types.ts:75

intelligent

Optional

intelligent?: boolean | "fallback"

Enable/disable intelligent ingestion. If truthy then intelligent ingestion must be enabled in your Filestack application. Passing true/false toggles the global intelligent flow (all parts are chunked and committed). Passing 'fallback' will only use FII when network conditions may require it (only failing parts will be chunked).

Defined in lib/api/upload/types.ts:65

intelligentChunkSize

Optional

intelligentChunkSize?: number
Set the default intiial chunk size for Intelligent Ingestion. Defaults to 8MB on desktop and 1MB on mobile.

Defined in lib/api/upload/types.ts:69

onProgress

Optional

onProgress?: ((evt: FSProgressEvent) => void)

Type declaration

  • (evt: FSProgressEvent): void
    Callback for progress events.
Parameters
  • evt: FSProgressEvent

Returns void

Defined in lib/api/upload/types.ts:34

onRetry

Optional

onRetry?: (() => void)

Type declaration

  • (): void
    Callback for retry events.

Returns void

Defined in lib/api/upload/types.ts:42

partSize

Optional

partSize?: number

Maximum size for file slices. Is overridden when intelligent=true. Default is 6 * 1024 * 1024 (6MB).

Defined in lib/api/upload/types.ts:26

progressInterval

Optional

progressInterval?: number
How often to report progress. Default is 1000 (in milliseconds).

Defined in lib/api/upload/types.ts:38

retry

Optional

retry?: number
Retry limit. Default is 10.

Defined in lib/api/upload/types.ts:46

retryFactor

Optional

retryFactor?: number
Factor for exponential backoff on server errors. Default is 2.

Defined in lib/api/upload/types.ts:50

retryMaxTime

Optional

retryMaxTime?: number
Upper bound for exponential backoff. Default is 15000.

Defined in lib/api/upload/types.ts:54

tags

Optional

tags?: UploadTags
Define upload tags to be passed to webhook

Memberof

UploadOptions

Defined in lib/api/upload/types.ts:83

timeout

Optional

timeout?: number
Timeout for network requests. Default is 120000.

Defined in lib/api/upload/types.ts:58

Interface UploadTags

Hierarchy

  • UploadTags

Defined in lib/api/upload/types.ts:22

Indexable

[key: string]: string

Defined in lib/api/upload/file.ts:19

Interface UpscaleParams

Hierarchy

  • UpscaleParams

Defined in lib/filelink.ts:392

Index

noise?
style?
upscale?

Properties

noise

Optional

noise?: NoiseType

Defined in lib/filelink.ts:394

style

Optional

style?: StyleType

Defined in lib/filelink.ts:395

upscale

Optional

upscale?: boolean

Defined in lib/filelink.ts:393

Interface VideoConvertParams

Hierarchy

  • VideoConvertParams

Defined in lib/filelink.ts:435

Index

access?
aspect_mode
audio_bitrate?
audio_channels?
audio_codec?
audio_sample_rate?
clip_length?
clip_offset?
container?
extname?
filename?
force?
fps?
height?
keyframe_interval?
location?
path?
preset?
title?
two_pass?
upscale
video_bitrate?
watermark_bottom?
watermark_height?
watermark_left?
watermark_right?
watermark_top?
watermark_url?
watermark_width?
width?

Properties

access

Optional

access?: VideoAccess

Defined in lib/filelink.ts:444

aspect_mode

aspect_mode: VideoAccessMode

Defined in lib/filelink.ts:436

audio_bitrate

Optional

audio_bitrate?: number

Defined in lib/filelink.ts:446

audio_channels

Optional

audio_channels?: number

Defined in lib/filelink.ts:451

audio_codec

Optional

audio_codec?: AudioTypes

Defined in lib/filelink.ts:447

audio_sample_rate

Optional

audio_sample_rate?: number

Defined in lib/filelink.ts:450

clip_length

Optional

clip_length?: string

Defined in lib/filelink.ts:452

clip_offset

Optional

clip_offset?: string

Defined in lib/filelink.ts:453

container

Optional

container?: string

Defined in lib/filelink.ts:445

extname

Optional

extname?: string

Defined in lib/filelink.ts:440

filename

Optional

filename?: string

Defined in lib/filelink.ts:441

force

Optional

force?: boolean

Defined in lib/filelink.ts:438

fps

Optional

fps?: number

Defined in lib/filelink.ts:457

height

Optional

height?: number

Defined in lib/filelink.ts:455

keyframe_interval

Optional

keyframe_interval?: number

Defined in lib/filelink.ts:458

location

Optional

location?: Locations

Defined in lib/filelink.ts:442

path

Optional

path?: string

Defined in lib/filelink.ts:443

preset

Optional

preset?: VideoTypes

Defined in lib/filelink.ts:437

title

Optional

title?: string

Defined in lib/filelink.ts:439

two_pass

Optional

two_pass?: boolean

Defined in lib/filelink.ts:456

upscale

upscale: boolean

Defined in lib/filelink.ts:448

video_bitrate

Optional

video_bitrate?: number

Defined in lib/filelink.ts:449

watermark_bottom

Optional

watermark_bottom?: number

Defined in lib/filelink.ts:461

watermark_height

Optional

watermark_height?: number

Defined in lib/filelink.ts:465

watermark_left

Optional

watermark_left?: number

Defined in lib/filelink.ts:463

watermark_right

Optional

watermark_right?: number

Defined in lib/filelink.ts:462

watermark_top

Optional

watermark_top?: number

Defined in lib/filelink.ts:460

watermark_url

Optional

watermark_url?: string

Defined in lib/filelink.ts:459

watermark_width

Optional

watermark_width?: number

Defined in lib/filelink.ts:464

width

Optional

width?: number

Defined in lib/filelink.ts:454

Interface VignetteParams

Hierarchy

  • VignetteParams

Defined in lib/filelink.ts:283

Index

amount?
background?
blurmode?

Properties

amount

Optional

amount?: number

Defined in lib/filelink.ts:284

background

Optional

background?: string

Defined in lib/filelink.ts:286

blurmode

Optional

blurmode?: BlurMode

Defined in lib/filelink.ts:285

Interface WatermarkParams

Hierarchy

  • WatermarkParams

Defined in lib/filelink.ts:322

Index

file
position?
size?

Properties

file

file: string

Defined in lib/filelink.ts:323

position

Optional

position?: ImageWatermarkPosition | ImageWatermarkPosition[]

Defined in lib/filelink.ts:325

size

Optional

size?: number

Defined in lib/filelink.ts:324

Interface WebhookValidatePayload

Hierarchy

  • WebhookValidatePayload

Defined in lib/api/security.ts:34

Index

signature
timestamp

Properties

signature

signature: string

Defined in lib/api/security.ts:36

timestamp

timestamp: string

Defined in lib/api/security.ts:35

Interface AnimationParams
Index
Properties
align
background
delay
fit
height
loop
width
Interface AsciiParams
Index
Properties
background
colored
foreground
reverse
size
Interface BlackwhiteParams
Index
Properties
threshold
Interface BlurFacesParams
Index
Properties
amount
blur
buffer
faces
maxsize
minsize
type
Interface BlurParams
Index
Properties
amount
Interface BorderParams
Index
Properties
background
color
width
Interface CacheParams
Index
Properties
cache
expiry
Interface CircleParams
Index
Properties
background
Interface ClientOptions
Indexable
Index
Properties
cname
forwardErrors
security
sessionCache
Interface CollageParams
Index
Properties
color
files
fit
height
margin
width
Interface CompressParams
Index
Properties
metadata
Interface CropFacesParams
Index
Properties
buffer
faces
height
mode
width
Interface CropParams
Index
Properties
dim
Interface DetectFacesParams
Index
Properties
color
export
maxsize
minsize
Interface EnhanceParams
Index
Properties
preset
Interface FallbackParams
Index
Properties
cache
handle
Interface FsAuthConfig
Index
Properties
password
username
Interface FsRequestHeaders
Indexable
Interface FsRequestOptions
Index
Properties
auth
blobResponse
cache
cancelToken
data
filestackHeaders
headers
method
mode
onProgress
params
redirect
retry
runtime
timeout
url
Interface FsRequestParams
Indexable
Interface FsRequestRuntime
Indexable
Index
Properties
retryCount
Interface FsResponse
Index
Properties
config
data
headers
status
statusText
Interface FsRetryConfig
Index
Properties
onRetry
retry
retryFactor
retryMaxTime
Interface MetadataOptions
Index
Properties
cloud
container
exif
filename
height
location
md5
mimetype
path
sha1
sha224
sha256
sha384
sha512
size
sourceUrl
uploaded
width
writeable
Interface MinifyCssParams
Index
Properties
gzip
level
Interface MinifyJsParams
Index
Properties
gzip
keep_class_name
keep_fn_name
mangle
merge_vars
remove_console
remove_undefined
targets
use_babel_polyfill
Interface ModulateParams
Index
Properties
brightness
hue
saturation
Interface OilPaintParams
Index
Properties
amount
Interface OutputParams
Index
Properties
background
colorspace
compress
density
docinfo
format
page
pageformat
pageorientation
quality
secure
strip
Interface PartialBlurParams
Index
Properties
amount
blur
objects
type
Interface PartialPixelateParams
Index
Properties
amount
blur
objects
type
Interface PdfConvertParams
Index
Properties
pageformat
pageorientation
pages
Interface PdfInfoParams
Index
Properties
colorinfo
Interface PickerFileMetadata
Index
Properties
alt
container
cropped
filename
handle
key
mimetype
originalFile
originalPath
rotated
size
source
status
uploadId
url
Interface PickerInstance
Index
Properties
cancel
close
crop
open
Interface PickerOptions
Index
Properties
accept
acceptFn
allowManualRetry
cleanupImageExif
concurrency
container
customAuthText
customSourceContainer
customSourceName
customSourcePath
customText
disableAltText
disableDirectoryUpload
disableStorageKey
disableThumbnails
disableTransformer
displayMode
dropPane
errorsTimeout
exposeOriginalFile
fromSources
globalDropZone
hideModalWhenUploading
imageDim
imageMax
imageMin
lang
maxFiles
maxSize
minFiles
miniUploader
modalSize
multipleFileUpload
onCancel
onClose
onFileCropped
onFileSelected
onFileUploadCancel
onFileUploadFailed
onFileUploadFinished
onFileUploadProgress
onFileUploadStarted
onOpen
onUploadDone
onUploadStarted
pasteMode
rootId
startUploadingWhenMaxFilesReached
storeTo
supportEmail
transformations
transformationsUI
uploadConfig
uploadInBackground
useSentryBreadcrumbs
videoResolution
viewType
websearch
Interface PickerResponse
Index
Properties
filesFailed
filesUploaded
Interface PickerUploadDoneCallback
Interface PixelateFacesParams
Index
Properties
amount
blur
buffer
faces
maxsize
minsize
type
Interface PixelateParams
Index
Properties
amount
Interface PolaroidParams
Index
Properties
background
color
rotate
Interface PreviewOptions
Index
Properties
css
id
Interface ProgressiveJpgParams
Index
Properties
metadata
quality
Interface QualityParams
Index
Properties
value
Interface ResizeParams
Index
Properties
align
fit
height
width
Interface RetrieveOptions
Index
Properties
cache
dl
extension
head
metadata
Interface RotateParams
Index
Properties
background
color
deg
Interface RoundedCornersParams
Index
Properties
background
blur
radius
Interface Security
Index
Properties
policy
signature
Interface SecurityOptions
Index
Properties
call
container
expiry
handle
maxSize
minSize
path
url
Interface SecurityParams
Index
Properties
policy
signature
Interface SepiaParams
Index
Properties
tone
Interface ShadowParams
Index
Properties
background
blur
color
opacity
vector
Interface SharpenParams
Index
Properties
amount
Interface SmartCropParams
Index
Properties
height
mode
width
Interface StoreBaseParams
Index
Properties
access
container
disableStorageKey
location
path
region
Interface TornEdgesParams
Index
Properties
background
spread
Interface TransformOptions
Index
Properties
ascii
blackwhite
blur
blur_faces
border
cache
circle
collage
compress
crop
crop_faces
detect_faces
enchance
flip
flop
imagesize
modulate
monochrome
negative
no_metadata
oil_paint
output
partial_blur
partial_pixelate
pdfconvert
pdfinfo
pixelate
pixelate_faces
pjpg
polaroid
quality
redeye
resize
rotate
rounded_corners
security
sepia
sfw
shadow
sharpen
smart_crop
store
tags
torn_edges
upscale
urlscreenshot
video_convert
vignette
watermark
Interface URLScreenshotParams
Index
Properties
agent
delay
device
height
mode
orientation
width
Interface UploadOptions
Index
Properties
altText
concurrency
device
disableIntegrityCheck
intelligent
intelligentChunkSize
onProgress
onRetry
partSize
progressInterval
retry
retryFactor
retryMaxTime
tags
timeout
Interface UploadTags
Indexable
Interface UpscaleParams
Index
Properties
noise
style
upscale
Interface VideoConvertParams
Index
Properties
access
aspect_mode
audio_bitrate
audio_channels
audio_codec
audio_sample_rate
clip_length
clip_offset
container
extname
filename
force
fps
height
keyframe_interval
location
path
preset
title
two_pass
upscale
video_bitrate
watermark_bottom
watermark_height
watermark_left
watermark_right
watermark_top
watermark_url
watermark_width
width
Interface VignetteParams
Index
Properties
amount
background
blurmode
Interface WatermarkParams
Index
Properties
file
position
size
Interface WebhookValidatePayload
Index
Properties
signature
timestamp