Filestack JS

https://filestack.github.io/filestack-js
Admin
Filestack JS is a JavaScript SDK for the Filestack API providing file uploading, image processing...
Tokens:43,467
Snippets:543
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run Examples Locally

Source: https://filestack.github.io/filestack-js/index.html

Execute the example applications locally by running the specified npm script. This is useful for testing and exploring features.

```bash
npm run examples

```

--------------------------------

### Install filestack-js with npm

Source: https://filestack.github.io/filestack-js/index.html

Install the filestack-js package using npm. Ensure you have an API key from Filestack.

```bash
npm install filestack-js

```

--------------------------------

### Initiate Multi-part Upload

Source: https://filestack.github.io/filestack-js/classes/Client.html

Start a multi-part upload for files, suitable for Filestack CIN and FII uploads. The upload process can be controlled via a token for pausing, resuming, or canceling.

```javascript
const token = {};
const onRetry = (obj) => {
  console.log(`Retrying ${obj.location} for ${obj.filename}. Attempt ${obj.attempt} of 10.`);
};

client.multiupload([file], { onRetry }, token)
  .then(res => console.log(res));

client.multiupload([{file, name}], { onRetry }, token)
  .then(res => console.log(res));

token.pause();  // Pause flow
token.resume(); // Resume flow
token.cancel(); // Cancel flow (rejects)
```

--------------------------------

### Retrieve File with Metadata using Filestack Client

Source: https://filestack.github.io/filestack-js/classes/Client.html

Access files using their Filestack handles. This example demonstrates retrieving file metadata. Note that the 'metadata' and 'head' options cannot be used together. For downloading files, consider using the 'metadata' or 'download' methods instead.

```javascript
client.retrieve('fileHandle', {  
 metadata: true,  
}).then((response) => {  
 console.log(response);  
}).catch((err) => {  
 console.error(err);  
})
```

--------------------------------

### Download File by Handle

Source: https://filestack.github.io/filestack-js/classes/Client.html

Download a file using its handle. The response data can be used with the File API, for example, to display an image.

```javascript
client.download('fileHandle').then((response) => {
const img = new Image();
img.src = URL.createObjectURL(res.data)
document.body.appendChild(img);
}).catch((err) => {
 console.error(err);
})
```

--------------------------------

### Transform Image URL using Filestack Client

Source: https://filestack.github.io/filestack-js/classes/Client.html

Interface with the Filestack Processing API to transform a file. This example shows applying several transformations like crop, vignette, and partial pixelation to an image URL. The transformed URL can optionally be stored using `client.storeURL`.

```javascript
const transformedUrl = client.transform(url, {  
  crop: {  
    dim: [x, y, width, height],  
  },  
  vignette: {  
    blurmode: 'gaussian',  
    amount: 50,  
  },  
  flip: true,  
  partial_pixelate: {  
    objects: [[10, 20, 200, 250], [275, 91, 500, 557]],  
  },  
};  
  
// optionally store the new URL  
client.storeURL(transformedUrl).then(res => console.log(res));
```

--------------------------------

### Upload Event Callbacks

Source: https://filestack.github.io/filestack-js/interfaces/PickerOptions.html

Callbacks triggered during the file upload process, including start, progress, cancellation, failure, and completion.

```APIDOC
## Upload Event Callbacks

### `Optional` onFileUploadCancel
* **Type:** `PickerFileCancelCallback`
* **Description:** Called when a file upload has been canceled.

### `Optional` onFileUploadFailed
* **Type:** `PickerFileErrorCallback`
* **Description:** Called when uploading a file fails.

### `Optional` onFileUploadFinished
* **Type:** `PickerFileCallback`
* **Description:** Called when a file is done uploading.

### `Optional` onFileUploadProgress
* **Type:** `PickerFileProgressCallback`
* **Description:** Called during multi-part upload progress events. Local files only.

### `Optional` onFileUploadStarted
* **Type:** `PickerFileWithTokenCallback`
* **Description:** Called when a file begins uploading.
```

--------------------------------

### FsRequest.get

Source: https://filestack.github.io/filestack-js/classes/FsRequest.html

Dispatches a GET request to the specified URL. The config parameter is optional.

```APIDOC
## get

### Description
Dispatch GET request.

### Method
GET

### Endpoint
/{url}

### Parameters
- **url** (string) - Required - The URL to send the request to.
- **config** (FsRequestOptions) - Optional - Configuration options for the request.

### Returns
Promise<FsResponse>
```

--------------------------------

### Filelink Constructor and Basic Transformations

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Instantiate Filelink with a file handle or URL and an API key. Demonstrates chaining transformations like flip and flop, and storing the result. Also shows how to enable base64 support.

```javascript
const link = new Filelink('handle or externalUrl', 'apikey');
link.flip().flop().store();

console.log(link.toString());
// enable base64 support
link.setBase64(true)

console.log(link.toString());
```

--------------------------------

### Client Constructor

Source: https://filestack.github.io/filestack-js/classes/Client.html

Initializes a new Filestack client instance. This is the main entry point for using the Filestack JavaScript SDK.

