Functions
Function Filestack
Filestack(apikey: string, options?: ClientOptions): ClientInitialize client with given config
Parameters
- apikey: string
Optionaloptions: ClientOptions
Returns
Defined in index.ts:39
Function b64
b64(data: string, safeUrl?: boolean): stringreturn based string
Parameters
- data: string
- safeUrl: boolean = false
Returns
string
Defined in lib/utils/index.node.ts:35
Function cleanUpCallbacks
cleanUpCallbacks(obj: any): anyDeep cleanup object from functions
Parameters
- obj: any
Returns
any
Defined in lib/utils/index.ts:249
Function extensionToMime
extensionToMime(ext: string): stringChange extension to according mimetype using ext=>mimetype map
Returns
string|boolean
Parameters
- ext: string
string
Returns
string
Defined in lib/utils/index.ts:152
Function filterObject
filterObject(toFilter: any, requiredFields: string[]): anyFilter object to given fields
Parameters
- toFilter: any
- requiredFields: string[]
Returns
any
Defined in lib/utils/index.ts:230
Function getMimetype
getMimetype(file: Uint8Array | Buffer, name?: string): Promise<string>Check if input is a svg
Returns
- mimetype
Parameters
- file: Uint8Array | Buffer
Optionalname: string
Returns
Promise<string>
Defined in lib/utils/index.ts:104
Function getSecurity
getSecurity(policyOptions: SecurityOptions, appSecret: string): SecurityReturns Filestack base64 policy and HMAC-SHA256 signature
Example
import * as filestack from 'filestack-js';
const jsonPolicy = { 'expiry': 253381964415 };
const security = filestack.getSecurity(jsonPolicy, '<YOUR_APP_SECRET>');
Parameters
- policyOptions: SecurityOptions
- appSecret: string
Returns
Defined in lib/api/security.node.ts:39
Function getVersion
getVersion(): stringReturn currently used filestack-js sdk version
Returns
string
Defined in lib/utils/index.node.ts:48
Function init
init(apikey: string, options?: ClientOptions): ClientInitialize client with given config
Parameters
- apikey: string
Optionaloptions: ClientOptions
Returns
Defined in index.ts:39
Function isFacebook
isFacebook(): booleanCheck if application is runned in facebook browser
Returns
boolean
Defined in lib/utils/index.node.ts:61
Function isMobile
isMobile(): booleanReturns if browser is a mobile device (if node env always return false)
Returns
boolean
Defined in lib/utils/index.node.ts:56
Function sanitizeName
sanitizeName(name: string, options?: SanitizeOptions): stringSanitize file name
Parameters
- name: string
- options: SanitizeOptions = true
enable,disable sanitizer, default enabled
Returns
string
Defined in lib/utils/index.ts:197
Function uniqueId
uniqueId(len?: number): stringGenerates random string with provided length
Parameters
- len: number = 10
Returns
string
Defined in lib/utils/index.ts:94
Function validateWebhookSignature
validateWebhookSignature(secret: string, rawBody: string, toCompare: WebhookValidatePayload): booleanCheck webhook signature
Parameters
- secret: string
app secred - rawBody: string
unchanged raw webhook body - toCompare: WebhookValidatePayload
data from wh response headers
Returns
boolean
Defined in lib/api/security.node.ts:61