Javascript SDK for the Filestack API and content management system.

Table of Contents

- What's in the box?
- Installation
- API Documentation
- Usage
  - Browsers
    - ES module
    - UMD module
    - GZIP support
    - SRI
  - Node
    - CommonJS module
- Module Overview
- Releases Info
- Live examples (JSFiddle)
- Picker Quick Start
- Promises
- Development
- Debugging
  - Node
  - Browser
- Versioning
- Contributing

## What's in the box?

- A multi-part uploader powered on the backend by the Filestack CIN.
- An interface to the Filestack Processing Engine for transforming assets via URLs.
- The Filestack Picker - an upload widget for the web that integrates over a dozen cloud providers and provides pre-upload image editing.

## Installation

    npm install filestack-js

## API Documentation

https://filestack.github.io/filestack-js/

## Usage

### Browsers

#### ES module

    import * as filestack from 'filestack-js';
    const client = filestack.init('apikey');

#### UMD module

    <script src="//static.filestackapi.com/filestack-js/{MAJOR_VERSION}.x.x/filestack.min.js" crossorigin="anonymous"></script>
    <script>
      const client = filestack.init('apikey');
    </script>

where `{MAJOR_VERSION}` is one of the MAJOR versions of the filestack-js ie:

    <script src="//static.filestackapi.com/filestack-js/3.x.x/filestack.min.js" crossorigin="anonymous"></script>
    <script>
      const client = filestack.init('apikey');
    </script>

#### GZIP support

To speed up library loading you can use gzipped file available after adding gz to file extension

    <script src="//static.filestackapi.com/filestack-js/{MAJOR_VERSION}.x.x/filestack.min.js.gz" crossorigin="anonymous"></script>
    <script>
      const client = filestack.init('apikey');
    </script>

#### SRI

Subresource Integrity (SRI) is a security feature that enables browsers to verify that files they fetch (for example, from a CDN) are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched file must match

To obtain sri hashes for filestack-js library check manifest.json file on CDN:

    https://static.filestackapi.com/filestack-js/{LIBRARY_VERSION}/manifest.json

    <script src="//static.filestackapi.com/filestack-js/{LIBRARY_VERSION}/filestack.min.js.gz" integrity="{FILE_HASH}" crossorigin="anonymous"></script>

Where `{LIBRARY_VERSION}` is currently used library version and `{FILE_HASH}` is one of the hashes from integrity field in manifest.json file

### Node

#### CommonJS module

    const client = require('filestack-js').init('apikey');

## Module Overview

The `package.json` specifies two separate modules:

- `main` for the CommonJS module (intended for Node runtimes)
- `browser` for the pre-bundled ES module (intended for browser runtimes)

Node projects which depend on filestack-js will follow the `main` field in `package.json`. When building for the browser, newer tools (like Webpack, Rollup, and Parcel) follow the `browser` field, which will resolve to the pre-bundled ES module. Both modules follow the same API, but some methods behave differently based on their runtime. For example, `client.upload` treats the file argument as a file path in Node but in browsers it assumes a Blob object.

The pre-bundled browser module is also available in UMD format. This is useful if you are using script tags on a web page instead of bundling your application. It can be retrieved from both the Filestack CDN and the unpkg CDN:

- Filestack CDN
- unpkg

## Releases Info

Major releases will bo listed (with detailed examples) in releases folder starting from version 3.0.0

## Live examples (JSFiddle)

Upload image
Multiupload
Open picker
Open picker in inline mode
Crop images
Multiple drop panes
Preview
Import using RequireJS
Retrieve image data
Transform image
Custom Picker CSS
Assign file to user

Examples can be run locally with:

    npm run examples

## Picker Quick Start

If you are here to use the picker widget, it can be initialized from the Filestack client by calling `client.picker(options)`. Options for the picker are documented here.

The picker instance returned from `client.picker` can be controlled with a few methods:

- open - Create the application and mount it into the DOM based on the `displayMode`.
- close - Close the application and remove its resources from the DOM.
- crop(files) - Create the application, mount it, and pre-select the passed files for cropping.
- cancel - Cancel all uploads controlled by this instance.

Please see our examples above to learn more about customizing the picker for your use case.

## Promises

This library requires an environment that implements the `Promise` object spec. If you target IE11 or iOS before 8.0 you will need to add a `Promise` and `Symbol` polyfill to your page or application.

Polyfills we recommend:**

Module (for bundling):

- https://babeljs.io/docs/en/babel-polyfill

Script (for script tag):

- https://polyfill.io/v3/polyfill.min.js?features=Promise%2CPromise.prototype.finally%2CSymbol

## Development

Most tests in this library are expected to interface with actual backend services. Because we like to run tests during development, these services are mocked during unit testing.

All tests are using Jest.

To run units:

    npm test

## Debugging

Filestack-js uses `debug`, so just run with environmental variable `DEBUG` set to `fs.*`.

### Node

    DEBUG=fs.* node example_upload.js

### Browser

Debug's enable state is persisted by localStorage

    localStorage.debug = 'fs:*'

And then refresh the page.

## Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

## Contributing

We follow the conventional commits specification to ensure consistent commit messages and changelog formatting.

## Index

### Enumerations

- AlignFacesOptions
- AlignOptions
- BlurMode
- ColorspaceType
- CropfacesType
- EAlignFacesOptions
- EAlignOptions
- EBlurMode
- EColorspaceType
- ECropfacesType
- EFitOptions
- ENoiseType
- ERequestMethod
- EResponseType
- EShapeType
- EStyleType
- EUrlscreenshotAgent
- EUrlscreenshotMode
- EUrlscreenshotOrientation
- EVideoAccess
- EVideoAccessMode
- EVideoLocations
- EVideoTypes
- FileState
- FilestackErrorType
- FitOptions
- Locations
- NoiseType
- PickerDisplayMode
- RotateDirection
- ShapeType
- StyleType
- URLScreenshotAgent
- URLScreenshotMode
- URLScreenshotOrientation
- UploadMode
- VideoAccess
- VideoAccessMode
- VideoTypes

### Classes

- Client
- CloudClient
- File
- Filelink
- FilestackError
- PickerLoader
- S3Uploader
- Upload
- UploaderAbstract

### Interfaces

- AsciiParams
- BlackwhiteParams
- BlurFacesParams
- BlurParams
- BorderParams
- CacheParams
- CircleParams
- ClientOptions
- CollageParams
- Config
- CropFacesParams
- CropParams
- CustomAuthTextOptions
- DetectFacesParams
- FSProgressEvent
- FallbackParams
- FileChunk
- FileInstance
- FilePart
- FilePartMetadata
- Hosts
- MetadataOptions
- MinifyCssParams
- MinifyJsParams
- ModulateParams
- OilPaintParams
- OutputParams
- PartialBlurParams
- PartialPixelateParams
- PdfConvertParams
- PdfInfoParams
- PickerCropOptions
- PickerCroppedData
- PickerCustomText
- PickerDropPaneOptions
- PickerFileCallback
- PickerFileErrorCallback
- PickerFileMetadata
- PickerFileProgressCallback
- PickerInstance
- PickerOptions
- PickerResponse
- PickerRotatedData
- PickerStoreOptions
- PickerTransformationOptions
- PickerUploadDoneCallback
- PickerUploadStartedCallback
- PixelateFacesParams
- PixelateParams
- PolaroidParams
- PreviewOptions
- ProgressEvent
- QualityParams
- ResizeParams
- RetrieveOptions
- RetryConfig
- RotateParams
- RoundedCornersParams
- Security
- SecurityOptions
- SecurityParams
- SepiaParams
- Session
- ShadowParams
- SharpenParams
- StoreBaseParams
- TornEdgesParams
- TransformOptions
- URLScreenshotParams
- UploadOptions
- UploadPart
- UploadPayload
- UpscaleParams
- VideoConvertParams
- VignetteParams
- WorkflowConfig

### Type aliases

- InputFile
- NamedInputFile
- RawFile
- SanitizeOptions
- StoreParams
- StoreUploadOptions

### Variables

- COMPLETE_TIMEOUT
- DEFAULT_PART_SIZE
- DEFAULT_PROGRESS_INTERVAL
- DEFAULT_STORE_LOCATION
- INTELLIGENT_CHUNK_SIZE
- INTELLIGENT_MOBILE_CHUNK_SIZE
- JSDOM
- MIN_CHUNK_SIZE
- MIN_PART_SIZE
- PICKER_KEY
- PICKER_VERSION
- RESPONSE_DEBUG_PREFIX
- base64Gif
- base64Png
- base64Regexp
- base64Svg
- debug
- handleRegexp
- htmlCommentsRegexp
- last
- mobileRegexp
- mockAppendChild
- mockList
- mockLogout
- mockMetadata
- mockPrefetch
- mockStore
- mockTokInit
- mockTokStart
- mockTokStop
- mockedTestFile
- sanitizeOptions
- scope
- sessionURls
- svgRegexp
- testApiKey
- testCloudToken
- testTokArchiveId
- testTokSession
- v
- version

### Functions

- b64
- b64toBlob
- createFile
- filterObject
- getFile
- getFileBrowser
- getFileNode
- getMimetype
- getSecurity
- getUrl
- getValidator
- init
- isFileBase
- isFileBlob
- isFileBrowser
- isFileBuffer
- isFileNamed
- isFilePath
- isMobile
- isNode
- isSvg
- md5
- metadata
- normalizeProgress
- picker
- postWithRetry
- preview
- readFile
- remove
- removeEmpty
- requestWithSource
- requireNode
- resolveCdnUrl
- resolveHost
- retrieve
- sanitizeName
- shouldRetry
- storeURL
- toSnakeCase
- transform
- uniqueId
- uniqueTime
- useDebugInterceptor
- useRetryPolicy

### Object literals

- DefinitionsSchema
- MetadataParamsSchema
- PickerParamsSchema
- PreviewParamsSchema
- RetrieveParamsSchema
- SecurityParamsSchema
- StoreParamsSchema
- TransformSchema
- UploadParamsSchema
- config
- defaultSession
- testSecurity
- testSession

## Type aliases

### InputFile

InputFile: RawFile | NamedInputFile

- Defined in lib/api/upload/file_tools.ts:27

### NamedInputFile

NamedInputFile: object

- Defined in lib/api/upload/file_tools.ts:22

#### Type declaration

- ##### file: RawFile

- ##### Optional name?: string

### RawFile

RawFile: Blob | Buffer | File | string

- Defined in lib/api/upload/file_tools.ts:21

### SanitizeOptions

SanitizeOptions: false | true | object

- Defined in lib/utils/index.ts:191

Sanitizer Options

### StoreParams

StoreParams: StoreBaseParams & object

- Defined in lib/filelink.ts:182

Available options for store transformations

export
interface

  StoreParams

### StoreUploadOptions

StoreUploadOptions: StoreBaseParams & object

- Defined in lib/api/upload/types.ts:71

## Variables

### Const COMPLETE_TIMEOUT

COMPLETE_TIMEOUT: number = 1000 * 1

- Defined in lib/api/upload/uploaders/s3.ts:31

### Const DEFAULT_PART_SIZE

DEFAULT_PART_SIZE: number = 6 * 1024 * 1024

- Defined in lib/api/upload/uploaders/abstract.ts:28

### Const DEFAULT_PROGRESS_INTERVAL

DEFAULT_PROGRESS_INTERVAL: 1000 = 1000

- Defined in lib/api/upload/upload.ts:36

### Const DEFAULT_STORE_LOCATION

DEFAULT_STORE_LOCATION: "s3" = "s3"

- Defined in lib/api/upload/uploaders/abstract.ts:42

### Const INTELLIGENT_CHUNK_SIZE

INTELLIGENT_CHUNK_SIZE: number = 8 * 1024 * 1024

- Defined in lib/api/upload/uploaders/abstract.ts:34

### Const INTELLIGENT_MOBILE_CHUNK_SIZE

INTELLIGENT_MOBILE_CHUNK_SIZE: number = 1024 * 1024

- Defined in lib/api/upload/uploaders/abstract.ts:37

### JSDOM

JSDOM: any

- Defined in schema/picker.schema.spec.browser.ts:22