```APIDOC
## constructor Client

### Description
Initializes a new Filestack client instance.

### Parameters
- **apikey**: string - Your Filestack API key.
- **options**: ClientOptions - Optional configuration options for the client.
```

--------------------------------

### Initialize Filestack Client (ES Module)

Source: https://filestack.github.io/filestack-js/classes/Client.html

Initialize the Filestack client using ES module syntax. This is the recommended approach for modern JavaScript projects.

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

--------------------------------

### Initialize Filestack Client (CommonJS Module)

Source: https://filestack.github.io/filestack-js/index.html

Initialize the Filestack client in a Node.js environment using CommonJS modules. Requires an API key.

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

```

--------------------------------

### Get SRI Hashes for Filestack JS

Source: https://filestack.github.io/filestack-js/index.html

Obtain Subresource Integrity (SRI) hashes for the filestack-js library from the CDN manifest file. This is used for security verification.

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

```

--------------------------------

### Filestack Client Initialization

Source: https://filestack.github.io/filestack-js/functions/Filestack.html

Initializes the Filestack client using your API key. You can also provide optional configurations to customize its behavior.

```APIDOC
## Filestack(apikey: string, options?: ClientOptions)

### Description
Initialize client with given config

### Parameters
#### apikey: string
- The API key for your Filestack project.
#### options: ClientOptions (Optional)
- An object containing optional client configurations.
```

--------------------------------

### Initialize Filestack Client (UMD Module)

Source: https://filestack.github.io/filestack-js/classes/Client.html

Initialize the Filestack client using UMD module syntax for browser environments. Ensure the Filestack JS library is included via a script tag.

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

--------------------------------

### Picker Instance and UI Options

Source: https://filestack.github.io/filestack-js/interfaces/PickerOptions.html

Options related to the Picker instance, UI behavior, and display modes.

```APIDOC
## Picker Instance and UI Options

### `Optional` onOpen
* **Type:** `(handle: PickerInstance) => void`
* **Description:** Called when the UI is mounted.
* **Parameters:**
    * **handle:** `PickerInstance` - The picker instance handle.
* **Returns:** `void`

### `Optional` onUploadDone
* **Type:** `PickerUploadDoneCallback`
* **Description:** Called when all files have been uploaded.

### `Optional` onUploadStarted
* **Type:** `PickerUploadStartedCallback`
* **Description:** Called when uploading starts (user initiates uploading).

### `Optional` pasteMode
* **Type:** `{ pasteToFirstInViewPort?: boolean; pasteToFirstInstance?: boolean; }`
* **Description:** Specify which Picker instance should respond to paste event. By default only hovered instance responds to event.
    * **pasteToFirstInViewPort:** If none instance is hovered, take the first picker instance fully visible in the viewport.
    * **pasteToFirstInstance:** If none instance is hovered, take the first picker instance that is initialized.

### `Optional` rootId
* **Type:** `string`
* **Description:** Define a unique id for the application mount point. May be useful for more advanced use cases, like having more than one picker instance open at once. This option is ignored when `displayMode` is `dropPane`.

### `Optional` startUploadingWhenMaxFilesReached
* **Type:** `boolean`
* **Description:** Whether to start uploading automatically when maxFiles is hit. Defaults to `false`.

### `Optional` viewType
* **Type:** `"list" | "grid"`
* **Description:** Default view type option for file browser.
```

--------------------------------

### Picker Options

Source: https://filestack.github.io/filestack-js/interfaces/PickerOptions.html

These are the optional configurations available for the Filestack Picker.

```APIDOC
## `Optional` disableThumbnails
disableThumbnails?: boolean
Disables local image thumbnail previews in the summary screen.

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

## `Optional` displayMode
displayMode?: PickerDisplayMode
Picker display mode, one of `'inline'`, `'overlay'`, `'dropPane'` - default is `'overlay'`.

## `Optional` dropPane
dropPane?: PickerDropPaneOptions
Configure the drop pane behavior, i.e. when `displayMode` is `dropPane`.

## `Optional` errorsTimeout
errorsTimeout?: number
Timeout for error messages

## `Optional` exposeOriginalFile
exposeOriginalFile?: boolean
When true the `originalFile` metadata will be the actual `File` object instead of a POJO

## `Optional` fromSources
fromSources?: string[]
Valid sources are:
  * local_file_system - Default
  * url - Default
  * imagesearch - Default
  * facebook - Default
  * instagram - Default
  * googledrive - Default
  * dropbox - Default
  * webcam - Uses device menu on mobile. Not currently supported in Safari and IE.
  * video - Uses device menu on mobile. Not currently supported in Safari and IE.
  * audio - Uses device menu on mobile. Not currently supported in Safari and IE.
  * box
  * github
  * gmail
  * googlephotos
  * onedrive
  * onedriveforbusiness
  * customsource - Configure this in your Filestack Dev Portal.
  * unsplash

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

## `Optional` googleAppOrigin
googleAppOrigin?: string
Sets the origin of picker dialog. The origin should be set to the window.location.protocol + '//' + window.location.host of the top-most page, if your application is running in an iframe.

## `Optional` googleDriveAppID
googleDriveAppID?: string
Set your own Google Drive Picker App ID. Defaults to Filestack's. This is your Project Number from the Google Cloud console.

## `Optional` hideModalWhenUploading
hideModalWhenUploading?: boolean
Hide the picker modal UI once uploading begins. Defaults to `false`.

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

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

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

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

## `Optional` maxFiles
maxFiles?: number
Maximum number of files allowed to upload. Defaults to 1.

## `Optional` maxSize
maxSize?: number
Restrict selected files to a maximum number of bytes. (e.g. 10 * 1024 * 1024 for 10MB limit).

## `Optional` minFiles
minFiles?: number
Minimum number of files required to start uploading. Defaults to 1.

## `Optional` miniUploader
miniUploader?: boolean
Enable/Disable Mini Uploader

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

## `Optional` multipleFileUpload
multipleFileUpload?: boolean
Enable/Disable possibility to multiple file upload

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

## `Optional` onClose
onClose?: (() => void)
#### Type declaration
  *     * (): void
    * Called when the UI is exited.
#### Returns void

## `Optional` onFileCropped
onFileCropped?: PickerFileCallback
Called when file is cropped in picker

## `Optional` onFileSelected
onFileSelected?: PickerFileCallback
Called whenever user selects a file.
```

