From 4c19583e16106df7d1b675751eea18ba2b4ad133 Mon Sep 17 00:00:00 2001 From: osaton Date: Tue, 17 Mar 2020 15:37:31 +0200 Subject: [PATCH] Update documentation --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09edcf6..76e311f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ * [.createDirectoryFolders(folderData)](#StudioHelper+createDirectoryFolders) ⇒ [Array.<ResultObj>](#ResultObj) * [.getLocalFolders(path)](#StudioHelper+getLocalFolders) ⇒ Array.<string> * [.getFiles(folderId)](#StudioHelper+getFiles) ⇒ Promise.<Array.<Object>> - * [.deleteFiles(files)](#StudioHelper+deleteFiles) ⇒ Promise.<Object> + * [.deleteFiles(files, options)](#StudioHelper+deleteFiles) ⇒ Promise.<Object> * [.uploadFiles(files, folderId)](#StudioHelper+uploadFiles) ⇒ Promise.<Array.<Object>> * [.replaceFiles(files, [options])](#StudioHelper+replaceFiles) ⇒ Promise.<Array.<Object>> * [.getFileHeaders(fileId)](#StudioHelper+getFileHeaders) ⇒ [ResultObj](#ResultObj) @@ -178,14 +178,16 @@ Get files of a folder -### studioHelper.deleteFiles(files) ⇒ Promise.<Object> +### studioHelper.deleteFiles(files, options) ⇒ Promise.<Object> Delete files **Kind**: instance method of [StudioHelper](#StudioHelper) -| Param | Type | Description | -| --- | --- | --- | -| files | Array.<string> | Array of file ids | +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| files | Array.<string> | | Array of file ids | +| options | Object | | | +| [options.throttle] | number | 1 | Number of concurrent delete file requests. Max 5 |