Skip to content

Commit 1df8f1a

Browse files
committed
Modify description and typescript
1 parent 2036369 commit 1df8f1a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/Adapters/Files/FilesAdapter.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,14 @@ export class FilesAdapter {
3030
* @param {string} contentType - the supposed contentType
3131
* @discussion the contentType can be undefined if the controller was not able to determine it
3232
* @param {object} options - (Optional) options to be passed to file adapter (S3 File Adapter Only)
33+
* @param {Config} config -(Optional) server configuration
3334
* - tags: object containing key value pairs that will be stored with file
3435
* - metadata: object containing key value pairs that will be sotred with file (https://docs.aws.amazon.com/AmazonS3/latest/user-guide/add-object-metadata.html)
3536
* @discussion options are not supported by all file adapters. Check the your adapter's documentation for compatibility
3637
*
37-
* @return {Promise} a promise that should fail if the storage didn't succeed
38+
* @return {Promise<any>|Promise<{url?: string, name?: string}>} Either a plain promise that should fail if storage didn't succeed, or a promise resolving to an object containing url and/or an updated filename
3839
*/
39-
createFile(filename: string, data, contentType: string, options: Object): Promise {}
40+
createFile(filename: string, data, contentType: string, options: Object, config: Config): Promise {}
4041

4142
/** Responsible for deleting the specified file
4243
*

0 commit comments

Comments
 (0)