--------------------------------

### ClientOptions Properties

Source: https://filestack.github.io/filestack-js/interfaces/ClientOptions.html

Configuration options for the Filestack client.

```APIDOC
## ClientOptions

### Description
Configuration options for the Filestack client.

### Properties

#### `cname` (string, Optional)
Domain to use for all URLs. **Requires the custom CNAME addon**. If this is enabled then you must also set up your own OAuth applications for each cloud source you wish to use in the picker.

#### `forwardErrors` (boolean, Optional)
Enable forwarding error logs to sentry. Default is false.

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

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

--------------------------------

### zip

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Creates a zip package of the files in the current context.

```APIDOC
## zip

### Description
Adds a zip transformation which creates a zip package on files used on actual context.

### Method
zip()

### Returns
Filelink
```

--------------------------------

### PreviewOptions

Source: https://filestack.github.io/filestack-js/interfaces/PreviewOptions.html

Configuration options for controlling the appearance and behavior of file previews.

```APIDOC
## Interface PreviewOptions

### Properties

#### `css` (string, optional)
URL to custom CSS for styling the preview.

#### `id` (string)
Id for the DOM element to embed the preview into. If omitted, the preview will open in a new tab.

#### `theme` (OSLightDark, optional)
Specifies the theme for the preview (e.g., OSLightDark).
```

--------------------------------

### Run Unit Tests with Jest

Source: https://filestack.github.io/filestack-js/index.html

Execute unit tests for the Filestack-JS library using npm. Ensure all backend services are mocked for unit testing.

```bash
npm test

```

--------------------------------

### Video and Web Search Options

Source: https://filestack.github.io/filestack-js/interfaces/PickerOptions.html

Configuration for video recording resolution and web search functionality.

```APIDOC
## Video and Web Search Options

### `Optional` videoResolution
* **Type:** `string`
* **Description:** Sets the resolution of recorded video. One of "320x240", "640x480" or "1280x720". Default is `"640x480"`.

### `Optional` websearch
* **Type:** `object`
* **Description:** Provide default text value for Image Search.
* **Example:**
```javascript
websearch: {
  predefinedText: 'Sample text'
}
```
```

--------------------------------

### Crop Files with PickerInstance

Source: https://filestack.github.io/filestack-js/interfaces/PickerInstance.html

Use the crop method to open the picker with specific files for cropping. This can be triggered by a file input change event or by passing an array of URL strings directly.

```javascript
// <input id="fileSelect" type="file">

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

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

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

--------------------------------

### picker

Source: https://filestack.github.io/filestack-js/classes/Client.html

Constructs and returns a new picker instance, which can be used to select files from various sources.

```APIDOC
## picker

### Description
Construct a new picker instance.

### Parameters
- **options**: PickerOptions - Optional - Configuration options for the picker.

### Returns
PickerInstance
```

--------------------------------

### Initiate Multi-part Upload with Filestack JS

Source: https://filestack.github.io/filestack-js/classes/Client.html

Use this method for Filestack CIN and FII uploads. In Node.js, the file argument is treated as a file path. Uploading from a Node buffer is not yet implemented. The control token can be used to pause, resume, or cancel the upload flow.

```javascript
const token = {};  
const onRetry = (obj) => {  
  console.log(`Retrying ${obj.location} for ${obj.filename}. Attempt ${obj.attempt} of 10.`);  
};  
  
client.upload(file, { onRetry }, { filename: 'foobar.jpg' }, token)  
  .then(res => console.log(res));  
  
client.upload({file, name}, { onRetry }, { filename: 'foobar.jpg' }, token)  
  .then(res => console.log(res));  
  
token.pause();  // Pause flow  
token.resume(); // Resume flow  
token.cancel(); // Cancel flow (rejects)
```

--------------------------------

### utils

Source: https://filestack.github.io/filestack-js/classes/Client.html

Provides access to utility functions within the Filestack client.