### Const MIN_CHUNK_SIZE

MIN_CHUNK_SIZE: number = 32 * 1024

- Defined in lib/api/upload/uploaders/abstract.ts:40

### Const MIN_PART_SIZE

MIN_PART_SIZE: number = 5 * 1024 * 1024

- Defined in lib/api/upload/uploaders/abstract.ts:31

### Private Const PICKER_KEY

PICKER_KEY: "__fs_picker_token" = "__fs_picker_token"

- Defined in lib/api/cloud.ts:27

### Private Const PICKER_VERSION

PICKER_VERSION: "1.4.9" = "1.4.9"

- Defined in config.ts:21

### Const RESPONSE_DEBUG_PREFIX

RESPONSE_DEBUG_PREFIX: "x-filestack-" = "x-filestack-"

- Defined in lib/api/request.ts:23

### Const base64Gif

base64Gif: "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" = "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="

- Defined in lib/api/upload/file_tools.spec.browser.ts:26

### Const base64Png

base64Png: "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==" = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="

- Defined in lib/api/upload/file_tools.spec.browser.ts:25

### Const base64Regexp

base64Regexp: RegExp = /data:([a-zA-Z]*\/[a-zA-Z]*);base64,([^\"]*)/i

- Defined in lib/api/upload/file_tools.ts:29

### Const base64Svg

base64Svg: "PHN2ZyBoZWlnaHQ9IjEwMCIgd2lkdGg9IjEwMCI+CiAgPGNpcmNsZSBjeD0iNTAiIGN5PSI1MCIgcj0iNDAiIHN0cm9rZT0iYmxhY2siIHN0cm9rZS13aWR0aD0iMyIgZmlsbD0icmVkIiAvPgogIFNvcnJ5LCB5b3VyIGJyb3dzZXIgZG9lcyBub3Qgc3VwcG9ydCBpbmxpbmUgU1ZHLiAgCjwvc3ZnPiA=" = "PHN2ZyBoZWlnaHQ9IjEwMCIgd2lkdGg9IjEwMCI+CiAgPGNpcmNsZSBjeD0iNTAiIGN5PSI1MCIgcj0iNDAiIHN0cm9rZT0iYmxhY2siIHN0cm9rZS13aWR0aD0iMyIgZmlsbD0icmVkIiAvPgogIFNvcnJ5LCB5b3VyIGJyb3dzZXIgZG9lcyBub3Qgc3VwcG9ydCBpbmxpbmUgU1ZHLiAgCjwvc3ZnPiA="

- Defined in lib/api/upload/file_tools.spec.browser.ts:24
- Defined in lib/api/upload/file_tools.spec.node.ts:25

### Const debug

debug: any = Debug('fs:upload:s3')

- Defined in lib/api/request.ts:21
- Defined in lib/filelink.ts:25
- Defined in lib/api/upload/uploaders/abstract.ts:44
- Defined in lib/api/upload/uploaders/s3.ts:29

### Const handleRegexp

handleRegexp: RegExp = /^[\w\-]{20}$/

- Defined in lib/filelink.ts:450

### Const htmlCommentsRegexp

htmlCommentsRegexp: RegExp = /<!--([\s\S]*?)-->/g

- Defined in lib/utils/index.ts:25

### Let last

last: any

- Defined in lib/utils/index.ts:97

Returns unique time

### Const mobileRegexp

mobileRegexp: RegExp = /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series[46]0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino|android|ipad|playbook|silk/i

- Defined in lib/utils/index.ts:24

### Const mockAppendChild

mockAppendChild: Mock<any, any> = jest.fn()

- Defined in lib/api/preview.spec.browser.ts:20

### Const mockList

mockList: Mock<any, any> = jest.fn().mockName('list').mockImplementation(data => {if (data && data.clouds.token) {return { token: testCloudToken };}return data;})

- Defined in lib/api/cloud.spec.browser.ts:66

### Const mockLogout

mockLogout: Mock<any, any> = jest.fn().mockName('logout').mockImplementation((url, data) => {const params = data ? JSON.parse(data) : {};if (data && params.clouds && params.clouds.token) {return { token: testCloudToken };}return data;})

- Defined in lib/api/cloud.spec.browser.ts:77

### Const mockMetadata

mockMetadata: Mock<any, any> = jest.fn().mockName('metadata').mockReturnValue('metadata')

- Defined in lib/api/cloud.spec.browser.ts:56

### Const mockPrefetch

mockPrefetch: Mock<any, any> = jest.fn().mockName('prefetch').mockReturnValue('prefetch')

- Defined in lib/api/cloud.spec.browser.ts:61

### Const mockStore

mockStore: Mock<any, any> = jest.fn().mockName('store').mockImplementation(params => {if (params && params.clouds && params.clouds.token) {return JSON.stringify({ token: testCloudToken });}return JSON.stringify(params);})

- Defined in lib/api/cloud.spec.browser.ts:90

### Const mockTokInit

mockTokInit: Mock<any, any> = jest.fn().mockName('tokInit').mockReturnValue('init')

- Defined in lib/api/cloud.spec.browser.ts:41

### Const mockTokStart

mockTokStart: Mock<any, any> = jest.fn().mockName('tokStart').mockReturnValue('start')

- Defined in lib/api/cloud.spec.browser.ts:46

### Const mockTokStop

mockTokStop: Mock<any, any> = jest.fn().mockName('tokStop').mockReturnValue('stop')

- Defined in lib/api/cloud.spec.browser.ts:51

### Const mockedTestFile

mockedTestFile: Buffer = Buffer.from('text text')

- Defined in lib/api/upload/file_tools.spec.node.ts:24

### Const sanitizeOptions

sanitizeOptions: Mock<any, any> = jest.fn().mockName('sanitizeOptions')

- Defined in lib/api/upload/file_tools.spec.browser.ts:22

### Let scope

scope: any = nock(sessionURls.cloudApiUrl)

- Defined in lib/api/cloud.spec.browser.ts:39

### Const sessionURls

sessionURls: object = config.urls

- Defined in lib/api/cloud.spec.browser.ts:33

#### Type declaration

- ##### cdnUrl: string

- ##### cloudApiUrl: string

- ##### fileApiUrl: string

- ##### pickerUrl: string

- ##### uploadApiUrl: string

### Const svgRegexp

svgRegexp: RegExp = /^\s*(?:<\?xml[^>]*>\s*)?(?:<!doctype svg[^>]*\s*(?:\[?(?:\s*<![^>]*>\s*)*\]?)*[^>]*>\s*)?<svg[^>]*>[^]*<\/svg>\s*$/i

- Defined in lib/utils/index.ts:26

### Const testApiKey

testApiKey: "API_KEY" = "API_KEY"

- Defined in lib/api/cloud.spec.browser.ts:22

### Const testCloudToken

testCloudToken: "testCloudToken" = "testCloudToken"

- Defined in lib/api/cloud.spec.browser.ts:26

### Const testTokArchiveId

testTokArchiveId: "ARCHIVE_ID" = "ARCHIVE_ID"

- Defined in lib/api/cloud.spec.browser.ts:24

### Const testTokSession

testTokSession: "TOK_SESSION" = "TOK_SESSION"

- Defined in lib/api/cloud.spec.browser.ts:23

### Const v

v: Validator = new Validator()

- Defined in schema/validator.ts:20

### Const version

version: "@{VERSION}" = "@{VERSION}"

- Defined in index.ts:35

filestack-js version. Interpolated at build time.

## Functions

### Const b64

- b64(data: string): string

- - Defined in lib/utils/index.ts:167

  return based string

  #### Parameters

  - ##### data: string

  #### Returns string

### Private Const b64toBlob

- b64toBlob(b64Data: string, sliceSize?: number): Blob

- - Defined in lib/api/upload/file_tools.ts:107

  Convert encoded base64 string or dataURI to blob

  #### Parameters

  - ##### b64Data: string

  - ##### Default value sliceSize: number = 512

    Byte quantity to split data into

  #### Returns Blob

### Const createFile

- createFile(size?: number, name?: string, type?: string): File

- - Defined in lib/api/upload/file_tools.spec.browser.ts:20

  #### Parameters

  - ##### Default value size: number = 44320

  - ##### Default value name: string = "test.png"

  - ##### Default value type: string = "image/png"

  #### Returns File

### Const filterObject

- filterObject(toFilter: any, requiredFields: string[]): any

- - Defined in lib/utils/index.ts:233

  Filter object to given fields

  #### Parameters

  - ##### toFilter: any

  - ##### requiredFields: string[]

  #### Returns any

### Const getFile

- getFile(input: InputFile, sanitizeOptions?: SanitizeOptions): Promise<File>

- - Defined in lib/api/upload/file_tools.ts:258

  #### Parameters

  - ##### input: InputFile

  - ##### Optional sanitizeOptions: SanitizeOptions

  #### Returns Promise<File>

### Const getFileBrowser

- getFileBrowser(input: InputFile, sanitizeOptions?: SanitizeOptions): Promise<FsFile>

- - Defined in lib/api/upload/file_tools.ts:163

  Accepts b64string or blob file

  #### Parameters

  - ##### input: InputFile

  - ##### Optional sanitizeOptions: SanitizeOptions

  #### Returns Promise<FsFile>

### Const getFileNode

- getFileNode(input: InputFile, sanitizeOptions?: SanitizeOptions): Promise<FsFile>

- - Defined in lib/api/upload/file_tools.ts:205

  Accepts Buffer or filepath or base64 string

  #### Parameters

  - ##### input: InputFile

  - ##### Optional sanitizeOptions: SanitizeOptions

  #### Returns Promise<FsFile>

### Const getMimetype

- getMimetype(file: Uint8Array | Buffer): string

- - Defined in lib/utils/index.ts:141

  Check if input is a svg

  #### Parameters

  - ##### file: Uint8Array | Buffer

  #### Returns string

  - mimetype

### Const getSecurity

- getSecurity(policyOptions: SecurityOptions, appSecret: string): Security

- - Defined in lib/api/security.ts:53

  Returns Filestack base64 policy and HMAC-SHA256 signature

  ### Example

      import * as filestack from 'filestack-js';

      const jsonPolicy = { 'expiry': 253381964415 };
      const security = filestack.getSecurity(jsonPolicy, '<YOUR_APP_SECRET>');

  #### Parameters

  - ##### policyOptions: SecurityOptions

  - ##### appSecret: string

  #### Returns Security

### Private Const getUrl

- getUrl(session: Session, handle: string, opts?: any, security?: Security): string

- - Defined in lib/api/preview.ts:44

  Returns file preview url

  #### Parameters

  - ##### session: Session

  - ##### handle: string

  - ##### Optional opts: any

  - ##### Optional security: Security

  #### Returns string

### Const getValidator

- getValidator(schema: any): (Anonymous function)

- - Defined in schema/validator.ts:29

  Returns validator instance

  #### Parameters

  - ##### schema: any

  #### Returns (Anonymous function)

### Const init

- init(apikey: string, options?: ClientOptions): Client

- - Defined in index.ts:28

  Initialize client with given config

  #### Parameters

  - ##### apikey: string

  - ##### Optional options: ClientOptions

  #### Returns Client

### Const isFileBase

- isFileBase(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:58

  Check if file is base64 string

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isFileBlob

- isFileBlob(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:43

  Check if file is blob

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isFileBrowser

- isFileBrowser(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:51

  Check if input is instance of browser file

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isFileBuffer

- isFileBuffer(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:37

  Check if file is buffer

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isFileNamed

- isFileNamed(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:88

  Check if file is instance of named interface

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isFilePath

- isFilePath(input: InputFile): boolean

- - Defined in lib/api/upload/file_tools.ts:96

  Check if input is a valid file path

  #### Parameters

  - ##### input: InputFile

  #### Returns boolean

### Const isMobile

- isMobile(): boolean

- - Defined in lib/utils/index.ts:92

  Returns if browser is a mobile device (if node env always return false)

  #### Returns boolean

### Const isNode

- isNode(): string

- - Defined in lib/utils/index.ts:86

  Returns information about current env (browser|nodejs)

  #### Returns string

### Const isSvg

- isSvg(input: Uint8Array | Buffer): boolean

- - Defined in lib/utils/index.ts:133

  Check if input is a svg

  #### Parameters

  - ##### input: Uint8Array | Buffer

  #### Returns boolean

### Private Const md5

- md5(data: any): string

- - Defined in lib/utils/index.ts:119

  Calculates a MD5 checksum for passed buffer

  #### Parameters

  - ##### data: any

    Data to be hashed

  #### Returns string

  base64 encoded MD5 hash

### Private Const metadata

- metadata(session: Session, handle?: string, opts?: MetadataOptions, security?: Security): Promise<any>

- - Defined in lib/api/file.ts:89

  Returns file metadata

  #### Parameters

  - ##### session: Session

  - ##### Optional handle: string

  - ##### Optional opts: MetadataOptions

  - ##### Optional security: Security

  #### Returns Promise<any>

### Const normalizeProgress

- normalizeProgress(current: any, last: any): any

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

  #### Parameters

  - ##### current: any

  - ##### last: any

  #### Returns any

### Private Const picker

- picker(client: Client, options?: PickerOptions): PickerInstance

- - Defined in lib/picker.ts:728

  Loads and creates picker instance

  #### Parameters

  - ##### client: Client

  - ##### Optional options: PickerOptions

  #### Returns PickerInstance

### Const postWithRetry

- postWithRetry(url: string, fields: Object, config?: AxiosRequestConfig, retryConfig?: RetryConfig): Promise<AxiosResponse>

- - Defined in lib/api/request.ts:55

  #### Parameters

  - ##### url: string

  - ##### fields: Object

  - ##### Default value config: AxiosRequestConfig = {}

  - ##### Optional retryConfig: RetryConfig

  #### Returns Promise<AxiosResponse>

### Private Const preview

- preview(session: Session, handle?: string, opts?: PreviewOptions): HTMLIFrameElement | Window

- - Defined in lib/api/preview.ts:80

  Appends image preview into page

  #### Parameters

  - ##### session: Session

  - ##### Optional handle: string

  - ##### Optional opts: PreviewOptions

  #### Returns HTMLIFrameElement | Window

### Private Const readFile

- readFile(file: any): Promise<any>

- - Defined in lib/api/upload/file_tools.ts:140

  Read file as array buffer

  #### Parameters

  - ##### file: any

  #### Returns Promise<any>

### Private Const remove

- remove(session: Session, handle?: string, skipStorage?: boolean, security?: Security): Promise<any>

- - Defined in lib/api/file.ts:32

  Remove given file

  #### Parameters

  - ##### session: Session

  - ##### Optional handle: string

  - ##### Optional skipStorage: boolean

  - ##### Optional security: Security

  #### Returns Promise<any>

### Private Const removeEmpty

- removeEmpty(obj: any): any

- - Defined in lib/utils/index.ts:77

  Removes empty options from object

  #### Parameters

  - ##### obj: any

  #### Returns any

### Private Const requestWithSource

- requestWithSource(retryConfig?: RetryConfig): AxiosInstance

- - Defined in lib/api/request.ts:38

  #### Parameters

  - ##### Optional retryConfig: RetryConfig

  #### Returns AxiosInstance

### Const requireNode

- requireNode(name: string): any

- - Defined in lib/utils/index.ts:180

  Hides require from buindling by weback to browser

  #### Parameters

  - ##### name: string

  #### Returns any

### Private Const resolveCdnUrl

- resolveCdnUrl(session: Session, handle: string): string

- - Defined in lib/utils/index.ts:35

  Resolve cdn url based on handle type

  #### Parameters

  - ##### session: Session

    session object

  - ##### handle: string

    file handle (hash, src://alias, url)

  #### Returns string

### Private Const resolveHost

- resolveHost(urls: Hosts, cname: string): Hosts

- - Defined in lib/utils/index.ts:57

  Resolve all urls with provided cnames

  #### Parameters

  - ##### urls: Hosts

  - ##### cname: string

  #### Returns Hosts

### Private Const retrieve

- retrieve(session: Session, handle: string, options?: RetrieveOptions, security?: Security): Promise<Object | Blob>

- - Defined in lib/api/file.ts:147

  Returns file information

  #### Parameters

  - ##### session: Session

  - ##### handle: string

  - ##### Default value options: RetrieveOptions = {}

  - ##### Optional security: Security

  #### Returns Promise<Object | Blob>

### Const sanitizeName

- sanitizeName(name: string, options?: SanitizeOptions): string

- - Defined in lib/utils/index.ts:204

  Sanitize file name

  #### Parameters

  - ##### name: string

  - ##### Default value options: SanitizeOptions = true

    enable,disable sanitizer, default enabled

  #### Returns string

### Const shouldRetry

- shouldRetry(err: AxiosError): boolean

- - Defined in lib/api/request.ts:78

  #### Parameters

  - ##### err: AxiosError

  #### Returns boolean

### Private Const storeURL

- storeURL(session: Session, url?: string, opts?: StoreParams, token?: any, security?: Security): Promise<any>

- - Defined in lib/api/store.ts:33

  #### Parameters

  - ##### session: Session

  - ##### Optional url: string

  - ##### Optional opts: StoreParams

  - ##### Optional token: any

  - ##### Optional security: Security

  #### Returns Promise<any>

### Private Const toSnakeCase

- toSnakeCase(original: object): object

- - Defined in lib/api/transform.ts:24

  #### Parameters

  - ##### original: object

    - ##### [index: string]: any

  #### Returns object

  - ##### [index: string]: any

### Private Const transform

- transform(session: Session, url: string | string[], options?: TransformOptions, b64?: boolean): string

- - Defined in lib/api/transform.ts:448

  Creates filestack transform url. Transform params can be provided in camelCase or snakeCase style

  #### Parameters

  - ##### session: Session

  - ##### url: string | string[]

    url, handle or array of elements

  - ##### Default value options: TransformOptions = {}

    Transformation options

  - ##### Default value b64: boolean = false

  #### Returns string

### Const uniqueId

- uniqueId(len?: number): string

- - Defined in lib/utils/index.ts:109

  Generates random string with provided length

  #### Parameters

  - ##### Default value len: number = 10

  #### Returns string

### Const uniqueTime

- uniqueTime(): any

- - Defined in lib/utils/index.ts:98

  #### Returns any

### Const useDebugInterceptor

- useDebugInterceptor(instance: any): void

- - Defined in lib/api/request.ts:103

  #### Parameters

  - ##### instance: any

  #### Returns void

### Const useRetryPolicy

- useRetryPolicy(instance: AxiosInstance, retryConfig: RetryConfig): number

- - Defined in lib/api/request.ts:120

  #### Parameters

  - ##### instance: AxiosInstance

  - ##### retryConfig: RetryConfig

  #### Returns number

## Object literals

### Const DefinitionsSchema

DefinitionsSchema: object

- Defined in schema/definitions.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/definitions.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/definitions.schema.ts:22

### description

description: string = "Filestack common definitions"

- Defined in schema/definitions.schema.ts:20

### title

title: string = "Filestack"

- Defined in schema/definitions.schema.ts:19

### type

type: string = "object"

- Defined in schema/definitions.schema.ts:21

### definitions

definitions: object

- Defined in schema/definitions.schema.ts:23

### colorDef

colorDef: object

- Defined in schema/definitions.schema.ts:72

### id

id: string = "colorDef"

- Defined in schema/definitions.schema.ts:73

### oneOf

oneOf: (object | object)[] = [{type: 'string',pattern: '^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$', // without # at the begining}, {type: 'string',enum: ['aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure', 'beige', 'bisque', 'black', 'blanchedalmond', 'blue', 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey', 'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick', 'floralwhite', 'forestgreen', 'fractal', 'fuchsia', 'gainsboro', 'ghostwhite', 'gold', 'goldenrod', 'gray0', 'gray1', 'gray2', 'gray3', 'gray4', 'gray5', 'gray6', 'gray7', 'gray8', 'gray9', 'gray10', 'gray11', 'gray12', 'gray13', 'gray14', 'gray15', 'gray16', 'gray17', 'gray18', 'gray19', 'gray20', 'gray21', 'gray22', 'gray23', 'gray24', 'gray25', 'gray26', 'gray27', 'gray28', 'gray29', 'gray30', 'gray31', 'gray32', 'gray33', 'gray34', 'gray35', 'gray36', 'gray37', 'gray38', 'gray39', 'gray40', 'gray41', 'gray42', 'gray43', 'gray44', 'gray45', 'gray46', 'gray47', 'gray48', 'gray49', 'gray50', 'gray51', 'gray52', 'gray53', 'gray54', 'gray55', 'gray56', 'gray57', 'gray58', 'gray59', 'gray60', 'gray61', 'gray62', 'gray63', 'gray64', 'gray65', 'gray66', 'gray67', 'gray68', 'gray69', 'gray70', 'gray71', 'gray72', 'gray73', 'gray74', 'gray75', 'gray76', 'gray77', 'gray78', 'gray79', 'gray80', 'gray81', 'gray82', 'gray83', 'gray84', 'gray85', 'gray86', 'gray87', 'gray88', 'gray89', 'gray90', 'gray91', 'gray92', 'gray93', 'gray94', 'gray95', 'gray96', 'gray97', 'gray98', 'gray99', 'gray100', 'gray', 'green', 'greenyellow', 'grey', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgray', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow', 'lime', 'limegreen', 'linen', 'magenta', 'maroon', 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple', 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen', 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream', 'mistyrose', 'moccasin', 'navajowhite', 'navy', 'none', 'oldlace', 'olive', 'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod', 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip', 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'red', 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown', 'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue', 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan', 'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white', 'whitesmoke', 'yellow', 'yellowgreen',],}]

- Defined in schema/definitions.schema.ts:74

### facesDef

facesDef: object

- Defined in schema/definitions.schema.ts:102

### id

id: string = "/facesDef"

- Defined in schema/definitions.schema.ts:103

### oneOf

oneOf: (object | object | object)[] = [{type: 'string',enum: ['all'],}, {type: 'integer',minimum: 1,maximum: 1000,}, {type: 'array',uniqueItems: true,items: [{type: 'integer',minimum: 1,maximum: 1000,}],}]

- Defined in schema/definitions.schema.ts:104

### locationsDef

locationsDef: object

- Defined in schema/definitions.schema.ts:67

### enum

enum: string[] = ['s3', 'S3', 'rackspace', 'gcs', 'azure', 'dropbox']

- Defined in schema/definitions.schema.ts:70

### id

id: string = "/locationsDef"

- Defined in schema/definitions.schema.ts:68

### type

type: string = "string"

- Defined in schema/definitions.schema.ts:69

### objectsDef

objectsDef: object

- Defined in schema/definitions.schema.ts:121

### id

id: string = "/objectsDef"

- Defined in schema/definitions.schema.ts:122

### items

items: object[] = [{type: 'array',additionalItems: false,minItems: 4,items: [{type: 'integer',minimum: 0,maximum: 10000,}, {type: 'integer',minimum: 0,maximum: 10000,}, {type: 'integer',minimum: 1,maximum: 10000,}, {type: 'integer',minimum: 1,maximum: 10000,}],}]

- Defined in schema/definitions.schema.ts:126

### maxItems

maxItems: number = 50

- Defined in schema/definitions.schema.ts:125

### minItems

minItems: number = 1

- Defined in schema/definitions.schema.ts:124

### type

type: string = "array"

- Defined in schema/definitions.schema.ts:123

### pageFormatDef

pageFormatDef: object

- Defined in schema/definitions.schema.ts:82

### enum

enum: string[] = ['a2', 'a3', 'a4', 'a5', 'b4', 'b5', 'letter', 'legal', 'tabloid']

- Defined in schema/definitions.schema.ts:85

### id

id: string = "/pageFormatDef"

- Defined in schema/definitions.schema.ts:83

### type

type: string = "string"

- Defined in schema/definitions.schema.ts:84

### pageRangeDef

pageRangeDef: object

- Defined in schema/definitions.schema.ts:87

### id

id: string = "/pageRangeDef"

- Defined in schema/definitions.schema.ts:88

### items

items: object[] = [{oneOf: [{type: 'integer',minimum: 1,}, {type: 'string',pattern: '^(\\d+(?:-\\d+)?)$|^(-\\d+)$|^(\\d+-)$',errorMessage: 'Param should be provided in one of the following formats: "1,2,3,5", "1-3", "1-", "-2" ',}],}]

- Defined in schema/definitions.schema.ts:91

### type

type: string = "array"

- Defined in schema/definitions.schema.ts:89

### uniqueItems

uniqueItems: boolean = true

- Defined in schema/definitions.schema.ts:90

### positionDef

positionDef: object

- Defined in schema/definitions.schema.ts:149

### default

default: string[] = ['middle', 'center']

- Defined in schema/definitions.schema.ts:151

### id

id: string = "/positionDef"

- Defined in schema/definitions.schema.ts:150

### oneOf

oneOf: (object | object)[] = [{type: 'string',enum: ['top','middle','bottom','left','center','right',],},{type: 'array',uniqueItems: true,additionalItems: false,minItems: 2,default: ['middle', 'center'],items: [{type: 'string',enum: ['top','middle','bottom',],}, {type: 'string',enum: ['left','center','right',],},],},]

- Defined in schema/definitions.schema.ts:152

### regionsDef

regionsDef: object

- Defined in schema/definitions.schema.ts:62

### enum

enum: string[] = ['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-southeast-1', 'ap-southeast-2', 'ap-south-1', 'sa-east-1']

- Defined in schema/definitions.schema.ts:65

### id

id: string = "/regionsDef"

- Defined in schema/definitions.schema.ts:63

### type

type: string = "string"

- Defined in schema/definitions.schema.ts:64

### securityCallDef

securityCallDef: object

- Defined in schema/definitions.schema.ts:44

### id

id: string = "/securityCallDef"

- Defined in schema/definitions.schema.ts:45

### oneOf

oneOf: (object | object)[] = [{additionalProperties: false,type: 'string',enum: ['pick', 'read', 'stat', 'write', 'writeUrl', 'store', 'convert', 'remove', 'exif', 'runWorkflow'],}, {type: 'array',additionalProperties: false,items: [{minItems: 1,maxItems: 10,type: 'string',additionalProperties: false,enum: ['pick', 'read', 'stat', 'write', 'writeUrl', 'store', 'convert', 'remove', 'exif', 'runWorkflow'],}],}]

- Defined in schema/definitions.schema.ts:46

### workflowsDef

workflowsDef: object

- Defined in schema/definitions.schema.ts:24

### additionalItems

additionalItems: boolean = false

- Defined in schema/definitions.schema.ts:27

### id

id: string = "/workflowsDef"

- Defined in schema/definitions.schema.ts:25

### items

items: object[] = [{oneOf: [{type: 'string',}, {type: 'object',additionalProperties: false,properties: {id: {type: 'string',},},}],}]

- Defined in schema/definitions.schema.ts:30

### maxItems

maxItems: number = 20

- Defined in schema/definitions.schema.ts:29

### minItems

minItems: number = 1

- Defined in schema/definitions.schema.ts:28

### type

type: string = "array"

- Defined in schema/definitions.schema.ts:26

### Const MetadataParamsSchema

MetadataParamsSchema: object

- Defined in schema/metadata.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/metadata.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/metadata.schema.ts:22

### description

description: string = "Filestack Metadata Options"

- Defined in schema/metadata.schema.ts:20

### title

title: string = "Filestack Metadata"

- Defined in schema/metadata.schema.ts:19

### type

type: string = "object"

- Defined in schema/metadata.schema.ts:21

### properties

properties: object

- Defined in schema/metadata.schema.ts:23

### cloud

cloud: object

- Defined in schema/metadata.schema.ts:48

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:49

### container

container: object

- Defined in schema/metadata.schema.ts:78

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:79

### exif

exif: object

- Defined in schema/metadata.schema.ts:81

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:82

### filename

filename: object

- Defined in schema/metadata.schema.ts:30

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:31

### height

height: object

- Defined in schema/metadata.schema.ts:39

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:40

### location

location: object

- Defined in schema/metadata.schema.ts:72

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:73

### md5

md5: object

- Defined in schema/metadata.schema.ts:54

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:55

### metadata

metadata: object

- Defined in schema/metadata.schema.ts:36

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:37

### mimetype

mimetype: object

- Defined in schema/metadata.schema.ts:27

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:28

### path

path: object

- Defined in schema/metadata.schema.ts:75

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:76

### sha1

sha1: object

- Defined in schema/metadata.schema.ts:57

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:58

### sha224

sha224: object

- Defined in schema/metadata.schema.ts:60

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:61

### sha256

sha256: object

- Defined in schema/metadata.schema.ts:63

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:64

### sha384

sha384: object

- Defined in schema/metadata.schema.ts:66

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:67

### sha512

sha512: object

- Defined in schema/metadata.schema.ts:69

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:70

### size

size: object

- Defined in schema/metadata.schema.ts:24

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:25

### sourceUrl

sourceUrl: object

- Defined in schema/metadata.schema.ts:51

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:52

### uploaded

uploaded: object

- Defined in schema/metadata.schema.ts:42

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:43

### width

width: object

- Defined in schema/metadata.schema.ts:33

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:34

### writeable

writeable: object

- Defined in schema/metadata.schema.ts:45

### type

type: string = "boolean"

- Defined in schema/metadata.schema.ts:46

### Const PickerParamsSchema

PickerParamsSchema: object

- Defined in schema/picker.schema.ts:19

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/picker.schema.ts:20

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:24

### description

description: string = "Filestack Picker Options"

- Defined in schema/picker.schema.ts:22

### title

title: string = "Filestack Picker"

- Defined in schema/picker.schema.ts:21

### type

type: string = "object"

- Defined in schema/picker.schema.ts:23

### properties

properties: object

- Defined in schema/picker.schema.ts:26

### accept

accept: object

- Defined in schema/picker.schema.ts:30

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:31

### oneOf

oneOf: (object | object)[] = [{type: 'string',},{type: 'array',minItems: 1,items: [{type: 'string',},],},]

- Defined in schema/picker.schema.ts:32

### allowManualRetry

allowManualRetry: object

- Defined in schema/picker.schema.ts:27

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:28

### cleanupImageExif

cleanupImageExif: object

- Defined in schema/picker.schema.ts:80

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',},{type: 'object',additionalProperties: false,properties: {keepOrientation: {type: 'boolean',},},},]

- Defined in schema/picker.schema.ts:81

### concurrency

concurrency: object

- Defined in schema/picker.schema.ts:100

### maximum

maximum: number = 20

- Defined in schema/picker.schema.ts:103

### minimum

minimum: number = 1

- Defined in schema/picker.schema.ts:102

### type

type: string = "integer"

- Defined in schema/picker.schema.ts:101

### container

container: object

- Defined in schema/picker.schema.ts:77

### format

format: string = "HTMLContainer"

- Defined in schema/picker.schema.ts:78

### customAuthText

customAuthText: object

- Defined in schema/picker.schema.ts:363

### type

type: string = "object"

- Defined in schema/picker.schema.ts:364

### patternProperties

patternProperties: object

- Defined in schema/picker.schema.ts:365

### .*

.*: object

- Defined in schema/picker.schema.ts:366

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:367

### required

required: string[] = ['top', 'bottom']

- Defined in schema/picker.schema.ts:369

### type

type: string = "object"

- Defined in schema/picker.schema.ts:368

### properties

properties: object

- Defined in schema/picker.schema.ts:370

### bottom

bottom: object

- Defined in schema/picker.schema.ts:374

### type

type: string = "string"

- Defined in schema/picker.schema.ts:375

### top

top: object

- Defined in schema/picker.schema.ts:371

### type

type: string = "string"

- Defined in schema/picker.schema.ts:372

### customSourceContainer

customSourceContainer: object

- Defined in schema/picker.schema.ts:105

### type

type: string = "string"

- Defined in schema/picker.schema.ts:106

### customSourceName

customSourceName: object

- Defined in schema/picker.schema.ts:111

### type

type: string = "string"

- Defined in schema/picker.schema.ts:112

### customSourcePath

customSourcePath: object

- Defined in schema/picker.schema.ts:108

### type

type: string = "string"

- Defined in schema/picker.schema.ts:109

### customText

customText: object

- Defined in schema/picker.schema.ts:310

### type

type: string = "object"

- Defined in schema/picker.schema.ts:311

### patternProperties

patternProperties: object

- Defined in schema/picker.schema.ts:312

### .*

.*: object

- Defined in schema/picker.schema.ts:313

### type

type: string = "string"

- Defined in schema/picker.schema.ts:313

### disableStorageKey

disableStorageKey: object

- Defined in schema/picker.schema.ts:114

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:115

### disableThumbnails

disableThumbnails: object

- Defined in schema/picker.schema.ts:120

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:121

### disableTransformer

disableTransformer: object

- Defined in schema/picker.schema.ts:117

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:118

### displayMode

displayMode: object

- Defined in schema/picker.schema.ts:96

### enum

enum: string[] = ['inline', 'overlay', 'dropPane']

- Defined in schema/picker.schema.ts:98

### type

type: string = "string"

- Defined in schema/picker.schema.ts:97

### dropPane

dropPane: object

- Defined in schema/picker.schema.ts:316

### type

type: string = "object"

- Defined in schema/picker.schema.ts:317

### properties

properties: object

- Defined in schema/picker.schema.ts:318

### cropFiles

cropFiles: object

- Defined in schema/picker.schema.ts:319

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:320

### customText

customText: object

- Defined in schema/picker.schema.ts:322

### type

type: string = "string"

- Defined in schema/picker.schema.ts:323

### disableClick

disableClick: object

- Defined in schema/picker.schema.ts:325

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:326

### onClick

onClick: object

- Defined in schema/picker.schema.ts:358

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:359

### onDragEnter

onDragEnter: object

- Defined in schema/picker.schema.ts:337

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:338

### onDragLeave

onDragLeave: object

- Defined in schema/picker.schema.ts:343

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:344

### onDragOver

onDragOver: object

- Defined in schema/picker.schema.ts:346

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:347

### onDrop

onDrop: object

- Defined in schema/picker.schema.ts:349

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:350

### onError

onError: object

- Defined in schema/picker.schema.ts:355

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:356

### onProgress

onProgress: object

- Defined in schema/picker.schema.ts:340

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:341

### onSuccess

onSuccess: object

- Defined in schema/picker.schema.ts:352

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:353

### overlay

overlay: object

- Defined in schema/picker.schema.ts:328

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:329

### showIcon

showIcon: object

- Defined in schema/picker.schema.ts:331

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:332

### showProgress

showProgress: object

- Defined in schema/picker.schema.ts:334

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:335

### errorsTimeout

errorsTimeout: object

- Defined in schema/picker.schema.ts:386

### minimum

minimum: number = 0

- Defined in schema/picker.schema.ts:388

### type

type: string = "number"

- Defined in schema/picker.schema.ts:387

### exposeOriginalFile

exposeOriginalFile: object

- Defined in schema/picker.schema.ts:123

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:124

### fromSources

fromSources: object

- Defined in schema/picker.schema.ts:47

### items

items: object[] = [{type: 'string',additionalProperties: false,enum: ['local_file_system','url','imagesearch','facebook','instagram','googledrive','dropbox','webcam','video','audio','box','github','gmail','picasa','onedrive','onedriveforbusiness','clouddrive','googlephotos','customsource',],},]

- Defined in schema/picker.schema.ts:49

### type

type: string = "array"

- Defined in schema/picker.schema.ts:48

### globalDropZone

globalDropZone: object

- Defined in schema/picker.schema.ts:126

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:127

### hideModalWhenUploading

hideModalWhenUploading: object

- Defined in schema/picker.schema.ts:129

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:130

### imageDim

imageDim: object

- Defined in schema/picker.schema.ts:132

### items

items: object[] = [{type: 'integer',minimum: 1,maximum: 1000000,},]

- Defined in schema/picker.schema.ts:136

### maxItems

maxItems: number = 2

- Defined in schema/picker.schema.ts:135

### minItems

minItems: number = 2

- Defined in schema/picker.schema.ts:134

### type

type: string = "array"

- Defined in schema/picker.schema.ts:133

### imageMax

imageMax: object

- Defined in schema/picker.schema.ts:144

### items

items: object[] = [{type: 'integer',minimum: 1,maximum: 1000000,},]

- Defined in schema/picker.schema.ts:148

### maxItems

maxItems: number = 2

- Defined in schema/picker.schema.ts:147

### minItems

minItems: number = 2

- Defined in schema/picker.schema.ts:146

### type

type: string = "array"

- Defined in schema/picker.schema.ts:145

### imageMin

imageMin: object

- Defined in schema/picker.schema.ts:156

### items

items: object[] = [{type: 'integer',minimum: 1,maximum: 1000000,},]

- Defined in schema/picker.schema.ts:160

### maxItems

maxItems: number = 2

- Defined in schema/picker.schema.ts:159

### minItems

minItems: number = 2

- Defined in schema/picker.schema.ts:158

### type

type: string = "array"

- Defined in schema/picker.schema.ts:157

### imageMinMaxBlock

imageMinMaxBlock: object

- Defined in schema/picker.schema.ts:168

### default

default: boolean = false

- Defined in schema/picker.schema.ts:170

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:169

### lang

lang: object

- Defined in schema/picker.schema.ts:172

### enum

enum: string[] = ['ca', 'da', 'de', 'en', 'es', 'fr', 'he', 'it', 'ja', 'ko', 'nl', 'no', 'pl', 'pt', 'sv', 'ru', 'vi', 'zh', 'tr']

- Defined in schema/picker.schema.ts:174

### type

type: string = "string"

- Defined in schema/picker.schema.ts:173

### maxFiles

maxFiles: object

- Defined in schema/picker.schema.ts:181

### maximum

maximum: number = 1000000

- Defined in schema/picker.schema.ts:184

### minimum

minimum: number = 1

- Defined in schema/picker.schema.ts:183

### type

type: string = "integer"

- Defined in schema/picker.schema.ts:182

### maxSize

maxSize: object

- Defined in schema/picker.schema.ts:186

### minimum

minimum: number = 1

- Defined in schema/picker.schema.ts:188

### type

type: string = "integer"

- Defined in schema/picker.schema.ts:187

### minFiles

minFiles: object

- Defined in schema/picker.schema.ts:176

### maximum

maximum: number = 1000000

- Defined in schema/picker.schema.ts:179

### minimum

minimum: number = 1

- Defined in schema/picker.schema.ts:178

### type

type: string = "integer"

- Defined in schema/picker.schema.ts:177

### modalSize

modalSize: object

- Defined in schema/picker.schema.ts:190

### items

items: object[] = [{type: 'integer',minimum: 1,maximum: 1000000,},]

- Defined in schema/picker.schema.ts:194

### maxItems

maxItems: number = 2

- Defined in schema/picker.schema.ts:193

### minItems

minItems: number = 2

- Defined in schema/picker.schema.ts:192

### type

type: string = "array"

- Defined in schema/picker.schema.ts:191

### onCancel

onCancel: object

- Defined in schema/picker.schema.ts:214

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:215

### onClose

onClose: object

- Defined in schema/picker.schema.ts:217

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:218

### onFileSelected

onFileSelected: object

- Defined in schema/picker.schema.ts:223

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:224

### onFileUploadFailed

onFileUploadFailed: object

- Defined in schema/picker.schema.ts:232

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:233

### onFileUploadFinished

onFileUploadFinished: object

- Defined in schema/picker.schema.ts:229

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:230

### onFileUploadProgress

onFileUploadProgress: object

- Defined in schema/picker.schema.ts:235

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:236

### onFileUploadStarted

onFileUploadStarted: object

- Defined in schema/picker.schema.ts:226

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:227

### onOpen

onOpen: object

- Defined in schema/picker.schema.ts:220

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:221

### onUploadDone

onUploadDone: object

- Defined in schema/picker.schema.ts:241

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:242

### onUploadStarted

onUploadStarted: object

- Defined in schema/picker.schema.ts:238

### format

format: string = "callback"

- Defined in schema/picker.schema.ts:239

### rootId

rootId: object

- Defined in schema/picker.schema.ts:202

### type

type: string = "string"

- Defined in schema/picker.schema.ts:203

### startUploadingWhenMaxFilesReached

startUploadingWhenMaxFilesReached: object

- Defined in schema/picker.schema.ts:205

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:206

### storeTo

storeTo: object

- Defined in schema/picker.schema.ts:244

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:245

### type

type: string = "object"

- Defined in schema/picker.schema.ts:246

### properties

properties: object

- Defined in schema/picker.schema.ts:247

### access

access: object

- Defined in schema/picker.schema.ts:263

### enum

enum: string[] = ['public', 'private']

- Defined in schema/picker.schema.ts:265

### type

type: string = "string"

- Defined in schema/picker.schema.ts:264

### container

container: object

- Defined in schema/picker.schema.ts:254

### type

type: string = "string"

- Defined in schema/picker.schema.ts:255

### filename

filename: object

- Defined in schema/picker.schema.ts:248

### type

type: string = "string"

- Defined in schema/picker.schema.ts:249

### location

location: object

- Defined in schema/picker.schema.ts:251

### $ref

$ref: string = "locationsDef"

- Defined in schema/picker.schema.ts:252

### path

path: object

- Defined in schema/picker.schema.ts:257

### type

type: string = "string"

- Defined in schema/picker.schema.ts:258

### region

region: object

- Defined in schema/picker.schema.ts:260

### type

type: string = "string"

- Defined in schema/picker.schema.ts:261

### workflows

workflows: object

- Defined in schema/picker.schema.ts:267

### $ref

$ref: string = "workflowsDef"

- Defined in schema/picker.schema.ts:268

### transformations

transformations: object

- Defined in schema/picker.schema.ts:276

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:278

### type

type: string = "object"

- Defined in schema/picker.schema.ts:277

### properties

properties: object

- Defined in schema/picker.schema.ts:279

### circle

circle: object

- Defined in schema/picker.schema.ts:280

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:281

### crop

crop: object

- Defined in schema/picker.schema.ts:289

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',},{type: 'object',additionalProperties: false,properties: {force: {type: 'boolean',},aspectRatio: {type: 'number',},},},]

- Defined in schema/picker.schema.ts:290

### force

force: object

- Defined in schema/picker.schema.ts:286

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:287

### rotate

rotate: object

- Defined in schema/picker.schema.ts:283

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:284

### uploadConfig

uploadConfig: object

- Defined in schema/picker.schema.ts:381

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/picker.schema.ts:383

### properties

properties: object = UploadParamsSchema.properties

- Defined in schema/picker.schema.ts:384

#### Type declaration

- ##### concurrency: object

  - ##### maximum: number

  - ##### minimum: number

  - ##### type: string

- ##### intelligent: object

  - ##### oneOf: (object | object)[]

- ##### intelligentChunkSize: object

  - ##### type: string

- ##### onProgress: object

  - ##### format: string

- ##### onRetry: object

  - ##### format: string

- ##### partSize: object

  - ##### minimum: number

  - ##### type: string

- ##### progressInterval: object

  - ##### minimum: number

  - ##### type: string

- ##### retry: object

  - ##### maximum: number

  - ##### minimum: number

  - ##### type: string

- ##### retryFactor: object

  - ##### type: string

- ##### retryMaxTime: object

  - ##### type: string

- ##### timeout: object

  - ##### maximum: number

  - ##### minimum: number

  - ##### type: string

### type

type: string = "object"

- Defined in schema/picker.schema.ts:382

### uploadInBackground

uploadInBackground: object

- Defined in schema/picker.schema.ts:208

### type

type: string = "boolean"

- Defined in schema/picker.schema.ts:209

### videoResolution

videoResolution: object

- Defined in schema/picker.schema.ts:211

### type

type: string = "string"

- Defined in schema/picker.schema.ts:212

### viewType

viewType: object

- Defined in schema/picker.schema.ts:272

### enum

enum: string[] = ['grid', 'list']

- Defined in schema/picker.schema.ts:274

### type

type: string = "string"

- Defined in schema/picker.schema.ts:273

### Const PreviewParamsSchema

PreviewParamsSchema: object

- Defined in schema/preview.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/preview.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/preview.schema.ts:22

### description

description: string = "Filestack Preview Options"

- Defined in schema/preview.schema.ts:20

### title

title: string = "Filestack Preview"

- Defined in schema/preview.schema.ts:19

### type

type: string = "object"

- Defined in schema/preview.schema.ts:21

### properties

properties: object

- Defined in schema/preview.schema.ts:23

### css

css: object

- Defined in schema/preview.schema.ts:27

### type

type: string = "string"

- Defined in schema/preview.schema.ts:28

### id

id: object

- Defined in schema/preview.schema.ts:24

### type

type: string = "string"

- Defined in schema/preview.schema.ts:25

### Const RetrieveParamsSchema

RetrieveParamsSchema: object

- Defined in schema/retrieve.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/retrieve.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/retrieve.schema.ts:22

### description

description: string = "Filestack Retrieve Options"

- Defined in schema/retrieve.schema.ts:20

### title

title: string = "Filestack Retrieve"

- Defined in schema/retrieve.schema.ts:19

### type

type: string = "object"

- Defined in schema/retrieve.schema.ts:21

### properties

properties: object

- Defined in schema/retrieve.schema.ts:23

### cache

cache: object

- Defined in schema/retrieve.schema.ts:33

### type

type: string = "boolean"

- Defined in schema/retrieve.schema.ts:34

### dl

dl: object

- Defined in schema/retrieve.schema.ts:30

### type

type: string = "boolean"

- Defined in schema/retrieve.schema.ts:31

### extension

extension: object

- Defined in schema/retrieve.schema.ts:36

### type

type: string = "string"

- Defined in schema/retrieve.schema.ts:37

### head

head: object

- Defined in schema/retrieve.schema.ts:27

### type

type: string = "boolean"

- Defined in schema/retrieve.schema.ts:28

### metadata

metadata: object

- Defined in schema/retrieve.schema.ts:24

### type

type: string = "boolean"

- Defined in schema/retrieve.schema.ts:25

### Const SecurityParamsSchema

SecurityParamsSchema: object

- Defined in schema/security.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/security.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/security.schema.ts:22

### description

description: string = "Filestack Security Options"

- Defined in schema/security.schema.ts:20

### title

title: string = "Filestack Security"

- Defined in schema/security.schema.ts:19

### type

type: string = "object"

- Defined in schema/security.schema.ts:21

### properties

properties: object

- Defined in schema/security.schema.ts:23

### call

call: object

- Defined in schema/security.schema.ts:27

### $ref

$ref: string = "securityCallDef"

- Defined in schema/security.schema.ts:28

### container

container: object

- Defined in schema/security.schema.ts:45

### type

type: string = "string"

- Defined in schema/security.schema.ts:46

### expiry

expiry: object

- Defined in schema/security.schema.ts:24

### type

type: string = "number"

- Defined in schema/security.schema.ts:25

### handle

handle: object

- Defined in schema/security.schema.ts:30

### type

type: string = "string"

- Defined in schema/security.schema.ts:31

### maxSize

maxSize: object

- Defined in schema/security.schema.ts:36

### type

type: string = "number"

- Defined in schema/security.schema.ts:37

### minSize

minSize: object

- Defined in schema/security.schema.ts:39

### type

type: string = "number"

- Defined in schema/security.schema.ts:40

### path

path: object

- Defined in schema/security.schema.ts:42

### type

type: string = "string"

- Defined in schema/security.schema.ts:43

### url

url: object

- Defined in schema/security.schema.ts:33

### type

type: string = "string"

- Defined in schema/security.schema.ts:34

### Const StoreParamsSchema

StoreParamsSchema: object

- Defined in schema/store.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/store.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/store.schema.ts:22

### description

description: string = "Filestack Store Options"

- Defined in schema/store.schema.ts:20

### title

title: string = "Filestack Store"

- Defined in schema/store.schema.ts:19

### type

type: string = "object"

- Defined in schema/store.schema.ts:21

### properties

properties: object

- Defined in schema/store.schema.ts:23

### access

access: object

- Defined in schema/store.schema.ts:43

### default

default: string = "private"

- Defined in schema/store.schema.ts:46

### enum

enum: string[] = ['public', 'private']

- Defined in schema/store.schema.ts:45

### type

type: string = "string"

- Defined in schema/store.schema.ts:44

### base64decode

base64decode: object

- Defined in schema/store.schema.ts:48

### type

type: string = "boolean"

- Defined in schema/store.schema.ts:49

### container

container: object

- Defined in schema/store.schema.ts:37

### type

type: string = "string"

- Defined in schema/store.schema.ts:38

### filename

filename: object

- Defined in schema/store.schema.ts:24

### oneOf

oneOf: (object | object)[] = [{type: 'string',}, {format: 'callback',}]

- Defined in schema/store.schema.ts:25

### location

location: object

- Defined in schema/store.schema.ts:31

### $ref

$ref: string = "locationsDef"

- Defined in schema/store.schema.ts:32

### path

path: object

- Defined in schema/store.schema.ts:34

### type

type: string = "string"

- Defined in schema/store.schema.ts:35

### region

region: object

- Defined in schema/store.schema.ts:40

### $ref

$ref: string = "regionsDef"

- Defined in schema/store.schema.ts:41

### sanitizer

sanitizer: object

- Defined in schema/store.schema.ts:54

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',additionalProperties: false,properties: {exclude: {type: 'array',items: [{type: 'string',}],},replacement: {type: 'string',},},}]

- Defined in schema/store.schema.ts:55

### workflows

workflows: object

- Defined in schema/store.schema.ts:51

### $ref

$ref: string = "workflowsDef"

- Defined in schema/store.schema.ts:52

### Const TransformSchema

TransformSchema: object

- Defined in schema/transforms.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/transforms.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:22

### description

description: string = "Filestack transformations parameters"

- Defined in schema/transforms.schema.ts:20

### title

title: string = "Filestack Transformations"

- Defined in schema/transforms.schema.ts:19

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:21

### properties

properties: object

- Defined in schema/transforms.schema.ts:23

### ascii

ascii: object

- Defined in schema/transforms.schema.ts:666

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {foreground: {'$ref': 'colorDef',default: '000000FF',},background: {'$ref': 'colorDef',default: 'FFFFFFFF',},colored: {type: 'boolean',default: false,},size: {type: 'integer',minimum: 10,maximum: 100,default: 100,},reverse: {type: 'boolean',default: false,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:667

### blackwhite

blackwhite: object

- Defined in schema/transforms.schema.ts:574

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {threshold: {type: 'integer',minimum: 0,maximum: 100,default: 50,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:575

### blur

blur: object

- Defined in schema/transforms.schema.ts:558

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {amount: {type: 'integer',minimum: 0,maximum: 20,default: 2,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:559

### blur_faces

blur_faces: object

- Defined in schema/transforms.schema.ts:312

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {faces: {'$ref': 'facesDef',default: 'all',},maxsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},minsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},buffer: {type: 'integer',minimum: 0,maximum: 10000,},amount: {type: 'number',minimum: 0,maximum: 10,default: 10,},blur: {type: 'number',minimum: 0,maximum: 20,default: 4,},type: {type: 'string',enum: ['rect', 'oval'],default: 'rect',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:313

### border

border: object

- Defined in schema/transforms.schema.ts:521

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {color: {'$ref': 'colorDef',},background: {'$ref': 'colorDef',},width: {type: 'integer',minimum: 0,maximum: 1000,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:522

### cache

cache: object

- Defined in schema/transforms.schema.ts:903

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {expiry: {type: 'integer',},},}]

- Defined in schema/transforms.schema.ts:904

### circle

circle: object

- Defined in schema/transforms.schema.ts:508

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:509

### collage

collage: object

- Defined in schema/transforms.schema.ts:698

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:738

### required

required: string[] = ['width', 'height', 'files']

- Defined in schema/transforms.schema.ts:737

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:699

### properties

properties: object

- Defined in schema/transforms.schema.ts:700

### autorotate

autorotate: object

- Defined in schema/transforms.schema.ts:732

### default

default: boolean = false

- Defined in schema/transforms.schema.ts:734

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:733

### color

color: object

- Defined in schema/transforms.schema.ts:724

### $ref

$ref: string = "colorDef"

- Defined in schema/transforms.schema.ts:725

### default

default: string = "FFFFFFFF"

- Defined in schema/transforms.schema.ts:726

### files

files: object

- Defined in schema/transforms.schema.ts:701

### items

items: object[] = [{type: 'string',}]

- Defined in schema/transforms.schema.ts:704

### minItems

minItems: number = 1

- Defined in schema/transforms.schema.ts:703

### type

type: string = "array"

- Defined in schema/transforms.schema.ts:702

### fit

fit: object

- Defined in schema/transforms.schema.ts:728

### enum

enum: string[] = ['auto', 'crop']

- Defined in schema/transforms.schema.ts:730

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:729

### height

height: object

- Defined in schema/transforms.schema.ts:719

### maximum

maximum: number = 10000

- Defined in schema/transforms.schema.ts:722

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:721

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:720

### margin

margin: object

- Defined in schema/transforms.schema.ts:708

### default

default: number = 10

- Defined in schema/transforms.schema.ts:712

### maximum

maximum: number = 100

- Defined in schema/transforms.schema.ts:711

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:710

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:709

### width

width: object

- Defined in schema/transforms.schema.ts:714

### maximum

maximum: number = 10000

- Defined in schema/transforms.schema.ts:717

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:716

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:715

### compress

compress: object

- Defined in schema/transforms.schema.ts:32

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:33

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {metadata: {type: 'boolean',default: false,},},}]

- Defined in schema/transforms.schema.ts:34

### crop

crop: object

- Defined in schema/transforms.schema.ts:138

### required

required: string[] = ['dim']

- Defined in schema/transforms.schema.ts:164

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:139

### properties

properties: object

- Defined in schema/transforms.schema.ts:140

### dim

dim: object

- Defined in schema/transforms.schema.ts:141

### additionalItems

additionalItems: boolean = false

- Defined in schema/transforms.schema.ts:143

### items

items: object[] = [{type: 'integer',minimum: 0,maximum: 100000,}, {type: 'integer',minimum: 0,maximum: 100000,}, {type: 'integer',minimum: 1,maximum: 100000,}, {type: 'integer',minimum: 1,maximum: 100000,}]

- Defined in schema/transforms.schema.ts:145

### minItems

minItems: number = 4

- Defined in schema/transforms.schema.ts:144

### type

type: string = "array"

- Defined in schema/transforms.schema.ts:142

### crop_faces

crop_faces: object

- Defined in schema/transforms.schema.ts:218

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {faces: {default: 1,'$ref': 'facesDef',},width: {type: 'number',minimum: 1,maximum: 10000,},height: {type: 'number',minimum: 1,maximum: 10000,},maxsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},minsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},buffer: {type: 'integer',minimum: 0,maximum: 10000,},mode: {type: 'string',enum: ['crop', 'thumb', 'fill'],default: 'thumb',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:219

### detect_faces

detect_faces: object

- Defined in schema/transforms.schema.ts:189

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {maxsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},minsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},export: {type: 'boolean',},color: {'$ref': 'colorDef',default: '000000FF',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:190

### enhance

enhance: object

- Defined in schema/transforms.schema.ts:50

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:52

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:51

### fallback

fallback: object

- Defined in schema/transforms.schema.ts:1188

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1190

### required

required: string[] = ['handle']

- Defined in schema/transforms.schema.ts:1201

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1189

### properties

properties: object

- Defined in schema/transforms.schema.ts:1191

### cache

cache: object

- Defined in schema/transforms.schema.ts:1195

### maximum

maximum: number = 31536000

- Defined in schema/transforms.schema.ts:1198

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:1197

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:1196

### handle

handle: object

- Defined in schema/transforms.schema.ts:1192

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1193

### flip

flip: object

- Defined in schema/transforms.schema.ts:24

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:26

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:25

### flop

flop: object

- Defined in schema/transforms.schema.ts:46

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:48

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:47

### imagesize

imagesize: object

- Defined in schema/transforms.schema.ts:74

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:76

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:75

### metadata

metadata: object

- Defined in schema/transforms.schema.ts:78

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:106

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:79

### params

params: object

- Defined in schema/transforms.schema.ts:80

### additionalItems

additionalItems: boolean = false

- Defined in schema/transforms.schema.ts:104

### minItems

minItems: number = 0

- Defined in schema/transforms.schema.ts:102

### type

type: string = "array"

- Defined in schema/transforms.schema.ts:81

### uniqueItems

uniqueItems: boolean = true

- Defined in schema/transforms.schema.ts:103

### items

items: object

- Defined in schema/transforms.schema.ts:82

### enum

enum: string[] = ['filename','mimetype','size','width','height','writeable','path','container','cloud','exif','source_url','md5','sha256','sha1','sha512',]

- Defined in schema/transforms.schema.ts:84

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:83

### minify_css

minify_css: object

- Defined in schema/transforms.schema.ts:1206

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1208

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1207

### properties

properties: object

- Defined in schema/transforms.schema.ts:1209

### gzip

gzip: object

- Defined in schema/transforms.schema.ts:1210

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1211

### level

level: object

- Defined in schema/transforms.schema.ts:1213

### enum

enum: number[] = [1, 2]

- Defined in schema/transforms.schema.ts:1215

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1214

### minify_js

minify_js: object

- Defined in schema/transforms.schema.ts:1219

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1221

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1220

### properties

properties: object

- Defined in schema/transforms.schema.ts:1222

### gzip

gzip: object

- Defined in schema/transforms.schema.ts:1223

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1224

### keep_class_name

keep_class_name: object

- Defined in schema/transforms.schema.ts:1232

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1233

### keep_fn_name

keep_fn_name: object

- Defined in schema/transforms.schema.ts:1229

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1230

### mangle

mangle: object

- Defined in schema/transforms.schema.ts:1235

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1236

### merge_vars

merge_vars: object

- Defined in schema/transforms.schema.ts:1238

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1239

### remove_console

remove_console: object

- Defined in schema/transforms.schema.ts:1241

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1242

### remove_undefined

remove_undefined: object

- Defined in schema/transforms.schema.ts:1244

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1245

### targets

targets: object

- Defined in schema/transforms.schema.ts:1247

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1248

### use_babel_polyfill

use_babel_polyfill: object

- Defined in schema/transforms.schema.ts:1226

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:1227

### modulate

modulate: object

- Defined in schema/transforms.schema.ts:638

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {brightness: {type: 'integer',minimum: 0,maximum: 10000,default: 100,},saturation: {type: 'integer',minimum: 0,maximum: 10000,default: 100,},hue: {type: 'integer',minimum: 0,maximum: 359,default: 0,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:639

### monochrome

monochrome: object

- Defined in schema/transforms.schema.ts:58

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:60

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:59

### negative

negative: object

- Defined in schema/transforms.schema.ts:62

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:64

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:63

### no_metadata

no_metadata: object

- Defined in schema/transforms.schema.ts:28

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:30

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:29

### oil_paint

oil_paint: object

- Defined in schema/transforms.schema.ts:622

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {amount: {type: 'integer',minimum: 2,maximum: 100,default: 2,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:623

### output

output: object

- Defined in schema/transforms.schema.ts:811

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:813

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:812

### properties

properties: object

- Defined in schema/transforms.schema.ts:814

### background

background: object

- Defined in schema/transforms.schema.ts:860

### $ref

$ref: string = "colorDef"

- Defined in schema/transforms.schema.ts:861

### colorspace

colorspace: object

- Defined in schema/transforms.schema.ts:855

### default

default: string = "rgb"

- Defined in schema/transforms.schema.ts:858

### enum

enum: string[] = ['rgb', 'cmyk', 'input']

- Defined in schema/transforms.schema.ts:857

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:856

### compress

compress: object

- Defined in schema/transforms.schema.ts:829

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:830

### density

density: object

- Defined in schema/transforms.schema.ts:824

### maximum

maximum: number = 500

- Defined in schema/transforms.schema.ts:827

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:826

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:825

### docinfo

docinfo: object

- Defined in schema/transforms.schema.ts:847

### default

default: boolean = false

- Defined in schema/transforms.schema.ts:849

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:848

### format

format: object

- Defined in schema/transforms.schema.ts:815

### enum

enum: string[] = ['doc', 'docx', 'html', 'jpg', 'odp', 'ods', 'odt', 'pjpg', 'pdf', 'png', 'ppt', 'pptx', 'svg', 'txt', 'webp', 'xls', 'xlsx']

- Defined in schema/transforms.schema.ts:817

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:816

### page

page: object

- Defined in schema/transforms.schema.ts:819

### maximum

maximum: number = 99999

- Defined in schema/transforms.schema.ts:822

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:821

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:820

### pageformat

pageformat: object

- Defined in schema/transforms.schema.ts:863

### enum

enum: string[] = ['a2', 'a3', 'a4', 'a5', 'b4', 'b5', 'letter', 'legal', 'tabloid']

- Defined in schema/transforms.schema.ts:865

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:864

### pageorientation

pageorientation: object

- Defined in schema/transforms.schema.ts:867

### enum

enum: string[] = ['landscape', 'portrait']

- Defined in schema/transforms.schema.ts:869

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:868

### quality

quality: object

- Defined in schema/transforms.schema.ts:832

### oneOf

oneOf: (object | object)[] = [{type: 'string',enum: ['input'],}, {type: 'integer',minimum: 1,maximum: 100,default: 95,}]

- Defined in schema/transforms.schema.ts:833

### secure

secure: object

- Defined in schema/transforms.schema.ts:843

### default

default: boolean = false

- Defined in schema/transforms.schema.ts:845

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:844

### strip

strip: object

- Defined in schema/transforms.schema.ts:851

### default

default: boolean = false

- Defined in schema/transforms.schema.ts:853

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:852

### partial_blur

partial_blur: object

- Defined in schema/transforms.schema.ts:1094

### required

required: string[] = ['objects']

- Defined in schema/transforms.schema.ts:1115

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1095

### properties

properties: object

- Defined in schema/transforms.schema.ts:1096

### amount

amount: object

- Defined in schema/transforms.schema.ts:1100

### maximum

maximum: number = 20

- Defined in schema/transforms.schema.ts:1103

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1102

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1101

### blur

blur: object

- Defined in schema/transforms.schema.ts:1105

### maximum

maximum: number = 20

- Defined in schema/transforms.schema.ts:1108

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1107

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1106

### objects

objects: object

- Defined in schema/transforms.schema.ts:1097

### $ref

$ref: string = "objectsDef"

- Defined in schema/transforms.schema.ts:1098

### type

type: object

- Defined in schema/transforms.schema.ts:1110

### enum

enum: string[] = ['rect', 'oval']

- Defined in schema/transforms.schema.ts:1112

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1111

### partial_pixelate

partial_pixelate: object

- Defined in schema/transforms.schema.ts:1117

### required

required: string[] = ['objects']

- Defined in schema/transforms.schema.ts:1138

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1118

### properties

properties: object

- Defined in schema/transforms.schema.ts:1119

### amount

amount: object

- Defined in schema/transforms.schema.ts:1123

### maximum

maximum: number = 100

- Defined in schema/transforms.schema.ts:1126

### minimum

minimum: number = 2

- Defined in schema/transforms.schema.ts:1125

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1124

### blur

blur: object

- Defined in schema/transforms.schema.ts:1128

### maximum

maximum: number = 20

- Defined in schema/transforms.schema.ts:1131

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1130

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1129

### objects

objects: object

- Defined in schema/transforms.schema.ts:1120

### $ref

$ref: string = "objectsDef"

- Defined in schema/transforms.schema.ts:1121

### type

type: object

- Defined in schema/transforms.schema.ts:1133

### enum

enum: string[] = ['rect', 'oval']

- Defined in schema/transforms.schema.ts:1135

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1134

### pdfconvert

pdfconvert: object

- Defined in schema/transforms.schema.ts:1165

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1167

### anyOf

anyOf: object[] = [{required: ['pageorientation'],}, {required: ['pageformat'],}, {required: ['pages'],}]

- Defined in schema/transforms.schema.ts:1180

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1166

### properties

properties: object

- Defined in schema/transforms.schema.ts:1168

### pageformat

pageformat: object

- Defined in schema/transforms.schema.ts:1173

### $ref

$ref: string = "pageFormatDef"

- Defined in schema/transforms.schema.ts:1174

### pageorientation

pageorientation: object

- Defined in schema/transforms.schema.ts:1169

### enum

enum: string[] = ['portrait', 'landscape']

- Defined in schema/transforms.schema.ts:1171

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1170

### pages

pages: object

- Defined in schema/transforms.schema.ts:1176

### $ref

$ref: string = "pageRangeDef"

- Defined in schema/transforms.schema.ts:1177

### pdfinfo

pdfinfo: object

- Defined in schema/transforms.schema.ts:1153

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {colorinfo: {type: 'boolean',},},}]

- Defined in schema/transforms.schema.ts:1154

### pixelate

pixelate: object

- Defined in schema/transforms.schema.ts:606

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {amount: {type: 'integer',minimum: 2,maximum: 100,default: 2,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:607

### pixelate_faces

pixelate_faces: object

- Defined in schema/transforms.schema.ts:264

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {faces: {'$ref': 'facesDef',default: 'all',},maxsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},minsize: {type: 'number',minimum: 0,maximum: 10000,default: 0.35,},buffer: {type: 'integer',minimum: 0,maximum: 10000,},amount: {type: 'integer',minimum: 2,maximum: 100,default: 10,},blur: {type: 'number',minimum: 0,maximum: 20,default: 4,},type: {type: 'string',enum: ['rect', 'oval'],default: 'rect',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:265

### pjpg

pjpg: object

- Defined in schema/transforms.schema.ts:873

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',additionalProperties: false,properties: {quality: {type: 'integer',minimum: 0,maximum: 100,},metadata: {type: 'boolean',default: false,},},}]

- Defined in schema/transforms.schema.ts:874

### polaroid

polaroid: object

- Defined in schema/transforms.schema.ts:413

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {rotate: {type: 'integer',minimum: 0,maximum: 359,},color: {'$ref': 'colorDef',default: 'snow',},background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:414

### quality

quality: object

- Defined in schema/transforms.schema.ts:892

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:894

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:893

### properties

properties: object

- Defined in schema/transforms.schema.ts:895

### value

value: object

- Defined in schema/transforms.schema.ts:896

### maximum

maximum: number = 100

- Defined in schema/transforms.schema.ts:899

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:898

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:897

### redeye

redeye: object

- Defined in schema/transforms.schema.ts:54

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:56

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:55

### resize

resize: object

- Defined in schema/transforms.schema.ts:108

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:132

### anyOf

anyOf: object[] = [{ required: ['width'] },{ required: ['height'] },]

- Defined in schema/transforms.schema.ts:133

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:109

### properties

properties: object

- Defined in schema/transforms.schema.ts:110

### align

align: object

- Defined in schema/transforms.schema.ts:126

### $ref

$ref: string = "positionDef"

- Defined in schema/transforms.schema.ts:127

### default

default: string = "center"

- Defined in schema/transforms.schema.ts:128

### fit

fit: object

- Defined in schema/transforms.schema.ts:121

### default

default: string = "clip"

- Defined in schema/transforms.schema.ts:124

### enum

enum: string[] = ['clip', 'crop', 'scale' ,'max']

- Defined in schema/transforms.schema.ts:123

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:122

### height

height: object

- Defined in schema/transforms.schema.ts:116

### maximum

maximum: number = 10000

- Defined in schema/transforms.schema.ts:119

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:118

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:117

### width

width: object

- Defined in schema/transforms.schema.ts:111

### maximum

maximum: number = 10000

- Defined in schema/transforms.schema.ts:114

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:113

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:112

### rotate

rotate: object

- Defined in schema/transforms.schema.ts:166

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:187

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:167

### properties

properties: object

- Defined in schema/transforms.schema.ts:168

### background

background: object

- Defined in schema/transforms.schema.ts:182

### $ref

$ref: string = "colorDef"

- Defined in schema/transforms.schema.ts:183

### default

default: string = "FFFFFFFF"

- Defined in schema/transforms.schema.ts:184

### deg

deg: object

- Defined in schema/transforms.schema.ts:169

### oneOf

oneOf: (object | object)[] = [{type: 'string',enum: ['exif'],}, {type: 'number',minimum: 0,maximum: 359,}]

- Defined in schema/transforms.schema.ts:170

### exif

exif: object

- Defined in schema/transforms.schema.ts:179

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:180

### rounded_corners

rounded_corners: object

- Defined in schema/transforms.schema.ts:360

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {radius: {oneOf: [{type: 'integer',minimum: 1,maximum: 10000,}, {type: 'string',enum: ['max'],}],},blur: {type: 'number',minimum: 0,maximum: 20,default: 0.3,},background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:361

### security

security: object

- Defined in schema/transforms.schema.ts:1140

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1142

### required

required: string[] = ['policy', 'signature']

- Defined in schema/transforms.schema.ts:1151

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1141

### properties

properties: object

- Defined in schema/transforms.schema.ts:1143

### policy

policy: object

- Defined in schema/transforms.schema.ts:1144

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1145

### signature

signature: object

- Defined in schema/transforms.schema.ts:1147

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1148

### sepia

sepia: object

- Defined in schema/transforms.schema.ts:590

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {tone: {type: 'integer',minimum: 0,maximum: 100,default: 80,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:591

### sfw

sfw: object

- Defined in schema/transforms.schema.ts:70

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:72

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:71

### shadow

shadow: object

- Defined in schema/transforms.schema.ts:464

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {blur: {type: 'number',minimum: 0,maximum: 20,default: 100,},opacity: {type: 'integer',minimum: 0,maximum: 100,default: 60,},vector: {type: 'array',additionalItems: false,minItems: 2,items: [{type: 'integer',minimum: -1000,maximum: 1000,default: 4,}, {type: 'integer',minimum: -1000,maximum: 1000,default: 4,}],},color: {'$ref': 'colorDef',},background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:465

### sharpen

sharpen: object

- Defined in schema/transforms.schema.ts:542

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {amount: {type: 'integer',minimum: 0,maximum: 20,default: 2,},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:543

### store

store: object

- Defined in schema/transforms.schema.ts:1038

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',additionalProperties: false,properties: {filename: {type: 'string',},location: {'$ref': 'locationsDef',},path: {type: 'string',},container: {type: 'string',},region: {'$ref': 'regionsDef',},access: {type: 'string',enum: ['public', 'private'],default: 'private',},base64decode: {type: 'boolean',},workflows: {'$ref': 'workflowsDef',},},}]

- Defined in schema/transforms.schema.ts:1039

### tags

tags: object

- Defined in schema/transforms.schema.ts:66

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:68

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:67

### torn_edges

torn_edges: object

- Defined in schema/transforms.schema.ts:435

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {spread: {type: 'array',additionalItems: false,minItems: 2,items: [{type: 'integer',minimum: 1,maximum: 10000,default: 1,}, {type: 'integer',minimum: 1,maximum: 10000,default: 10,}],},background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:436

### upscale

upscale: object

- Defined in schema/transforms.schema.ts:787

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {noise: {type: 'string',enum: ['none', 'low', 'medium', 'high'],default: 'none',},upscale: {type: 'boolean',default: true,},style: {type: 'string',enum: ['artwork', 'photo'],default: 'photo',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:788

### urlscreenshot

urlscreenshot: object

- Defined in schema/transforms.schema.ts:740

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {agent: {type : 'string',enum: ['desktop', 'mobile'],default: 'desktop',},width: {type: 'integer',minimum: 1,maximum: 1920,default: 1024,},height: {type: 'integer',minimum: 1,maximum: 8000,default: 768,},mode: {type: 'string',enum: ['all', 'window'],default: 'all',},delay: {type: 'integer',minimum: 0,maximum: 20000,default: 1000,},orientation: {type: 'string',enum: ['portrait', 'landscape'],default: 'portrait',},device: {type: 'string',default: '',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:741

### video_convert

video_convert: object

- Defined in schema/transforms.schema.ts:915

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:917

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:916

### properties

properties: object

- Defined in schema/transforms.schema.ts:918

### access

access: object

- Defined in schema/transforms.schema.ts:1031

### default

default: string = "public"

- Defined in schema/transforms.schema.ts:1034

### enum

enum: string[] = ['public', 'private']

- Defined in schema/transforms.schema.ts:1033

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1032

### aspect_mode

aspect_mode: object

- Defined in schema/transforms.schema.ts:944

### default

default: string = "letterbox"

- Defined in schema/transforms.schema.ts:947

### enum

enum: string[] = ['letterbox', 'pad', 'crop', 'preserve', 'constrain']

- Defined in schema/transforms.schema.ts:946

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:945

### audio_bitrate

audio_bitrate: object

- Defined in schema/transforms.schema.ts:972

### maximum

maximum: number = 999

- Defined in schema/transforms.schema.ts:975

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:974

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:973

### audio_channels

audio_channels: object

- Defined in schema/transforms.schema.ts:977

### maximum

maximum: number = 12

- Defined in schema/transforms.schema.ts:980

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:979

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:978

### audio_sample_rate

audio_sample_rate: object

- Defined in schema/transforms.schema.ts:949

### maximum

maximum: number = 99999

- Defined in schema/transforms.schema.ts:952

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:951

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:950

### clip_length

clip_length: object

- Defined in schema/transforms.schema.ts:982

### pattern

pattern: string = `^([0-1]?\\d|2[0-3])(?::([0-5]?\\d))?(?::([0-5]?\\d))?$`

- Defined in schema/transforms.schema.ts:984

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:983

### clip_offset

clip_offset: object

- Defined in schema/transforms.schema.ts:986

### pattern

pattern: string = `^([0-1]?\\d|2[0-3])(?::([0-5]?\\d))?(?::([0-5]?\\d))?$`

- Defined in schema/transforms.schema.ts:988

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:987

### container

container: object

- Defined in schema/transforms.schema.ts:1028

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1029

### extname

extname: object

- Defined in schema/transforms.schema.ts:938

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:939

### filename

filename: object

- Defined in schema/transforms.schema.ts:1019

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1020

### force

force: object

- Defined in schema/transforms.schema.ts:932

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:933

### fps

fps: object

- Defined in schema/transforms.schema.ts:962

### maximum

maximum: number = 300

- Defined in schema/transforms.schema.ts:965

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:964

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:963

### frame_count

frame_count: object

- Defined in schema/transforms.schema.ts:1013

### default

default: number = 1

- Defined in schema/transforms.schema.ts:1017

### maximum

maximum: number = 1

- Defined in schema/transforms.schema.ts:1016

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:1015

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:1014

### height

height: object

- Defined in schema/transforms.schema.ts:924

### maximum

maximum: number = 4096

- Defined in schema/transforms.schema.ts:927

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:926

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:925

### keyframe_interval

keyframe_interval: object

- Defined in schema/transforms.schema.ts:967

### maximum

maximum: number = 250

- Defined in schema/transforms.schema.ts:970

### minimum

minimum: number = 250

- Defined in schema/transforms.schema.ts:969

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:968

### location

location: object

- Defined in schema/transforms.schema.ts:1022

### $ref

$ref: string = "locationsDef"

- Defined in schema/transforms.schema.ts:1023

### path

path: object

- Defined in schema/transforms.schema.ts:1025

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1026

### preset

preset: object

- Defined in schema/transforms.schema.ts:929

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:930

### title

title: object

- Defined in schema/transforms.schema.ts:935

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:936

### two_pass

two_pass: object

- Defined in schema/transforms.schema.ts:954

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:955

### upscale

upscale: object

- Defined in schema/transforms.schema.ts:941

### type

type: string = "boolean"

- Defined in schema/transforms.schema.ts:942

### video_bitrate

video_bitrate: object

- Defined in schema/transforms.schema.ts:957

### maximum

maximum: number = 5000

- Defined in schema/transforms.schema.ts:960

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:959

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:958

### watermark_bottom

watermark_bottom: object

- Defined in schema/transforms.schema.ts:1003

### maximum

maximum: number = 9999

- Defined in schema/transforms.schema.ts:1006

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1005

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:1004

### watermark_left

watermark_left: object

- Defined in schema/transforms.schema.ts:1008

### maximum

maximum: number = 9999

- Defined in schema/transforms.schema.ts:1011

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1010

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:1009

### watermark_right

watermark_right: object

- Defined in schema/transforms.schema.ts:998

### maximum

maximum: number = 9999

- Defined in schema/transforms.schema.ts:1001

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1000

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:999

### watermark_top

watermark_top: object

- Defined in schema/transforms.schema.ts:993

### maximum

maximum: number = 9999

- Defined in schema/transforms.schema.ts:996

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:995

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:994

### watermark_url

watermark_url: object

- Defined in schema/transforms.schema.ts:990

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:991

### width

width: object

- Defined in schema/transforms.schema.ts:919

### maximum

maximum: number = 4096

- Defined in schema/transforms.schema.ts:922

### minimum

minimum: number = 1

- Defined in schema/transforms.schema.ts:921

### type

type: string = "integer"

- Defined in schema/transforms.schema.ts:920

### vignette

vignette: object

- Defined in schema/transforms.schema.ts:389

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'object',properties: {amount: {type: 'integer',minimum: 0,maximum: 100,default: 20,},blurmode: {type: 'string',enum: ['gaussian', 'linear'],default: 'gaussian',},background: {'$ref': 'colorDef',},},additionalProperties: false,}]

- Defined in schema/transforms.schema.ts:390

### watermark

watermark: object

- Defined in schema/transforms.schema.ts:1074

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/transforms.schema.ts:1092

### required

required: string[] = ['file',]

- Defined in schema/transforms.schema.ts:1089

### type

type: string = "object"

- Defined in schema/transforms.schema.ts:1075

### properties

properties: object

- Defined in schema/transforms.schema.ts:1076

### file

file: object

- Defined in schema/transforms.schema.ts:1077

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1078

### position

position: object

- Defined in schema/transforms.schema.ts:1085

### $ref

$ref: string = "positionDef"

- Defined in schema/transforms.schema.ts:1086

### size

size: object

- Defined in schema/transforms.schema.ts:1080

### maximum

maximum: number = 500

- Defined in schema/transforms.schema.ts:1083

### minimum

minimum: number = 0

- Defined in schema/transforms.schema.ts:1082

### type

type: string = "number"

- Defined in schema/transforms.schema.ts:1081

### zip

zip: object

- Defined in schema/transforms.schema.ts:1203

### type

type: string = "string"

- Defined in schema/transforms.schema.ts:1204

### Const UploadParamsSchema

UploadParamsSchema: object

- Defined in schema/upload.schema.ts:17

### $schema

$schema: string = "http://json-schema.org/draft-07/schema#"

- Defined in schema/upload.schema.ts:18

### additionalProperties

additionalProperties: boolean = false

- Defined in schema/upload.schema.ts:22

### description

description: string = "Filestack Upload Options"

- Defined in schema/upload.schema.ts:20

### title

title: string = "Filestack Upload"

- Defined in schema/upload.schema.ts:19

### type

type: string = "object"

- Defined in schema/upload.schema.ts:21

### properties

properties: object

- Defined in schema/upload.schema.ts:23

### concurrency

concurrency: object

- Defined in schema/upload.schema.ts:28

### maximum

maximum: number = 20

- Defined in schema/upload.schema.ts:31

### minimum

minimum: number = 1

- Defined in schema/upload.schema.ts:30

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:29

### intelligent

intelligent: object

- Defined in schema/upload.schema.ts:53

### oneOf

oneOf: (object | object)[] = [{type: 'boolean',}, {type: 'string',enum: ['fallback'],}]

- Defined in schema/upload.schema.ts:54

### intelligentChunkSize

intelligentChunkSize: object

- Defined in schema/upload.schema.ts:61

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:62

### onProgress

onProgress: object

- Defined in schema/upload.schema.ts:64

### format

format: string = "callback"

- Defined in schema/upload.schema.ts:65

### onRetry

onRetry: object

- Defined in schema/upload.schema.ts:67

### format

format: string = "callback"

- Defined in schema/upload.schema.ts:68

### partSize

partSize: object

- Defined in schema/upload.schema.ts:24

### minimum

minimum: number = 5 * 1024 * 1024

- Defined in schema/upload.schema.ts:26

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:25

### progressInterval

progressInterval: object

- Defined in schema/upload.schema.ts:33

### minimum

minimum: number = 1

- Defined in schema/upload.schema.ts:35

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:34

### retry

retry: object

- Defined in schema/upload.schema.ts:37

### maximum

maximum: number = 20

- Defined in schema/upload.schema.ts:40

### minimum

minimum: number = 0

- Defined in schema/upload.schema.ts:39

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:38

### retryFactor

retryFactor: object

- Defined in schema/upload.schema.ts:42

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:43

### retryMaxTime

retryMaxTime: object

- Defined in schema/upload.schema.ts:45

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:46

### timeout

timeout: object

- Defined in schema/upload.schema.ts:48

### maximum

maximum: number = 60 * 60 * 1000

- Defined in schema/upload.schema.ts:51

### minimum

minimum: number = 1

- Defined in schema/upload.schema.ts:50

### type

type: string = "integer"

- Defined in schema/upload.schema.ts:49

### Const config

config: object

- Defined in config.ts:42

### urls

urls: object

- Defined in config.ts:43

### cdnUrl

cdnUrl: string = "https://cdn.filestackcontent.com"

- Defined in config.ts:47

### cloudApiUrl

cloudApiUrl: string = "https://cloud.filestackapi.com"

- Defined in config.ts:46

### fileApiUrl

fileApiUrl: string = "https://www.filestackapi.com/api/file"

- Defined in config.ts:44

### pickerUrl

pickerUrl: string = `https://static.filestackapi.com/picker/${PICKER_VERSION}/picker.js`

- Defined in config.ts:48

### uploadApiUrl

uploadApiUrl: string = "https://upload.filestackapi.com"

- Defined in config.ts:45

### Const defaultSession

defaultSession: object

- Defined in lib/api/preview.spec.browser.ts:22

### apikey

apikey: string = "TEST_API_KEY"

- Defined in lib/api/preview.spec.browser.ts:23

### urls

urls: object

- Defined in lib/api/preview.spec.browser.ts:24

### cdnUrl

cdnUrl: string = "https://cdn.filestackcontent.com"

- Defined in lib/api/preview.spec.browser.ts:28

### cloudApiUrl

cloudApiUrl: string = "https://cloud.filestackapi.com"

- Defined in lib/api/preview.spec.browser.ts:27

### fileApiUrl

fileApiUrl: string = "https://www.filestackapi.com/api/file"

- Defined in lib/api/preview.spec.browser.ts:25

### pickerUrl

pickerUrl: string = "https://static.filestackapi.com/picker/1.4.4/picker.js"

- Defined in lib/api/preview.spec.browser.ts:29

### uploadApiUrl

uploadApiUrl: string = "https://upload.filestackapi.com"

- Defined in lib/api/preview.spec.browser.ts:26

### Const testSecurity

testSecurity: object

- Defined in lib/api/cloud.spec.browser.ts:28

### policy

policy: string = "examplePolicy"

- Defined in lib/api/cloud.spec.browser.ts:29

### signature

signature: string = "exampleSignature"

- Defined in lib/api/cloud.spec.browser.ts:30

### Const testSession

testSession: object

- Defined in lib/api/cloud.spec.browser.ts:34

### apikey

apikey: string = testApiKey

- Defined in lib/api/cloud.spec.browser.ts:35

### urls

urls: object = sessionURls

- Defined in lib/api/cloud.spec.browser.ts:36

#### Type declaration

- ##### cdnUrl: string

- ##### cloudApiUrl: string

- ##### fileApiUrl: string

- ##### pickerUrl: string

- ##### uploadApiUrl: string