Classes
Class Client
The Filestack client, the entry point for all public methods. Encapsulates session information.
Example
// ES module
import * as filestack from 'filestack-js';
const client = filestack.init('apikey');
// UMD module in browser
<script src="https://static.filestackapi.com/filestack-js/3.x.x/filestack.min.js"></script>
const client = filestack.init('apikey');
Hierarchy
- EventEmitter
- Client
Defined in lib/client.ts:97
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
new Client(apikey: string, options?: ClientOptions): ClientParameters
- apikey: string
Optionaloptions: ClientOptions
Returns Client
Overrides EventEmitter.constructor
Defined in lib/client.ts:114
Accessors
utils
get utils(): __moduleReturns filestack utils
Memberof
Client
Returns __module
Defined in lib/client.ts:110
Methods
download
download(handle: string, security?: Security): Promise<FsResponse>Download file by handle
Browser Example
client.download('fileHandle').then((response) => {
const img = new Image();
img.src = URL.createObjectURL(res.data);
document.body.appendChild(img);
}).catch((err) => {
console.error(err);
})
See
Throws
Error
Parameters
- handle: string
Valid file handle Optionalsecurity: Security
Returns Promise<FsResponse>
Defined in lib/client.ts:373
logout
logout(name?: string): Promise<any>Clear all current cloud sessions in the picker. Optionally pass a cloud source name to only log out of that cloud source. This essentially clears the OAuth authorization codes from the Filestack session.
Parameters
Optionalname: string
Optional cloud source name.
Returns Promise<any>
Defined in lib/client.ts:187
metadata
metadata(handle: string, options?: MetadataOptions, security?: Security): Promise<any>Retrieve detailed data of stored files.
Example
client
.metadata('DCL5K46FS3OIxb5iuKby')
.then((res) => {
console.log(res);
})
.catch((err) => {
console.log(err);
});See
Parameters
- handle: string
Valid Filestack handle. Optionaloptions: MetadataOptions
Metadata fields to enable on response.Optionalsecurity: Security
Optional security override.
Returns Promise<any>
Defined in lib/client.ts:210
multiupload
multiupload(file: InputFile[], options?: UploadOptions, storeOptions?: StoreUploadOptions, token?: any, security?: Security): Promise<any>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.
Example
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)Returns
Parameters
- file: InputFile[]
Must be a valid [File | Blob | Buffer | string (base64)] Optionaloptions: UploadOptionsOptionalstoreOptions: StoreUploadOptions
Storage options.Optionaltoken: any
A control token that can be used to call cancel(), pause(), and resume().Optionalsecurity: Security
Optional security policy and signature override.
Returns Promise<any>
Defined in lib/client.ts:512
picker
picker(options?: PickerOptions): PickerInstanceConstruct a new picker instance.
Parameters
Optionaloptions: PickerOptions
Returns PickerInstance
Defined in lib/client.ts:217
prefetch
prefetch(params: PrefetchOptions): Promise<PrefetchResponse>Make basic prefetch request to check permissions
Parameters
- params: PrefetchOptions
Returns Promise<PrefetchResponse>
Defined in lib/client.ts:144
preview
preview(handle: string, options?: PreviewOptions): HTMLIFrameElement | WindowUsed 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.
Example
// <div id="preview"></div>
client.preview('DCL5K46FS3OIxb5iuKby', { id: 'preview' });Parameters
- handle: string
Valid Filestack handle. Optionaloptions: PreviewOptions
Preview options
Returns HTMLIFrameElement | Window
Defined in lib/client.ts:235
remove
remove(handle: string, security?: Security): Promise<any>Remove a file from storage and the Filestack system.
Requires a valid security policy and signature. The policy and signature will be pulled from the client session, or it can be overridden with the security parameter.
Example
client
.remove('DCL5K46FS3OIxb5iuKby')
.then((res) => {
console.log(res);
})
.catch((err) => {
console.log(err);
});See
Parameters
- handle: string
Valid Filestack handle. Optionalsecurity: Security
Optional security override.
Returns Promise<any>
Defined in lib/client.ts:260
removeMetadata
removeMetadata(handle: string, security?: Security): Promise<any>Remove a file only from the Filestack system. The file remains in storage.
Requires a valid security policy and signature. The policy and signature will be pulled from the client session, or it can be overridden with the security parameter.
Example
client
.removeMetadata('DCL5K46FS3OIxb5iuKby')
.then((res) => {
console.log(res);
})
.catch((err) => {
console.log(err);
});See
Parameters
- handle: string
Valid Filestack handle. Optionalsecurity: Security
Optional security override.
Returns Promise<any>
Defined in lib/client.ts:285
retrieve
retrieve(handle: string, options?: RetrieveOptions, security?: Security): Promise<Object | Blob>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
Example
client.retrieve('fileHandle', {
metadata: true,
}).then((response) => {
console.log(response);
}).catch((err) => {
console.error(err);
})See
Deprecated
use metadata or download methods instead
Throws
Error
Parameters
- handle: string
Valid file handle Optionaloptions: RetrieveOptions
RetrieveOptionsOptionalsecurity: Security
Optional security override.
Returns Promise<Object | Blob>
Defined in lib/client.ts:348
setCname
setCname(cname: string): voidSet custom cname
Returns
Memberof
Client
Parameters
- cname: string
Returns void
Defined in lib/client.ts:172
setSecurity
setSecurity(security: Security): voidSet security object
Memberof
Client
Parameters
- security: Security
Returns void
Defined in lib/client.ts:154
storeURL
storeURL(url: string, storeParams?: StoreParams, token?: any, security?: Security, uploadTags?: UploadTags, headers?: {
[key: string]: string;
}, workflowIds?: string[]): Promise<Object>Store a file from its URL.
Example
client
.storeURL('https://d1wtqaffaaj63z.cloudfront.net/images/NY_199_E_of_Hammertown_2014.jpg')
.then(res => console.log(res));See
Parameters
- url: string
Valid URL to a file. OptionalstoreParams: StoreParamsOptionaltoken: any
Optional control token to call .cancel()Optionalsecurity: Security
Optional security override.OptionaluploadTags: UploadTags
Optional tags visible in webhooks.Optionalheaders: {
[key: string]: string;
}
Optional headers to send- [key: string]: string
OptionalworkflowIds: string[]
Optional workflowIds to send
Returns Promise<Object>
Defined in lib/client.ts:308
transform
transform(url: string | string[], options: TransformOptions, b64?: boolean): stringInterface to the Filestack Processing API. Convert a URL, handle, or storage alias to another URL which links to the transformed file. You can optionally store the returned URL with client.storeURL.
Transform params can be provided in camelCase or snakeCase style ie: partial_pixelate or partialPixelate
Example
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));See
Returns
A new URL that points to the transformed resource.
Parameters
- url: string | string[]
Single or multiple valid URLs (http(s)://), file handles, or storage aliases (src://) to an image. - options: TransformOptions
Transformations are applied in the order specified by this object. - b64: boolean = false
Use new more safe format for generating transforms url (default=false) Note: If there will be any issues with url please test it with enabled b64 support
Returns string
Defined in lib/client.ts:411
upload
upload(file: InputFile, options?: UploadOptions, storeOptions?: StoreUploadOptions, token?: any, security?: Security): Promise<any>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.
Example
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
Parameters
- file: InputFile
Must be a valid [File | Blob | Buffer | string] Optionaloptions: UploadOptionsOptionalstoreOptions: StoreUploadOptions
Storage options.Optionaltoken: any
A control token that can be used to call cancel(), pause(), and resume().Optionalsecurity: Security
Optional security policy and signature override.
Returns Promise<any>
Defined in lib/client.ts:448
Class Filelink
Class for handling filelinks. For now its supports all filestack transforms. It outputs transform url or array of transforms
Example
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());Export
Hierarchy
- Filelink
Defined in lib/filelink.ts:543
Index
Constructors
Methods
PDFConvert
PDFInfo
URLScreenshot
addTask
animate
ascii
autoImage
blackwhite
blur
blurFaces
border
cache
circle
collage
compress
crop
cropFaces
detectFaces
enhance
fallback
flip
flop
getTasks
getTransformations
getValidationSchema
imagesize
minifyCss
minifyJs
modulate
monochrome
negative
noMetadata
oilPaint
output
partialBlur
partialPixelate
pixelate
pixelateFaces
pjpg
polaroid
quality
redeye
reset
resize
rotate
roundedCorners
security
sepia
setBase64
setCname
setCustomDomain
setSource
setUseValidator
sfw
shadow
sharpen
smartCrop
store
tags
toString
tornEdges
upscale
videoConvert
vignette
watermark
zip
PDFInfo
URLScreenshot
addTask
animate
ascii
autoImage
blackwhite
blur
blurFaces
border
cache
circle
collage
compress
crop
cropFaces
detectFaces
enhance
fallback
flip
flop
getTasks
getTransformations
getValidationSchema
imagesize
minifyCss
minifyJs
modulate
monochrome
negative
noMetadata
oilPaint
output
partialBlur
partialPixelate
pixelate
pixelateFaces
pjpg
polaroid
quality
redeye
reset
resize
rotate
roundedCorners
security
sepia
setBase64
setCname
setCustomDomain
setSource
setUseValidator
sfw
shadow
sharpen
smartCrop
store
tags
toString
tornEdges
upscale
videoConvert
vignette
watermark
zip
Constructors
constructor
new Filelink(source: string | string[], apikey?: string): FilelinkClass for generating tranformation urls
Memberof
Filelink
Parameters
- source: string | string[]
handle or multiple handles (i.e. for collage) Optionalapikey: string
your apikey – required for all external sources
Returns Filelink
Defined in lib/filelink.ts:619
Methods
PDFConvert
PDFConvert(params?: boolean | PdfConvertParams): FilelinkAdds pdfconvert transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | PdfConvertParams
Returns Filelink
Defined in lib/filelink.ts:1401
PDFInfo
PDFInfo(params?: boolean | PdfInfoParams): FilelinkAdds pdfinfo transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | PdfInfoParams
Returns Filelink
Defined in lib/filelink.ts:1389
URLScreenshot
URLScreenshot(params?: boolean | URLScreenshotParams): FilelinkAdds URLScreenshot transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | URLScreenshotParams
Returns Filelink
Defined in lib/filelink.ts:1377
addTask
addTask(name: string, params?: any): FilelinkAdd task and validate
Returns
Memberof
Filelink
Parameters
- name: string
Optionalparams: any
Returns Filelink
Defined in lib/filelink.ts:767
animate
animate(params: AnimationParams): FilelinkAdd animate transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: AnimationParams
Returns Filelink
Defined in lib/filelink.ts:981
ascii
ascii(params?: boolean | AsciiParams): FilelinkAdds ascii transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | AsciiParams
Returns Filelink
Defined in lib/filelink.ts:1317
autoImage
autoImage(): FilelinkAdd autoimage transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:815
blackwhite
blackwhite(params?: boolean | BlackwhiteParams): FilelinkAdds blackwhite transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | BlackwhiteParams
Returns Filelink
Defined in lib/filelink.ts:1209
blur
blur(params?: boolean | BlurParams): FilelinkAdds blur transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | BlurParams
Returns Filelink
Defined in lib/filelink.ts:1197
blurFaces
blurFaces(params: BlurFacesParams): FilelinkAdds blur faces transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: BlurFacesParams
Returns Filelink
Defined in lib/filelink.ts:1089
border
border(params?: boolean | BorderParams): FilelinkAdds border transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | BorderParams
Returns Filelink
Defined in lib/filelink.ts:1173
cache
cache(params: boolean | CacheParams): FilelinkAdds cache transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: boolean | CacheParams
Returns Filelink
Defined in lib/filelink.ts:1005
circle
circle(params?: boolean | CircleParams): FilelinkAdds circle transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | CircleParams
Returns Filelink
Defined in lib/filelink.ts:1161
collage
collage(params: CollageParams): FilelinkAdds collage transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: CollageParams
Returns Filelink
Defined in lib/filelink.ts:1293
compress
compress(params?: CompressParams): FilelinkAdd compress transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: CompressParams
Returns Filelink
Defined in lib/filelink.ts:936
crop
crop(params: CropParams): FilelinkAdds crop transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: CropParams
Returns Filelink
Defined in lib/filelink.ts:1029
cropFaces
cropFaces(params: CropFacesParams): FilelinkAdds crop faces transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: CropFacesParams
Returns Filelink
Defined in lib/filelink.ts:1065
detectFaces
detectFaces(params?: boolean | DetectFacesParams): FilelinkAdds detect_faces transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | DetectFacesParams
Returns Filelink
Defined in lib/filelink.ts:1053
enhance
enhance(params?: EnhanceParams): FilelinkAdds enhance transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: EnhanceParams
Returns Filelink
Defined in lib/filelink.ts:903
fallback
fallback(params: FallbackParams): FilelinkAdds fallback transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: FallbackParams
Returns Filelink
Defined in lib/filelink.ts:1413
flip
flip(): FilelinkAdds flip transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:826
flop
flop(): FilelinkAdds flop transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:837
getTasks
getTasks(): any[]Returns all tasks added for transformation
Memberof
Filelink
Returns any[]
Defined in lib/filelink.ts:789
getTransformations
getTransformations(): any[]Returns transformations in JSON format
Returns
Memberof
Filelink
Returns any[]
Defined in lib/filelink.ts:704
getValidationSchema
getValidationSchema(): {
$schema: string;
additionalProperties: boolean;
description: string;
properties: {
animate: {
properties: {
align: {
$ref: string;
default: string;
};
background: {
$ref: string;
default: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
loop: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
ascii: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
colored: {
default: boolean;
type: string;
};
foreground: {
$ref: string;
default: string;
};
reverse: {
default: boolean;
type: string;
};
size: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
auto_image: {
additionalProperties: boolean;
type: string;
};
blackwhite: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
threshold: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
border: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
cache: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
expiry: {
type: string;
};
};
type: string;
})[];
};
circle: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
};
type: string;
})[];
};
collage: {
additionalProperties: boolean;
properties: {
autorotate: {
default: boolean;
type: string;
};
color: {
$ref: string;
default: string;
};
files: {
items: {
type: string;
}[];
minItems: number;
type: string;
};
fit: {
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
margin: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
compress: {
additionalProperties: boolean;
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
metadata: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
crop: {
properties: {
dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
required: string[];
type: string;
};
crop_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: number;
};
height: {
maximum: number;
minimum: number;
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
detect_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
color: {
$ref: string;
default: string;
};
export: {
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
enhance: {
default: boolean;
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
preset: {
enum: string[];
type: string;
};
};
type: string;
})[];
};
fallback: {
additionalProperties: boolean;
properties: {
cache: {
maximum: number;
minimum: number;
type: string;
};
handle: {
type: string;
};
};
required: string[];
type: string;
};
flip: {
additionalProperties: boolean;
type: string;
};
flop: {
additionalProperties: boolean;
type: string;
};
imagesize: {
additionalProperties: boolean;
type: string;
};
metadata: {
additionalProperties: boolean;
params: {
additionalItems: boolean;
items: {
enum: string[];
type: string;
};
minItems: number;
type: string;
uniqueItems: boolean;
};
type: string;
};
minify_css: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
level: {
enum: number[];
type: string;
};
};
type: string;
};
minify_js: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
keep_class_name: {
type: string;
};
keep_fn_name: {
type: string;
};
mangle: {
type: string;
};
merge_vars: {
type: string;
};
remove_console: {
type: string;
};
remove_undefined: {
type: string;
};
targets: {
type: string;
};
use_babel_polyfill: {
type: string;
};
};
type: string;
};
modulate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
brightness: {
default: number;
maximum: number;
minimum: number;
type: string;
};
hue: {
default: number;
maximum: number;
minimum: number;
type: string;
};
saturation: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
monochrome: {
additionalProperties: boolean;
type: string;
};
negative: {
additionalProperties: boolean;
type: string;
};
no_metadata: {
additionalProperties: boolean;
type: string;
};
oil_paint: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
output: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
colorspace: {
default: string;
enum: string[];
type: string;
};
compress: {
type: string;
};
density: {
maximum: number;
minimum: number;
type: string;
};
docinfo: {
default: boolean;
type: string;
};
format: {
enum: string[];
type: string;
};
page: {
maximum: number;
minimum: number;
type: string;
};
pageformat: {
enum: string[];
type: string;
};
pageorientation: {
enum: string[];
type: string;
};
quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
secure: {
default: boolean;
type: string;
};
strip: {
default: boolean;
type: string;
};
};
type: string;
};
partial_blur: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
partial_pixelate: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
pdfconvert: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
pageformat: {
$ref: string;
};
pageorientation: {
enum: string[];
type: string;
};
pages: {
$ref: string;
};
};
type: string;
};
pdfinfo: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
colorinfo: {
type: string;
};
};
type: string;
})[];
};
pixelate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
pixelate_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
pjpg: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
metadata: {
default: boolean;
type: string;
};
quality: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
polaroid: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
default: string;
};
rotate: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
quality: {
additionalProperties: boolean;
properties: {
value: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
redeye: {
additionalProperties: boolean;
type: string;
};
resize: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
align: {
$ref: string;
default: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
rotate: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
exif: {
type: string;
};
};
type: string;
};
rounded_corners: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
radius: {
oneOf: ({
enum?: undefined;
maximum: number;
minimum: number;
type: string;
} | {
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
})[];
};
};
type: string;
})[];
};
security: {
additionalProperties: boolean;
properties: {
policy: {
type: string;
};
signature: {
type: string;
};
};
required: string[];
type: string;
};
sepia: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
tone: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
sfw: {
additionalProperties: boolean;
type: string;
};
shadow: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
color: {
$ref: string;
};
opacity: {
default: number;
maximum: number;
minimum: number;
type: string;
};
vector: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
sharpen: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
smart_crop: {
height: {
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
store: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
base64decode: {
type: string;
};
container: {
type: string;
};
filename: {
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
region: {
$ref: string;
};
workflows: {
$ref: string;
};
};
type: string;
})[];
};
tags: {
additionalProperties: boolean;
type: string;
};
torn_edges: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
spread: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
upscale: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
noise: {
default: string;
enum: string[];
type: string;
};
style: {
default: string;
enum: string[];
type: string;
};
upscale: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
urlscreenshot: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
agent: {
default: string;
enum: string[];
type: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
device: {
default: string;
type: string;
};
height: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
orientation: {
default: string;
enum: string[];
type: string;
};
width: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
video_convert: {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
aspect_mode: {
default: string;
enum: string[];
type: string;
};
audio_bitrate: {
maximum: number;
minimum: number;
type: string;
};
audio_channels: {
maximum: number;
minimum: number;
type: string;
};
audio_codec: {
type: string;
};
audio_sample_rate: {
maximum: number;
minimum: number;
type: string;
};
clip_length: {
pattern: string;
type: string;
};
clip_offset: {
pattern: string;
type: string;
};
container: {
type: string;
};
extname: {
type: string;
};
filename: {
type: string;
};
force: {
type: string;
};
fps: {
maximum: number;
minimum: number;
type: string;
};
frame_count: {
default: number;
maximum: number;
minimum: number;
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
keyframe_interval: {
maximum: number;
minimum: number;
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
preset: {
type: string;
};
title: {
type: string;
};
two_pass: {
type: string;
};
upscale: {
type: string;
};
video_bitrate: {
maximum: number;
minimum: number;
type: string;
};
watermark_bottom: {
maximum: number;
minimum: number;
type: string;
};
watermark_left: {
maximum: number;
minimum: number;
type: string;
};
watermark_right: {
maximum: number;
minimum: number;
type: string;
};
watermark_top: {
maximum: number;
minimum: number;
type: string;
};
watermark_url: {
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
vignette: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
background: {
$ref: string;
};
blurmode: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
watermark: {
additionalProperties: boolean;
properties: {
file: {
type: string;
};
position: {
$ref: string;
};
size: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
zip: {
type: string;
};
};
title: string;
type: string;
}Returns JSONSchema form transformations params
Returns
Memberof
Filelink
Returns {
$schema: string;
additionalProperties: boolean;
description: string;
properties: {
animate: {
properties: {
align: {
$ref: string;
default: string;
};
background: {
$ref: string;
default: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
loop: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
ascii: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
colored: {
default: boolean;
type: string;
};
foreground: {
$ref: string;
default: string;
};
reverse: {
default: boolean;
type: string;
};
size: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
auto_image: {
additionalProperties: boolean;
type: string;
};
blackwhite: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
threshold: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
border: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
cache: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
expiry: {
type: string;
};
};
type: string;
})[];
};
circle: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
};
type: string;
})[];
};
collage: {
additionalProperties: boolean;
properties: {
autorotate: {
default: boolean;
type: string;
};
color: {
$ref: string;
default: string;
};
files: {
items: {
type: string;
}[];
minItems: number;
type: string;
};
fit: {
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
margin: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
compress: {
additionalProperties: boolean;
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
metadata: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
crop: {
properties: {
dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
required: string[];
type: string;
};
crop_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: number;
};
height: {
maximum: number;
minimum: number;
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
detect_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
color: {
$ref: string;
default: string;
};
export: {
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
enhance: {
default: boolean;
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
preset: {
enum: string[];
type: string;
};
};
type: string;
})[];
};
fallback: {
additionalProperties: boolean;
properties: {
cache: {
maximum: number;
minimum: number;
type: string;
};
handle: {
type: string;
};
};
required: string[];
type: string;
};
flip: {
additionalProperties: boolean;
type: string;
};
flop: {
additionalProperties: boolean;
type: string;
};
imagesize: {
additionalProperties: boolean;
type: string;
};
metadata: {
additionalProperties: boolean;
params: {
additionalItems: boolean;
items: {
enum: string[];
type: string;
};
minItems: number;
type: string;
uniqueItems: boolean;
};
type: string;
};
minify_css: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
level: {
enum: number[];
type: string;
};
};
type: string;
};
minify_js: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
keep_class_name: {
type: string;
};
keep_fn_name: {
type: string;
};
mangle: {
type: string;
};
merge_vars: {
type: string;
};
remove_console: {
type: string;
};
remove_undefined: {
type: string;
};
targets: {
type: string;
};
use_babel_polyfill: {
type: string;
};
};
type: string;
};
modulate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
brightness: {
default: number;
maximum: number;
minimum: number;
type: string;
};
hue: {
default: number;
maximum: number;
minimum: number;
type: string;
};
saturation: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
monochrome: {
additionalProperties: boolean;
type: string;
};
negative: {
additionalProperties: boolean;
type: string;
};
no_metadata: {
additionalProperties: boolean;
type: string;
};
oil_paint: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
output: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
colorspace: {
default: string;
enum: string[];
type: string;
};
compress: {
type: string;
};
density: {
maximum: number;
minimum: number;
type: string;
};
docinfo: {
default: boolean;
type: string;
};
format: {
enum: string[];
type: string;
};
page: {
maximum: number;
minimum: number;
type: string;
};
pageformat: {
enum: string[];
type: string;
};
pageorientation: {
enum: string[];
type: string;
};
quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
secure: {
default: boolean;
type: string;
};
strip: {
default: boolean;
type: string;
};
};
type: string;
};
partial_blur: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
partial_pixelate: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
pdfconvert: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
pageformat: {
$ref: string;
};
pageorientation: {
enum: string[];
type: string;
};
pages: {
$ref: string;
};
};
type: string;
};
pdfinfo: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
colorinfo: {
type: string;
};
};
type: string;
})[];
};
pixelate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
pixelate_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
pjpg: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
metadata: {
default: boolean;
type: string;
};
quality: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
polaroid: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
default: string;
};
rotate: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
quality: {
additionalProperties: boolean;
properties: {
value: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
redeye: {
additionalProperties: boolean;
type: string;
};
resize: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
align: {
$ref: string;
default: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
rotate: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
exif: {
type: string;
};
};
type: string;
};
rounded_corners: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
radius: {
oneOf: ({
enum?: undefined;
maximum: number;
minimum: number;
type: string;
} | {
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
})[];
};
};
type: string;
})[];
};
security: {
additionalProperties: boolean;
properties: {
policy: {
type: string;
};
signature: {
type: string;
};
};
required: string[];
type: string;
};
sepia: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
tone: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
sfw: {
additionalProperties: boolean;
type: string;
};
shadow: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
color: {
$ref: string;
};
opacity: {
default: number;
maximum: number;
minimum: number;
type: string;
};
vector: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
sharpen: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
smart_crop: {
height: {
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
store: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
base64decode: {
type: string;
};
container: {
type: string;
};
filename: {
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
region: {
$ref: string;
};
workflows: {
$ref: string;
};
};
type: string;
})[];
};
tags: {
additionalProperties: boolean;
type: string;
};
torn_edges: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
spread: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
upscale: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
noise: {
default: string;
enum: string[];
type: string;
};
style: {
default: string;
enum: string[];
type: string;
};
upscale: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
urlscreenshot: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
agent: {
default: string;
enum: string[];
type: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
device: {
default: string;
type: string;
};
height: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
orientation: {
default: string;
enum: string[];
type: string;
};
width: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
video_convert: {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
aspect_mode: {
default: string;
enum: string[];
type: string;
};
audio_bitrate: {
maximum: number;
minimum: number;
type: string;
};
audio_channels: {
maximum: number;
minimum: number;
type: string;
};
audio_codec: {
type: string;
};
audio_sample_rate: {
maximum: number;
minimum: number;
type: string;
};
clip_length: {
pattern: string;
type: string;
};
clip_offset: {
pattern: string;
type: string;
};
container: {
type: string;
};
extname: {
type: string;
};
filename: {
type: string;
};
force: {
type: string;
};
fps: {
maximum: number;
minimum: number;
type: string;
};
frame_count: {
default: number;
maximum: number;
minimum: number;
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
keyframe_interval: {
maximum: number;
minimum: number;
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
preset: {
type: string;
};
title: {
type: string;
};
two_pass: {
type: string;
};
upscale: {
type: string;
};
video_bitrate: {
maximum: number;
minimum: number;
type: string;
};
watermark_bottom: {
maximum: number;
minimum: number;
type: string;
};
watermark_left: {
maximum: number;
minimum: number;
type: string;
};
watermark_right: {
maximum: number;
minimum: number;
type: string;
};
watermark_top: {
maximum: number;
minimum: number;
type: string;
};
watermark_url: {
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
vignette: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
background: {
$ref: string;
};
blurmode: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
watermark: {
additionalProperties: boolean;
properties: {
file: {
type: string;
};
position: {
$ref: string;
};
size: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
zip: {
type: string;
};
};
title: string;
type: string;
}
- $schema: string
- additionalProperties: boolean
- description: string
- properties: {
animate: {
properties: {
align: {
$ref: string;
default: string;
};
background: {
$ref: string;
default: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
loop: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
ascii: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
colored: {
default: boolean;
type: string;
};
foreground: {
$ref: string;
default: string;
};
reverse: {
default: boolean;
type: string;
};
size: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
auto_image: {
additionalProperties: boolean;
type: string;
};
blackwhite: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
threshold: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
blur_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
border: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
cache: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
expiry: {
type: string;
};
};
type: string;
})[];
};
circle: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
};
type: string;
})[];
};
collage: {
additionalProperties: boolean;
properties: {
autorotate: {
default: boolean;
type: string;
};
color: {
$ref: string;
default: string;
};
files: {
items: {
type: string;
}[];
minItems: number;
type: string;
};
fit: {
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
margin: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
compress: {
additionalProperties: boolean;
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
metadata: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
crop: {
properties: {
dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
required: string[];
type: string;
};
crop_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: number;
};
height: {
maximum: number;
minimum: number;
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
detect_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
color: {
$ref: string;
default: string;
};
export: {
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
enhance: {
default: boolean;
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
preset: {
enum: string[];
type: string;
};
};
type: string;
})[];
};
fallback: {
additionalProperties: boolean;
properties: {
cache: {
maximum: number;
minimum: number;
type: string;
};
handle: {
type: string;
};
};
required: string[];
type: string;
};
flip: {
additionalProperties: boolean;
type: string;
};
flop: {
additionalProperties: boolean;
type: string;
};
imagesize: {
additionalProperties: boolean;
type: string;
};
metadata: {
additionalProperties: boolean;
params: {
additionalItems: boolean;
items: {
enum: string[];
type: string;
};
minItems: number;
type: string;
uniqueItems: boolean;
};
type: string;
};
minify_css: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
level: {
enum: number[];
type: string;
};
};
type: string;
};
minify_js: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
keep_class_name: {
type: string;
};
keep_fn_name: {
type: string;
};
mangle: {
type: string;
};
merge_vars: {
type: string;
};
remove_console: {
type: string;
};
remove_undefined: {
type: string;
};
targets: {
type: string;
};
use_babel_polyfill: {
type: string;
};
};
type: string;
};
modulate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
brightness: {
default: number;
maximum: number;
minimum: number;
type: string;
};
hue: {
default: number;
maximum: number;
minimum: number;
type: string;
};
saturation: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
monochrome: {
additionalProperties: boolean;
type: string;
};
negative: {
additionalProperties: boolean;
type: string;
};
no_metadata: {
additionalProperties: boolean;
type: string;
};
oil_paint: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
output: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
colorspace: {
default: string;
enum: string[];
type: string;
};
compress: {
type: string;
};
density: {
maximum: number;
minimum: number;
type: string;
};
docinfo: {
default: boolean;
type: string;
};
format: {
enum: string[];
type: string;
};
page: {
maximum: number;
minimum: number;
type: string;
};
pageformat: {
enum: string[];
type: string;
};
pageorientation: {
enum: string[];
type: string;
};
quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
secure: {
default: boolean;
type: string;
};
strip: {
default: boolean;
type: string;
};
};
type: string;
};
partial_blur: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
partial_pixelate: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
};
pdfconvert: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
pageformat: {
$ref: string;
};
pageorientation: {
enum: string[];
type: string;
};
pages: {
$ref: string;
};
};
type: string;
};
pdfinfo: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
colorinfo: {
type: string;
};
};
type: string;
})[];
};
pixelate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
pixelate_faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
pjpg: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
metadata: {
default: boolean;
type: string;
};
quality: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
polaroid: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
default: string;
};
rotate: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
quality: {
additionalProperties: boolean;
properties: {
value: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
redeye: {
additionalProperties: boolean;
type: string;
};
resize: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
align: {
$ref: string;
default: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
rotate: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
exif: {
type: string;
};
};
type: string;
};
rounded_corners: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
radius: {
oneOf: ({
enum?: undefined;
maximum: number;
minimum: number;
type: string;
} | {
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
})[];
};
};
type: string;
})[];
};
security: {
additionalProperties: boolean;
properties: {
policy: {
type: string;
};
signature: {
type: string;
};
};
required: string[];
type: string;
};
sepia: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
tone: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
sfw: {
additionalProperties: boolean;
type: string;
};
shadow: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
color: {
$ref: string;
};
opacity: {
default: number;
maximum: number;
minimum: number;
type: string;
};
vector: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
sharpen: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
smart_crop: {
height: {
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
store: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
base64decode: {
type: string;
};
container: {
type: string;
};
filename: {
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
region: {
$ref: string;
};
workflows: {
$ref: string;
};
};
type: string;
})[];
};
tags: {
additionalProperties: boolean;
type: string;
};
torn_edges: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
spread: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
};
upscale: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
noise: {
default: string;
enum: string[];
type: string;
};
style: {
default: string;
enum: string[];
type: string;
};
upscale: {
default: boolean;
type: string;
};
};
type: string;
})[];
};
urlscreenshot: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
agent: {
default: string;
enum: string[];
type: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
device: {
default: string;
type: string;
};
height: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
orientation: {
default: string;
enum: string[];
type: string;
};
width: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
};
video_convert: {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
aspect_mode: {
default: string;
enum: string[];
type: string;
};
audio_bitrate: {
maximum: number;
minimum: number;
type: string;
};
audio_channels: {
maximum: number;
minimum: number;
type: string;
};
audio_codec: {
type: string;
};
audio_sample_rate: {
maximum: number;
minimum: number;
type: string;
};
clip_length: {
pattern: string;
type: string;
};
clip_offset: {
pattern: string;
type: string;
};
container: {
type: string;
};
extname: {
type: string;
};
filename: {
type: string;
};
force: {
type: string;
};
fps: {
maximum: number;
minimum: number;
type: string;
};
frame_count: {
default: number;
maximum: number;
minimum: number;
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
keyframe_interval: {
maximum: number;
minimum: number;
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
preset: {
type: string;
};
title: {
type: string;
};
two_pass: {
type: string;
};
upscale: {
type: string;
};
video_bitrate: {
maximum: number;
minimum: number;
type: string;
};
watermark_bottom: {
maximum: number;
minimum: number;
type: string;
};
watermark_left: {
maximum: number;
minimum: number;
type: string;
};
watermark_right: {
maximum: number;
minimum: number;
type: string;
};
watermark_top: {
maximum: number;
minimum: number;
type: string;
};
watermark_url: {
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
};
vignette: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
background: {
$ref: string;
};
blurmode: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
};
watermark: {
additionalProperties: boolean;
properties: {
file: {
type: string;
};
position: {
$ref: string;
};
size: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
};
zip: {
type: string;
};
}- animate: {
properties: {
align: {
$ref: string;
default: string;
};
background: {
$ref: string;
default: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
loop: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
}- properties: {
align: {
$ref: string;
default: string;
};
background: {
$ref: string;
default: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
loop: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
}- align: {
$ref: string;
default: string;
}- $ref: string
- default: string
- background: {
$ref: string;
default: string;
}- $ref: string
- default: string
- delay: {
default: number;
maximum: number;
minimum: number;
type: string;
}- default: number
- maximum: number
- minimum: number
- type: string
- fit: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- height: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- loop: {
default: number;
maximum: number;
minimum: number;
type: string;
}- default: number
- maximum: number
- minimum: number
- type: string
- width: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- align: {
- type: string
- properties: {
- ascii: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
colored: {
default: boolean;
type: string;
};
foreground: {
$ref: string;
default: string;
};
reverse: {
default: boolean;
type: string;
};
size: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
colored: {
default: boolean;
type: string;
};
foreground: {
$ref: string;
default: string;
};
reverse: {
default: boolean;
type: string;
};
size: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- auto_
image: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- blackwhite: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
threshold: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
threshold: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- blur: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- blur_
faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[]
- one
- border: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- cache: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
expiry: {
type: string;
};
};
type: string;
})[];
}- one
Of: ({
properties?: undefined;
type: string;
} | {
properties: {
expiry: {
type: string;
};
};
type: string;
})[]
- one
- circle: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
};
type: string;
})[]
- one
- collage: {
additionalProperties: boolean;
properties: {
autorotate: {
default: boolean;
type: string;
};
color: {
$ref: string;
default: string;
};
files: {
items: {
type: string;
}[];
minItems: number;
type: string;
};
fit: {
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
margin: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
}- additional
Properties: boolean - properties: {
autorotate: {
default: boolean;
type: string;
};
color: {
$ref: string;
default: string;
};
files: {
items: {
type: string;
}[];
minItems: number;
type: string;
};
fit: {
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
margin: {
default: number;
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
}- autorotate: {
default: boolean;
type: string;
}- default: boolean
- type: string
- color: {
$ref: string;
default: string;
}- $ref: string
- default: string
- files: {
items: {
type: string;
}[];
minItems: number;
type: string;
}- items: {
type: string;
}[] - min
Items: number - type: string
- items: {
- fit: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- height: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- margin: {
default: number;
maximum: number;
minimum: number;
type: string;
}- default: number
- maximum: number
- minimum: number
- type: string
- width: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- autorotate: {
- required: string[]
- type: string
- additional
- compress: {
additionalProperties: boolean;
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
metadata: {
default: boolean;
type: string;
};
};
type: string;
})[];
}- additional
Properties: boolean - one
Of: ({
properties?: undefined;
type: string;
} | {
properties: {
metadata: {
default: boolean;
type: string;
};
};
type: string;
})[]
- additional
- crop: {
properties: {
dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
required: string[];
type: string;
}- properties: {
dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
}- dim: {
additionalItems: boolean;
items: {
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
}- additional
Items: boolean - items: {
maximum: number;
minimum: number;
type: string;
}[] - min
Items: number - type: string
- additional
- dim: {
- required: string[]
- type: string
- properties: {
- crop_
faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: number;
};
height: {
maximum: number;
minimum: number;
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: number;
};
height: {
maximum: number;
minimum: number;
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- detect_
faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
color: {
$ref: string;
default: string;
};
export: {
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
color: {
$ref: string;
default: string;
};
export: {
type: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- enhance: {
default: boolean;
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
preset: {
enum: string[];
type: string;
};
};
type: string;
})[];
}- default: boolean
- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
preset: {
enum: string[];
type: string;
};
};
type: string;
})[]
- fallback: {
additionalProperties: boolean;
properties: {
cache: {
maximum: number;
minimum: number;
type: string;
};
handle: {
type: string;
};
};
required: string[];
type: string;
}- additional
Properties: boolean - properties: {
cache: {
maximum: number;
minimum: number;
type: string;
};
handle: {
type: string;
};
}- cache: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- handle: {
type: string;
}- type: string
- cache: {
- required: string[]
- type: string
- additional
- flip: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- flop: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- imagesize: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- metadata: {
additionalProperties: boolean;
params: {
additionalItems: boolean;
items: {
enum: string[];
type: string;
};
minItems: number;
type: string;
uniqueItems: boolean;
};
type: string;
}- additional
Properties: boolean - params: {
additionalItems: boolean;
items: {
enum: string[];
type: string;
};
minItems: number;
type: string;
uniqueItems: boolean;
}- additional
Items: boolean - items: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- min
Items: number - type: string
- unique
Items: boolean
- additional
- type: string
- additional
- minify_
css: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
level: {
enum: number[];
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
gzip: {
type: string;
};
level: {
enum: number[];
type: string;
};
}- gzip: {
type: string;
}- type: string
- level: {
enum: number[];
type: string;
}- enum: number[]
- type: string
- gzip: {
- type: string
- additional
- minify_
js: {
additionalProperties: boolean;
properties: {
gzip: {
type: string;
};
keep_class_name: {
type: string;
};
keep_fn_name: {
type: string;
};
mangle: {
type: string;
};
merge_vars: {
type: string;
};
remove_console: {
type: string;
};
remove_undefined: {
type: string;
};
targets: {
type: string;
};
use_babel_polyfill: {
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
gzip: {
type: string;
};
keep_class_name: {
type: string;
};
keep_fn_name: {
type: string;
};
mangle: {
type: string;
};
merge_vars: {
type: string;
};
remove_console: {
type: string;
};
remove_undefined: {
type: string;
};
targets: {
type: string;
};
use_babel_polyfill: {
type: string;
};
}- gzip: {
type: string;
}- type: string
- keep_
class_ name: {
type: string;
}- type: string
- keep_
fn_ name: {
type: string;
}- type: string
- mangle: {
type: string;
}- type: string
- merge_
vars: {
type: string;
}- type: string
- remove_
console: {
type: string;
}- type: string
- remove_
undefined: {
type: string;
}- type: string
- targets: {
type: string;
}- type: string
- use_
babel_ polyfill: {
type: string;
}- type: string
- gzip: {
- type: string
- additional
- modulate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
brightness: {
default: number;
maximum: number;
minimum: number;
type: string;
};
hue: {
default: number;
maximum: number;
minimum: number;
type: string;
};
saturation: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
brightness: {
default: number;
maximum: number;
minimum: number;
type: string;
};
hue: {
default: number;
maximum: number;
minimum: number;
type: string;
};
saturation: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- monochrome: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- negative: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- no_
metadata: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- oil_
paint: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- output: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
colorspace: {
default: string;
enum: string[];
type: string;
};
compress: {
type: string;
};
density: {
maximum: number;
minimum: number;
type: string;
};
docinfo: {
default: boolean;
type: string;
};
format: {
enum: string[];
type: string;
};
page: {
maximum: number;
minimum: number;
type: string;
};
pageformat: {
enum: string[];
type: string;
};
pageorientation: {
enum: string[];
type: string;
};
quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
secure: {
default: boolean;
type: string;
};
strip: {
default: boolean;
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
background: {
$ref: string;
};
colorspace: {
default: string;
enum: string[];
type: string;
};
compress: {
type: string;
};
density: {
maximum: number;
minimum: number;
type: string;
};
docinfo: {
default: boolean;
type: string;
};
format: {
enum: string[];
type: string;
};
page: {
maximum: number;
minimum: number;
type: string;
};
pageformat: {
enum: string[];
type: string;
};
pageorientation: {
enum: string[];
type: string;
};
quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
secure: {
default: boolean;
type: string;
};
strip: {
default: boolean;
type: string;
};
}- background: {
$ref: string;
}- $ref: string
- colorspace: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- compress: {
type: string;
}- type: string
- density: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- docinfo: {
default: boolean;
type: string;
}- default: boolean
- type: string
- format: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- page: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- pageformat: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- pageorientation: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- quality: {
oneOf: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
}- one
Of: ({
default?: undefined;
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
default: number;
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[]
- one
- secure: {
default: boolean;
type: string;
}- default: boolean
- type: string
- strip: {
default: boolean;
type: string;
}- default: boolean
- type: string
- background: {
- type: string
- additional
- partial_
blur: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
}- properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
}- amount: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- blur: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- objects: {
$ref: string;
}- $ref: string
- type: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- amount: {
- required: string[]
- type: string
- properties: {
- partial_
pixelate: {
properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
};
required: string[];
type: string;
}- properties: {
amount: {
maximum: number;
minimum: number;
type: string;
};
blur: {
maximum: number;
minimum: number;
type: string;
};
objects: {
$ref: string;
};
type: {
enum: string[];
type: string;
};
}- amount: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- blur: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- objects: {
$ref: string;
}- $ref: string
- type: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- amount: {
- required: string[]
- type: string
- properties: {
- pdfconvert: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
pageformat: {
$ref: string;
};
pageorientation: {
enum: string[];
type: string;
};
pages: {
$ref: string;
};
};
type: string;
}- additional
Properties: boolean - any
Of: {
required: string[];
}[] - properties: {
pageformat: {
$ref: string;
};
pageorientation: {
enum: string[];
type: string;
};
pages: {
$ref: string;
};
}- pageformat: {
$ref: string;
}- $ref: string
- pageorientation: {
enum: string[];
type: string;
}- enum: string[]
- type: string
- pages: {
$ref: string;
}- $ref: string
- pageformat: {
- type: string
- additional
- pdfinfo: {
oneOf: ({
properties?: undefined;
type: string;
} | {
properties: {
colorinfo: {
type: string;
};
};
type: string;
})[];
}- one
Of: ({
properties?: undefined;
type: string;
} | {
properties: {
colorinfo: {
type: string;
};
};
type: string;
})[]
- one
- pixelate: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- pixelate_
faces: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
buffer: {
maximum: number;
minimum: number;
type: string;
};
faces: {
$ref: string;
default: string;
};
maxsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
minsize: {
default: number;
maximum: number;
minimum: number;
type: string;
};
type: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[]
- one
- pjpg: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
metadata: {
default: boolean;
type: string;
};
quality: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
metadata: {
default: boolean;
type: string;
};
quality: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- polaroid: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
default: string;
};
rotate: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
color: {
$ref: string;
default: string;
};
rotate: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- quality: {
additionalProperties: boolean;
properties: {
value: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
value: {
maximum: number;
minimum: number;
type: string;
};
}- value: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- value: {
- type: string
- additional
- redeye: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- resize: {
additionalProperties: boolean;
anyOf: {
required: string[];
}[];
properties: {
align: {
$ref: string;
default: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
}- additional
Properties: boolean - any
Of: {
required: string[];
}[] - properties: {
align: {
$ref: string;
default: string;
};
fit: {
default: string;
enum: string[];
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
}- align: {
$ref: string;
default: string;
}- $ref: string
- default: string
- fit: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- height: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- width: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- align: {
- type: string
- additional
- rotate: {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
default: string;
};
deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
exif: {
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
background: {
$ref: string;
default: string;
};
deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
};
exif: {
type: string;
};
}- background: {
$ref: string;
default: string;
}- $ref: string
- default: string
- deg: {
oneOf: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[];
}- one
Of: ({
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
} | {
enum?: undefined;
maximum: number;
minimum: number;
type: string;
})[]
- one
- exif: {
type: string;
}- type: string
- background: {
- type: string
- additional
- rounded_
corners: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
radius: {
oneOf: ({
enum?: undefined;
maximum: number;
minimum: number;
type: string;
} | {
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
})[];
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
radius: {
oneOf: ({
enum?: undefined;
maximum: number;
minimum: number;
type: string;
} | {
enum: string[];
maximum?: undefined;
minimum?: undefined;
type: string;
})[];
};
};
type: string;
})[]
- one
- security: {
additionalProperties: boolean;
properties: {
policy: {
type: string;
};
signature: {
type: string;
};
};
required: string[];
type: string;
}- additional
Properties: boolean - properties: {
policy: {
type: string;
};
signature: {
type: string;
};
}- policy: {
type: string;
}- type: string
- signature: {
type: string;
}- type: string
- policy: {
- required: string[]
- type: string
- additional
- sepia: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
tone: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
tone: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- sfw: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- shadow: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
color: {
$ref: string;
};
opacity: {
default: number;
maximum: number;
minimum: number;
type: string;
};
vector: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
blur: {
default: number;
maximum: number;
minimum: number;
type: string;
};
color: {
$ref: string;
};
opacity: {
default: number;
maximum: number;
minimum: number;
type: string;
};
vector: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[]
- one
- sharpen: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- smart_
crop: {
height: {
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
}- height: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- mode: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- width: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- height: {
- store: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
base64decode: {
type: string;
};
container: {
type: string;
};
filename: {
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
region: {
$ref: string;
};
workflows: {
$ref: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
base64decode: {
type: string;
};
container: {
type: string;
};
filename: {
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
region: {
$ref: string;
};
workflows: {
$ref: string;
};
};
type: string;
})[]
- one
- tags: {
additionalProperties: boolean;
type: string;
}- additional
Properties: boolean - type: string
- additional
- torn_
edges: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
spread: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
background: {
$ref: string;
};
spread: {
additionalItems: boolean;
items: {
default: number;
maximum: number;
minimum: number;
type: string;
}[];
minItems: number;
type: string;
};
};
type: string;
})[]
- one
- upscale: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
noise: {
default: string;
enum: string[];
type: string;
};
style: {
default: string;
enum: string[];
type: string;
};
upscale: {
default: boolean;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
noise: {
default: string;
enum: string[];
type: string;
};
style: {
default: string;
enum: string[];
type: string;
};
upscale: {
default: boolean;
type: string;
};
};
type: string;
})[]
- one
- urlscreenshot: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
agent: {
default: string;
enum: string[];
type: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
device: {
default: string;
type: string;
};
height: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
orientation: {
default: string;
enum: string[];
type: string;
};
width: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
agent: {
default: string;
enum: string[];
type: string;
};
delay: {
default: number;
maximum: number;
minimum: number;
type: string;
};
device: {
default: string;
type: string;
};
height: {
default: number;
maximum: number;
minimum: number;
type: string;
};
mode: {
default: string;
enum: string[];
type: string;
};
orientation: {
default: string;
enum: string[];
type: string;
};
width: {
default: number;
maximum: number;
minimum: number;
type: string;
};
};
type: string;
})[]
- one
- video_
convert: {
additionalProperties: boolean;
properties: {
access: {
default: string;
enum: string[];
type: string;
};
aspect_mode: {
default: string;
enum: string[];
type: string;
};
audio_bitrate: {
maximum: number;
minimum: number;
type: string;
};
audio_channels: {
maximum: number;
minimum: number;
type: string;
};
audio_codec: {
type: string;
};
audio_sample_rate: {
maximum: number;
minimum: number;
type: string;
};
clip_length: {
pattern: string;
type: string;
};
clip_offset: {
pattern: string;
type: string;
};
container: {
type: string;
};
extname: {
type: string;
};
filename: {
type: string;
};
force: {
type: string;
};
fps: {
maximum: number;
minimum: number;
type: string;
};
frame_count: {
default: number;
maximum: number;
minimum: number;
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
keyframe_interval: {
maximum: number;
minimum: number;
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
preset: {
type: string;
};
title: {
type: string;
};
two_pass: {
type: string;
};
upscale: {
type: string;
};
video_bitrate: {
maximum: number;
minimum: number;
type: string;
};
watermark_bottom: {
maximum: number;
minimum: number;
type: string;
};
watermark_left: {
maximum: number;
minimum: number;
type: string;
};
watermark_right: {
maximum: number;
minimum: number;
type: string;
};
watermark_top: {
maximum: number;
minimum: number;
type: string;
};
watermark_url: {
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
};
type: string;
}- additional
Properties: boolean - properties: {
access: {
default: string;
enum: string[];
type: string;
};
aspect_mode: {
default: string;
enum: string[];
type: string;
};
audio_bitrate: {
maximum: number;
minimum: number;
type: string;
};
audio_channels: {
maximum: number;
minimum: number;
type: string;
};
audio_codec: {
type: string;
};
audio_sample_rate: {
maximum: number;
minimum: number;
type: string;
};
clip_length: {
pattern: string;
type: string;
};
clip_offset: {
pattern: string;
type: string;
};
container: {
type: string;
};
extname: {
type: string;
};
filename: {
type: string;
};
force: {
type: string;
};
fps: {
maximum: number;
minimum: number;
type: string;
};
frame_count: {
default: number;
maximum: number;
minimum: number;
type: string;
};
height: {
maximum: number;
minimum: number;
type: string;
};
keyframe_interval: {
maximum: number;
minimum: number;
type: string;
};
location: {
$ref: string;
};
path: {
type: string;
};
preset: {
type: string;
};
title: {
type: string;
};
two_pass: {
type: string;
};
upscale: {
type: string;
};
video_bitrate: {
maximum: number;
minimum: number;
type: string;
};
watermark_bottom: {
maximum: number;
minimum: number;
type: string;
};
watermark_left: {
maximum: number;
minimum: number;
type: string;
};
watermark_right: {
maximum: number;
minimum: number;
type: string;
};
watermark_top: {
maximum: number;
minimum: number;
type: string;
};
watermark_url: {
type: string;
};
width: {
maximum: number;
minimum: number;
type: string;
};
}- access: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- aspect_
mode: {
default: string;
enum: string[];
type: string;
}- default: string
- enum: string[]
- type: string
- audio_
bitrate: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- audio_
channels: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- audio_
codec: {
type: string;
}- type: string
- audio_
sample_ rate: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- clip_
length: {
pattern: string;
type: string;
}- pattern: string
- type: string
- clip_
offset: {
pattern: string;
type: string;
}- pattern: string
- type: string
- container: {
type: string;
}- type: string
- extname: {
type: string;
}- type: string
- filename: {
type: string;
}- type: string
- force: {
type: string;
}- type: string
- fps: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- frame_
count: {
default: number;
maximum: number;
minimum: number;
type: string;
}- default: number
- maximum: number
- minimum: number
- type: string
- height: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- keyframe_
interval: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- location: {
$ref: string;
}- $ref: string
- path: {
type: string;
}- type: string
- preset: {
type: string;
}- type: string
- title: {
type: string;
}- type: string
- two_
pass: {
type: string;
}- type: string
- upscale: {
type: string;
}- type: string
- video_
bitrate: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- watermark_
bottom: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- watermark_
left: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- watermark_
right: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- watermark_
top: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- watermark_
url: {
type: string;
}- type: string
- width: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- access: {
- type: string
- additional
- vignette: {
oneOf: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
background: {
$ref: string;
};
blurmode: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[];
}- one
Of: ({
additionalProperties?: undefined;
properties?: undefined;
type: string;
} | {
additionalProperties: boolean;
properties: {
amount: {
default: number;
maximum: number;
minimum: number;
type: string;
};
background: {
$ref: string;
};
blurmode: {
default: string;
enum: string[];
type: string;
};
};
type: string;
})[]
- one
- watermark: {
additionalProperties: boolean;
properties: {
file: {
type: string;
};
position: {
$ref: string;
};
size: {
maximum: number;
minimum: number;
type: string;
};
};
required: string[];
type: string;
}- additional
Properties: boolean - properties: {
file: {
type: string;
};
position: {
$ref: string;
};
size: {
maximum: number;
minimum: number;
type: string;
};
}- file: {
type: string;
}- type: string
- position: {
$ref: string;
}- $ref: string
- size: {
maximum: number;
minimum: number;
type: string;
}- maximum: number
- minimum: number
- type: string
- file: {
- required: string[]
- type: string
- additional
- zip: {
type: string;
}- type: string
- animate: {
- title: string
- type: string
Defined in lib/filelink.ts:694
imagesize
imagesize(): FilelinkAdds imagesize transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:848
minifyCss
minifyCss(params: MinifyCssParams): FilelinkAdd task which minify a css file
Returns
this
Memberof
Filelink
Parameters
- params: MinifyCssParams
Returns Filelink
Defined in lib/filelink.ts:1435
minifyJs
minifyJs(params: MinifyJsParams): FilelinkAdd task which minify a javascript file. For better handling of ‘targets’ param, use with b64 flag enabled.
Returns
this
Memberof
Filelink
Parameters
- params: MinifyJsParams
Returns Filelink
Defined in lib/filelink.ts:1446
modulate
modulate(params?: boolean | ModulateParams): FilelinkAdds modulate transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | ModulateParams
Returns Filelink
Defined in lib/filelink.ts:1257
monochrome
monochrome(): FilelinkAdd monochrome transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:925
negative
negative(): FilelinkAdds negative transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:947
noMetadata
noMetadata(): FilelinkAdds noMetadata transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:859
oilPaint
oilPaint(params?: boolean | OilPaintParams): FilelinkAdds oilpaint transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | OilPaintParams
Returns Filelink
Defined in lib/filelink.ts:1245
output
output(params: OutputParams): FilelinkAdds output transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: OutputParams
Returns Filelink
Defined in lib/filelink.ts:1353
partialBlur
partialBlur(params: PartialBlurParams): FilelinkAdds partial blur transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: PartialBlurParams
Returns Filelink
Defined in lib/filelink.ts:1281
partialPixelate
partialPixelate(params: PartialPixelateParams): FilelinkAdds partial pixelate transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: PartialPixelateParams
Returns Filelink
Defined in lib/filelink.ts:1269
pixelate
pixelate(params?: boolean | PixelateParams): FilelinkAdds pixelate transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | PixelateParams
Returns Filelink
Defined in lib/filelink.ts:1233
pixelateFaces
pixelateFaces(params: PixelateFacesParams): FilelinkAdds pixelate faces transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: PixelateFacesParams
Returns Filelink
Defined in lib/filelink.ts:1077
pjpg
pjpg(params: ProgressiveJpgParams): FilelinkAdds Progressive JPEG transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: ProgressiveJpgParams
Returns Filelink
Defined in lib/filelink.ts:870
polaroid
polaroid(params?: boolean | PolaroidParams): FilelinkAdds polaroid transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | PolaroidParams
Returns Filelink
Defined in lib/filelink.ts:1113
quality
quality(params: QualityParams): FilelinkAdds quality transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: QualityParams
Returns Filelink
Defined in lib/filelink.ts:1329
redeye
redeye(): FilelinkAdd security to link
See
Returns
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:914
reset
reset(): FilelinkCleanup transformations on filelink
Returns
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:799
resize
resize(params: ResizeParams): FilelinkAdds resize transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: ResizeParams
Returns Filelink
Defined in lib/filelink.ts:1017
rotate
rotate(params: RotateParams): FilelinkAdds rotate transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: RotateParams
Returns Filelink
Defined in lib/filelink.ts:1041
roundedCorners
roundedCorners(params?: boolean | RoundedCornersParams): FilelinkAdds rounded corners transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | RoundedCornersParams
Returns Filelink
Defined in lib/filelink.ts:1101
security
security(params: SecurityParams): FilelinkAdds security transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: SecurityParams
Returns Filelink
Defined in lib/filelink.ts:1341
sepia
sepia(params?: boolean | SepiaParams): FilelinkAdds sepia transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | SepiaParams
Returns Filelink
Defined in lib/filelink.ts:1221
setBase64
setBase64(flag: boolean): FilelinkEnable new base64 link support to avoid problems with special chars in link
Returns
Memberof
Filelink
Parameters
- flag: boolean
Returns Filelink
Defined in lib/filelink.ts:631
setCname
setCname(cname: string): FilelinkSet cname for transformation link
Returns
Memberof
Filelink
Parameters
- cname: string
Returns Filelink
Defined in lib/filelink.ts:655
setCustomDomain
setCustomDomain(domain: string): FilelinkSet custom domain. Used for test purpose. It will be removed when after client.transform
Returns
Memberof
Filelink
Parameters
- domain: string
Returns Filelink
Defined in lib/filelink.ts:667
setSource
setSource(source: string | string[]): voidParameters
- source: string | string[]
Returns void
Defined in lib/filelink.ts:672
setUseValidator
setUseValidator(flag: boolean): FilelinkSwitch the useValidator flag
Returns
Memberof
Filelink
Parameters
- flag: boolean
Returns Filelink
Defined in lib/filelink.ts:643
sfw
sfw(): FilelinkAdds sfw transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:969
shadow
shadow(params?: boolean | ShadowParams): FilelinkAdds shadow transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | ShadowParams
Returns Filelink
Defined in lib/filelink.ts:1149
sharpen(params?: boolean | SharpenParams): FilelinkAdds sharpen transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | SharpenParams
Returns Filelink
Defined in lib/filelink.ts:1185
smartCrop
smartCrop(params: SmartCropParams): FilelinkAdds imagesize transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: SmartCropParams
Returns Filelink
Defined in lib/filelink.ts:881
store
store(params?: boolean | StoreParams): FilelinkAdds store transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | StoreParams
Returns Filelink
Defined in lib/filelink.ts:993
tags(): FilelinkAdds tags transformation
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:958
toString
toString(): stringReturns transform url
Returns
Memberof
Filelink
Returns string
Defined in lib/filelink.ts:717
tornEdges
tornEdges(params?: boolean | TornEdgesParams): FilelinkAdds torn edges transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | TornEdgesParams
Returns Filelink
Defined in lib/filelink.ts:1137
upscale
upscale(params?: boolean | UpscaleParams): FilelinkAdds upscale transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | UpscaleParams
Returns Filelink
Defined in lib/filelink.ts:1305
videoConvert
videoConvert(params: VideoConvertParams): FilelinkAdds video convert transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: VideoConvertParams
Returns Filelink
Defined in lib/filelink.ts:1365
vignette
vignette(params?: boolean | VignetteParams): FilelinkAdds vignette transformation
See
Returns
this
Memberof
Filelink
Parameters
Optionalparams: boolean | VignetteParams
Returns Filelink
Defined in lib/filelink.ts:1125
watermark
watermark(params: WatermarkParams): FilelinkAdds watermart transformation
See
Returns
this
Memberof
Filelink
Parameters
- params: WatermarkParams
Returns Filelink
Defined in lib/filelink.ts:892
zip
zip(): FilelinkAdd zip transformation which create a zip package on files used on actual context
See
Returns
this
Memberof
Filelink
Returns Filelink
Defined in lib/filelink.ts:1425
Class FilestackError
Hierarchy
- Error
- FilestackError
Defined in filestack_error.ts:25
Index
Constructors
Properties
Constructors
constructor
new FilestackError(message?: string, details?: any, type?: FilestackErrorType): FilestackErrorParameters
Optionalmessage: stringOptionaldetails: anyOptionaltype: FilestackErrorType
Returns FilestackError
Overrides Error.constructor
Defined in filestack_error.ts:36
Properties
details
Readonly
details: anyError details, ie validation errors
Memberof
FilestackError
Defined in filestack_error.ts:33
type
Readonly
type: stringDefined in filestack_error.ts:34
Class FsCancelToken
Filestack token that allow pause, resume or cancel given upload
Export
Hierarchy
- EventEmitter
- FsCancelToken
Defined in lib/request/token.ts:26
Index
Constructors
Methods
Constructors
constructor
new FsCancelToken(): FsCancelTokenReturns FsCancelToken
Inherited from EventEmitter.constructor
Methods
cancel
cancel(reason?: string | Error): voidCancel request action
Memberof
Token
Parameters
Optionalreason: string | Error
Returns void
Defined in lib/request/token.ts:34
Constructors
constructor
new FsRequest(config?: FsRequestOptions): FsRequestCreates an instance of Request.
Memberof
FsRequest
Parameters
Optionalconfig: FsRequestOptions
Returns FsRequest
Defined in lib/request/request.ts:62
Methods
dispatch
dispatch(config: FsRequestOptions): Promise<FsResponse>Run request with given adapter
Returns
Memberof
Request
Parameters
- config: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:92
delete
Static
delete(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch DELETE request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:174
dispatch
Static
dispatch(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:109
get
Static
get(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch GET request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:122
head
Static
head(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch HEAD request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:135
options
Static
options(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch OPTIONS request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:148
path
Static
path(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>Dispatch PATCH request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionaldata: anyOptionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:216
post
Static
post(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>Dispatch POST request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionaldata: anyOptionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:188
purge
Static
purge(url: string, config?: FsRequestOptions): Promise<FsResponse>Dispatch PURGE request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:161
put
Static
put(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>Dispatch PUT request
Static
Returns
Memberof
FsRequest
Parameters
- url: string
Optionaldata: anyOptionalconfig: FsRequestOptions
Returns Promise<FsResponse>
Defined in lib/request/request.ts:202
Class FsRequestError
Custom Filestack Request error class
Export
Hierarchy
- Error
- FsRequestError
Defined in lib/request/error.ts:42
Index
Constructors
Properties
Constructors
constructor
new FsRequestError(message: string, config: any, response?: FsResponse, code?: FsRequestErrorCode): FsRequestErrorCreates an instance of FsRequestError.
Memberof
FsRequestError
Parameters
- message: string
- config: any
Optionalresponse: FsResponseOptionalcode: FsRequestErrorCode
Returns FsRequestError
Overrides Error.constructor
Defined in lib/request/error.ts:62
Properties
code
Readonly
code: FsRequestErrorCodeDefined in lib/request/error.ts:51
config
Readonly
config: FsRequestOptionsError details, ie validation errors
Memberof
FilestackError
Defined in lib/request/error.ts:49
response
Readonly
response: FsResponseDefined in lib/request/error.ts:50