```APIDOC
## utils

### Description
Provides access to Filestack utility functions.

### Returns
__module - Filestack utils
```

--------------------------------

### Storage and Transformation Options

Source: https://filestack.github.io/filestack-js/interfaces/PickerOptions.html

Configuration for storing uploaded files and applying transformations.

```APIDOC
## Storage and Transformation Options

### `Optional` storeTo
* **Type:** `PickerStoreOptions`
* **Description:** Options for file storage.

### `Optional` transformations
* **Type:** `PickerTransformationOptions`
* **Description:** Specify options for images passed to the crop UI.

### `Optional` transformationsUI
* **Type:** `boolean`
* **Description:** Whether to use the new transformations UI. Defaults to `false`.
* **Important:** This feature can be enabled only if crop is disabled (`disableTransformer: true`).
```

--------------------------------

### store

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for storing the transformed file.

```APIDOC
## store

### Description
Options for storing the transformed file.

### Parameters
#### Request Body
- **access** (string) - Optional - The access level for the stored file.
- **base64decode** (boolean) - Optional - Whether to base64 decode the file before storing.
- **container** (string) - Optional - The container to store the file in.
- **filename** (string) - Optional - The filename for the stored file.
- **location** (string) - Optional - The location to store the file.
- **path** (string) - Optional - The path within the container to store the file.
- **region** (string) - Optional - The region for storage.
```

--------------------------------

### upload

Source: https://filestack.github.io/filestack-js/classes/Client.html

Initiates a multi-part upload flow. Use this for Filestack CIN and FII uploads. In Node runtimes the file argument is treated as a file path. Uploading from a Node buffer is not yet implemented.

```APIDOC
## upload

### Description
Initiates a multi-part upload flow. Use this for Filestack CIN and FII uploads.
In Node runtimes the file argument is treated as a file path. Uploading from a Node buffer is not yet implemented.

### Method Signature
upload(file: InputFile, options?: UploadOptions, storeOptions?: StoreUploadOptions, token?: any, security?: Security): Promise<any>

### Parameters
#### file: InputFile
Must be a valid [File | Blob | Buffer | string]

#### `Optional` options: UploadOptions

#### `Optional` storeOptions: StoreUploadOptions
Storage options.

#### `Optional` token: any
A control token that can be used to call cancel(), pause(), and resume().

#### `Optional` security: Security
Optional security policy and signature override.

### Request Example
```javascript
const token = {};  
const onRetry = (obj) => {  
  console.log(`Retrying ${obj.location} for ${obj.filename}. Attempt ${obj.attempt} of 10.`);  
};

client.upload(file, { onRetry }, { filename: 'foobar.jpg' }, token)
  .then(res => console.log(res));

client.upload({file, name}, { onRetry }, { filename: 'foobar.jpg' }, token)
  .then(res => console.log(res));

token.pause();  // Pause flow  
token.resume(); // Resume flow  
token.cancel(); // Cancel flow (rejects)
```

### Returns
Promise<any>
```

--------------------------------

### prefetch

Source: https://filestack.github.io/filestack-js/classes/Client.html

Makes a basic prefetch request to check file permissions before performing other operations.

```APIDOC
## prefetch

### Description
Make basic prefetch request to check permissions

### Parameters
- **params**: PrefetchOptions - Required - Prefetch options.

### Returns
Promise<PrefetchResponse>
```

--------------------------------

### preview

Source: https://filestack.github.io/filestack-js/classes/Client.html

Opens a file in the Filestack Document Viewer. This requires the Document Viewer addon to be enabled for your Filestack application. If an `id` is not provided in the options, the viewer opens in a new window.

```APIDOC
## preview

### Description
Used for viewing files via Filestack handles or storage aliases, **requires Document Viewer addon to your Filestack application**. Opens document viewer in new window if id option is not provided.

### Parameters
- **handle**: string - Required - Valid Filestack handle.
- **options**: PreviewOptions - Optional - Preview options.

### Returns
HTMLIFrameElement | Window
```

--------------------------------

### PickerInstance.open

Source: https://filestack.github.io/filestack-js/interfaces/PickerInstance.html

Opens the Filestack picker interface for user interaction. This operation is idempotent.

```APIDOC
## open

### Description
Open picker. This operation is idempotent.

### Method
`open`

### Returns
Promise<void>
```

--------------------------------

### Preview File

Source: https://filestack.github.io/filestack-js/classes/Client.html

Open a file in the Filestack Document Viewer. This requires the Document Viewer addon and can be embedded in a div or opened in a new window.

```javascript
// <div id="preview"></div>  

client.preview('DCL5K46FS3OIxb5iuKby', { id: 'preview' });
```

--------------------------------

### Filelink Constructor

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Initializes a new Filelink instance. It can be used with a single file handle, multiple handles for collage, or an external URL. An API key is required for external sources.

```APIDOC
## constructor Filelink

### Description
Class for generating transformation URLs.

### Parameters
* **source**: string | string[] - Handle or multiple handles (i.e. for collage)
* **`Optional` apikey**: string - Your apikey - required for all external sources

### Returns
Filelink
```

--------------------------------

### output(params: OutputParams)

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds the output transformation to control the output format and quality of the file. Requires OutputParams for configuration.

```APIDOC
## output(params: OutputParams)

### Description
Adds the output transformation to control the output format and quality of the file.

### Method
This is a method of the Filelink class.

### Parameters
#### params: OutputParams
- `params` (OutputParams) - Required - Configuration for the output transformation.
```

--------------------------------

### Include Filestack JS via UMD Module

Source: https://filestack.github.io/filestack-js/index.html

Include the Filestack JS SDK in a browser using a UMD module via a script tag. Replace {MAJOR_VERSION} with the appropriate version. An API key is needed for initialization.

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

```

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

```

--------------------------------

### upscale

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for upscaling an image.

```APIDOC
## upscale

### Description
Options for upscaling an image.

### Parameters
#### Request Body
- **noise** (ENoiseType) - Optional - The type of noise to apply during upscaling.
- **style** (EStyleType) - Optional - The style of upscaling.
- **upscale** (boolean) - Optional - Whether to perform upscaling.
```

--------------------------------

### Include Filestack JS with SRI

Source: https://filestack.github.io/filestack-js/index.html

Include the Filestack JS SDK in a browser using a script tag with Subresource Integrity (SRI) for security. Replace {LIBRARY_VERSION} and {FILE_HASH} with actual values.

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

```

--------------------------------

### Enable Debugging in Node.js

Source: https://filestack.github.io/filestack-js/index.html

Run Node.js scripts with the DEBUG environment variable set to 'fs.*' to enable Filestack-JS debugging output.

```bash
DEBUG=fs.* node example_upload.js

```

--------------------------------

### setSource

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Sets the source for the file.

```APIDOC
## setSource

### Description
Set source for the file.

### Method Signature
`setSource(source: string | string[]): void`

### Parameters
* `source` (string | string[]) - Required. The source to set.
```

--------------------------------

### Video Transformation Options

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for transforming video assets. These include settings for aspect ratio, audio, clipping, container, filename, resolution, and more.

```APIDOC
## Video Transformation Options

### Description
Options for transforming video assets. These include settings for aspect ratio, audio, clipping, container, filename, resolution, and more.

### Parameters
#### General Options
- **access** (EVideoAccess) - Optional - Access level for the video.
- **aspect_mode** (EVideoAccessMode) - Aspect ratio mode.
- **audio_bitrate** (number) - Optional - Audio bitrate in kbps.
- **audio_channels** (number) - Optional - Number of audio channels.
- **audio_codec** (EAudioTypes) - Optional - Audio codec to use.
- **audio_sample_rate** (number) - Optional - Audio sample rate in Hz.
- **clip_length** (string) - Optional - Length of the video clip to extract (e.g., '10s').
- **clip_offset** (string) - Optional - Offset from the beginning of the video to start the clip (e.g., '5s').
- **container** (string) - Optional - The container format for the output video (e.g., 'mp4').
- **extname** (string) - Optional - The file extension for the output video.
- **filename** (string) - Optional - The desired filename for the output video.
- **force** (boolean) - Optional - Force transformation even if the file is not a video.
- **fps** (number) - Optional - Frames per second for the output video.
- **height** (number) - Optional - Height of the output video in pixels.
- **keyframe_interval** (number) - Optional - Keyframe interval in seconds.
- **location** (EVideoLocations) - Optional - Location for storing the transformed video.
- **path** (string) - Optional - Path for the transformed video.
- **preset** (EVideoTypes) - Optional - Preset for video transformation.
- **title** (string) - Optional - Title for the video.
- **two_pass** (boolean) - Optional - Enable two-pass encoding for better quality.
- **upscale** (boolean) - Required - Whether to upscale the video if the output resolution is larger than the input.
- **video_bitrate** (number) - Optional - Video bitrate in kbps.
- **watermark_bottom** (number) - Optional - Bottom padding for watermark.
- **watermark_height** (number) - Optional - Height of the watermark.
- **watermark_left** (number) - Optional - Left padding for watermark.
- **watermark_right** (number) - Optional - Right padding for watermark.
- **watermark_top** (number) - Optional - Top padding for watermark.
- **watermark_url** (string) - Optional - URL of the watermark image.
- **watermark_width** (number) - Optional - Width of the watermark.
- **width** (number) - Optional - Width of the output video in pixels.

### Vignette Options
- **vignette.amount** (number) - Optional - Amount of vignette effect.
- **vignette.background** (string) - Optional - Background color for the vignette.
- **vignette.blurmode** (EBlurMode) - Optional - Blur mode for the vignette.

### Watermark Options
- **watermark.files** (string) - Required - URL of the watermark file.
- **watermark.position** (EImageWatermarkPosition | EImageWatermarkPosition[]) - Optional - Position of the watermark.
- **watermark.size** (number) - Optional - Size of the watermark.
```

--------------------------------

### minifyCss(params: MinifyCssParams)

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds a task to minify a CSS file. Requires MinifyCssParams for configuration.

```APIDOC
## minifyCss(params: MinifyCssParams)

### Description
Adds a task to minify a CSS file.

### Method
This is a method of the Filelink class.

### Parameters
#### params: MinifyCssParams
- `params` (MinifyCssParams) - Required - Configuration for CSS minification.
```

--------------------------------

### smart_crop

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for smart cropping an image.

```APIDOC
## smart_crop

### Description
Options for smart cropping an image.

### Parameters
#### Request Body
- **height** (number) - Required - The desired height for the cropped image.
- **mode** (ESmartCropMode) - Optional - The mode for smart cropping.
- **width** (number) - Required - The desired width for the cropped image.
```

--------------------------------

### MinifyCssParams

Source: https://filestack.github.io/filestack-js/interfaces/MinifyCssParams.html

This interface defines optional parameters for CSS minification. It includes settings for gzip compression.

```APIDOC
## Interface MinifyCssParams

### Properties

#### `Optional` gzip
`gzip?: boolean`

Specifies whether to use gzip compression.

#### `Optional` level
`level?: number`

Sets the gzip compression level (typically 0-9).
```

--------------------------------

### resize

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for resizing an image.

```APIDOC
## resize

### Description
Options for resizing an image.

### Parameters
#### Request Body
- **align** (EAlignFacesOptions) - Optional - Alignment options for faces during resize.
- **fit** (EFitOptions) - Optional - Fit options for the resized image.
- **height** (number) - Optional - The desired height of the image.
- **width** (number) - Optional - The desired width of the image.
```

--------------------------------

### RetrieveOptions Properties

Source: https://filestack.github.io/filestack-js/interfaces/RetrieveOptions.html

This interface defines optional properties that can be used to control how files are retrieved.

```APIDOC
## Interface RetrieveOptions

### Properties

*   **cache?** (boolean) - Optional. If true, the file will be cached.
*   **dl?** (boolean) - Optional. If true, the file will be downloaded.
*   **extension?** (string) - Optional. Specifies the desired file extension.
*   **head?** (boolean) - Optional. If true, only the headers of the file will be retrieved.
*   **metadata?** (boolean) - Optional. If true, metadata associated with the file will be retrieved.
```

--------------------------------

### FilestackError Constructor

Source: https://filestack.github.io/filestack-js/classes/FilestackError.html

Initializes a new instance of the FilestackError class.

```APIDOC
## Constructor

### new FilestackError(message?: string, details?: any, type?: FilestackErrorType): FilestackError

#### Parameters
* `Optional` message: string
* `Optional` details: any
* `Optional` type: FilestackErrorType

#### Returns
FilestackError
```

--------------------------------

### minifyJs(params: MinifyJsParams)

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds a task to minify a JavaScript file. For better handling of the 'targets' parameter, use with the b64 flag enabled. Requires MinifyJsParams for configuration.

```APIDOC
## minifyJs(params: MinifyJsParams)

### Description
Adds a task to minify a JavaScript file. For better handling of 'targets' param, use with b64 flag enabled.

### Method
This is a method of the Filelink class.

### Parameters
#### params: MinifyJsParams
- `params` (MinifyJsParams) - Required - Configuration for JavaScript minification.
```

--------------------------------

### resize(params: ResizeParams)

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds the resize transformation to resize an image. Requires ResizeParams for configuration.

```APIDOC
## resize(params: ResizeParams)

### Description
Adds the resize transformation to resize an image.

### Method
This is a method of the Filelink class.

### Parameters
#### params: ResizeParams
- `params` (ResizeParams) - Required - Configuration for the resize transformation.
```

--------------------------------

### PrefetchOptions Type Definition

Source: https://filestack.github.io/filestack-js/types/PrefetchOptions.html

Defines the structure for configuring prefetch options.

```APIDOC
## Type alias PrefetchOptions

`PrefetchOptions`: {
  `events?`: PrefetchEvents[];
  `permissions?`: (keyof PrefetchPermissions)[];
  `pickerOptions?`: PickerOptions;
  `settings?`: (keyof PrefetchSettings)[];
}

### Type declaration

* ##### `Optional` events?: PrefetchEvents[]
* ##### `Optional` permissions?: (keyof PrefetchPermissions)[]
* ##### `Optional` pickerOptions?: PickerOptions
* ##### `Optional` settings?: (keyof PrefetchSettings)[]
```

--------------------------------

### getVersion()

Source: https://filestack.github.io/filestack-js/functions/getVersion.html

Retrieves the currently used filestack-js SDK version.

```APIDOC
## getVersion()

### Description
Returns the currently used filestack-js SDK version.

### Method
`getVersion()`

### Returns
- string: The current version of the filestack-js SDK.
```

--------------------------------

### cropFaces

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds the cropFaces transformation to the file. This transformation requires specific parameters.

```APIDOC
## cropFaces

### Description
Adds crop faces transformation.

### Method
```javascript
cropFaces(params: CropFacesParams): Filelink
```

### Parameters
#### params
- params: CropFacesParams - Parameters for the cropFaces transformation.
```

--------------------------------

### retrieve

Source: https://filestack.github.io/filestack-js/classes/Client.html

Accesses files via their Filestack handles. Can return file content, metadata, or headers based on options. Deprecated; use metadata or download methods instead.

```APIDOC
## retrieve

### Description
Access files via their Filestack handles.
If head option is provided - request headers are returned in promise If metadata option is provided - metadata object is returned in promise Otherwise file blob is returned Metadata and head options cannot be mixed

### Method
retrieve(handle: string, options?: RetrieveOptions, security?: Security): Promise<Object | Blob>

### Parameters
#### Path Parameters
- **handle** (string) - Required - Valid file handle.
- **options** (RetrieveOptions) - Optional - RetrieveOptions.
- **security** (Security) - Optional - Optional security override.

### Request Example
```javascript
client.retrieve('fileHandle', {  
 metadata: true,  
}).then((response) => {
 console.log(response);
}).catch((err) => {
 console.error(err);
})
```

### Response
#### Success Response (200)
- **Object | Blob** - The file content, metadata, or headers.

### See
File API - Download
### Deprecated
use metadata or download methods instead
### Throws
Error
```

--------------------------------

### smartCrop

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds smart crop transformation to the file. Requires SmartCropParams.

```APIDOC
## smartCrop

### Description
Adds imagesize transformation.

### Method Signature
`smartCrop(params: SmartCropParams): Filelink`

### Parameters
* `params` (SmartCropParams) - Required. Specifies the parameters for the smart crop transformation.
```

--------------------------------

### FsCancelToken Constructor

Source: https://filestack.github.io/filestack-js/classes/FsCancelToken.html

Initializes a new instance of the FsCancelToken class.

```APIDOC
## Constructor

### new FsCancelToken()

Creates a new FsCancelToken instance.

#### Returns
* FsCancelToken - A new FsCancelToken object.
```

--------------------------------

### sfw

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Option to ensure the content is safe for work.

```APIDOC
## sfw

### Description
Option to ensure the content is safe for work.

### Parameters
#### Request Body
- (boolean) - If true, ensures the content is safe for work.
```

--------------------------------

### toString

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Returns the transform URL as a string.

```APIDOC
## toString

### Description
Returns transform url.

### Method Signature
`toString(): string`

### Returns
* `string` - The transform URL.
```

--------------------------------

### FsRequest Constructor

Source: https://filestack.github.io/filestack-js/classes/FsRequest.html

Creates an instance of FsRequest. The config parameter is optional.

```APIDOC
## constructor

### Description
Creates an instance of Request.

### Parameters
- **config** (FsRequestOptions) - Optional - Configuration options for the request.

### Returns
FsRequest
```

--------------------------------

### Image Transformation Options

Source: https://filestack.github.io/filestack-js/interfaces/TransformOptions.html

Options for transforming image assets. These include settings for aspect ratio, audio, clipping, container, filename, resolution, and more.

```APIDOC
## Image Transformation Options

### Description
Options for transforming image assets. These include settings for aspect ratio, audio, clipping, container, filename, resolution, and more.

### Parameters
#### General Options
- **access** (EVideoAccess) - Optional - Access level for the image.
- **aspect_mode** (EVideoAccessMode) - Aspect ratio mode.
- **audio_bitrate** (number) - Optional - Audio bitrate in kbps.
- **audio_channels** (number) - Optional - Number of audio channels.
- **audio_codec** (EAudioTypes) - Optional - Audio codec to use.
- **audio_sample_rate** (number) - Optional - Audio sample rate in Hz.
- **clip_length** (string) - Optional - Length of the image clip to extract (e.g., '10s').
- **clip_offset** (string) - Optional - Offset from the beginning of the image to start the clip (e.g., '5s').
- **container** (string) - Optional - The container format for the output image (e.g., 'jpg').
- **extname** (string) - Optional - The file extension for the output image.
- **filename** (string) - Optional - The desired filename for the output image.
- **force** (boolean) - Optional - Force transformation even if the file is not an image.
- **fps** (number) - Optional - Frames per second for the output image.
- **height** (number) - Optional - Height of the output image in pixels.
- **keyframe_interval** (number) - Optional - Keyframe interval in seconds.
- **location** (EVideoLocations) - Optional - Location for storing the transformed image.
- **path** (string) - Optional - Path for the transformed image.
- **preset** (EVideoTypes) - Optional - Preset for image transformation.
- **title** (string) - Optional - Title for the image.
- **two_pass** (boolean) - Optional - Enable two-pass encoding for better quality.
- **upscale** (boolean) - Required - Whether to upscale the image if the output resolution is larger than the input.
- **video_bitrate** (number) - Optional - Video bitrate in kbps.
- **watermark_bottom** (number) - Optional - Bottom padding for watermark.
- **watermark_height** (number) - Optional - Height of the watermark.
- **watermark_left** (number) - Optional - Left padding for watermark.
- **watermark_right** (number) - Optional - Right padding for watermark.
- **watermark_top** (number) - Optional - Top padding for watermark.
- **watermark_url** (string) - Optional - URL of the watermark image.
- **watermark_width** (number) - Optional - Width of the watermark.
- **width** (number) - Optional - Width of the output image in pixels.

### Vignette Options
- **vignette.amount** (number) - Optional - Amount of vignette effect.
- **vignette.background** (string) - Optional - Background color for the vignette.
- **vignette.blurmode** (EBlurMode) - Optional - Blur mode for the vignette.

### Watermark Options
- **watermark.files** (string) - Required - URL of the watermark file.
- **watermark.position** (EImageWatermarkPosition | EImageWatermarkPosition[]) - Optional - Position of the watermark.
- **watermark.size** (number) - Optional - Size of the watermark.
```

--------------------------------

### StoreBaseParams Properties

Source: https://filestack.github.io/filestack-js/interfaces/StoreBaseParams.html

This interface defines optional parameters that can be used when storing files.

```APIDOC
## Interface StoreBaseParams

### Properties

- **access** (string) - Optional - Specifies the access level for the stored file.
- **container** (string) - Optional - The name of the container where the file will be stored.
- **disableStorageKey** (boolean) - Optional - If true, disables the use of a storage key.
- **location** (string) - Optional - The location where the file will be stored.
- **path** (string) - Optional - The path within the container for the file.
- **region** (string) - Optional - The region for the storage location.
```

--------------------------------

### FsRequest.options

Source: https://filestack.github.io/filestack-js/classes/FsRequest.html

Dispatches an OPTIONS request to the specified URL. The config parameter is optional.

```APIDOC
## options

### Description
Dispatch OPTIONS request.

### Method
OPTIONS

### Endpoint
/{url}

### Parameters
- **url** (string) - Required - The URL to send the request to.
- **config** (FsRequestOptions) - Optional - Configuration options for the request.

### Returns
Promise<FsResponse>
```

--------------------------------

### store

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds store transformation to the file. Accepts a boolean or a StoreParams object.

```APIDOC
## store

### Description
Adds store transformation.

### Method Signature
`store(params?: boolean | StoreParams): Filelink`

### Parameters
* `params` (boolean | StoreParams) - Optional. Specifies the parameters for the store transformation.
```

--------------------------------

### VideoConvertParams Properties

Source: https://filestack.github.io/filestack-js/interfaces/VideoConvertParams.html

This section details the available properties for configuring video conversions using the VideoConvertParams interface. Properties marked with '?' are optional.

```APIDOC
## Interface VideoConvertParams

### Properties

*   **access?** (VideoAccess) - Optional access control for the converted video.
*   **aspect_mode** (VideoAccessMode) - Specifies the aspect mode for the video.
*   **audio_bitrate?** (number) - Optional audio bitrate in bits per second.
*   **audio_channels?** (number) - Optional number of audio channels.
*   **audio_codec?** (AudioTypes) - Optional audio codec to use.
*   **audio_sample_rate?** (number) - Optional audio sample rate in Hz.
*   **clip_length?** (string) - Optional duration to clip the video.
*   **clip_offset?** (string) - Optional starting point to clip the video.
*   **container?** (string) - Optional container format for the output video (e.g., 'mp4').
*   **extname?** (string) - Optional file extension for the output video.
*   **filename?** (string) - Optional filename for the converted video.
*   **force?** (boolean) - Optional flag to force conversion even if the file is already in the desired format.
*   **fps?** (number) - Optional frames per second for the output video.
*   **height?** (number) - Optional height of the output video in pixels.
*   **keyframe_interval?** (number) - Optional keyframe interval for video encoding.
*   **location?** (Locations) - Optional storage location for the converted video.
*   **path?** (string) - Optional path for the converted video.
*   **preset?** (VideoTypes) - Optional preset for video conversion quality and speed.
*   **title?** (string) - Optional title for the converted video.
*   **two_pass?** (boolean) - Optional flag to enable two-pass encoding for better quality.
*   **upscale** (boolean) - Required flag to enable or disable upscaling.
*   **video_bitrate?** (number) - Optional video bitrate in bits per second.
*   **watermark_bottom?** (number) - Optional distance from the bottom for the watermark.
*   **watermark_height?** (number) - Optional height of the watermark.
*   **watermark_left?** (number) - Optional distance from the left for the watermark.
*   **watermark_right?** (number) - Optional distance from the right for the watermark.
*   **watermark_top?** (number) - Optional distance from the top for the watermark.
*   **watermark_url?** (string) - Optional URL of the watermark image.
*   **watermark_width?** (number) - Optional width of the watermark.
*   **width?** (number) - Optional width of the output video in pixels.
```

--------------------------------

### flip

Source: https://filestack.github.io/filestack-js/classes/Filelink.html

Adds the flip transformation to the file. This transformation does not require any parameters.

```APIDOC
## flip

### Description
Adds flip transformation.

### Method
```javascript
flip(): Filelink
```
```

--------------------------------

### EVideoLocations Enumeration Members

Source: https://filestack.github.io/filestack-js/enums/EVideoLocations.html

This snippet details the available members of the EVideoLocations enumeration, representing different video storage providers.

```APIDOC
## Enumeration EVideoLocations

Video storage location

### Enumeration Members

- **azure**: "azure"
- **dropbox**: "dropbox"
- **gcs**: "gcs"
- **rackspace**: "rackspace"
- **s3**: "s3"
```
Tokens:
Raw