upload( )
Uploads a file to the Media Manager from a buffer.
Description
The upload() function returns a Promise that resolves to information about
the newly uploaded file.
Video and audio files that have been uploaded aren't immediately available
to be used even after the Promise is resolved. Before they can be used, they
must first undergo transcoding. The onFileUploaded()
event is triggered when a file has been uploaded and before the transcoding is finished.
To import a file to the Media Manager directly from a URL, use the importFile() function.
To enable site visitors to upload files to your site, you can also use an upload button.
Note: There are limits on the size and duration of files that you can upload. See Wix Media: Supported Media File Types and File Sizes for more details.
Syntax
function upload(path: string, fileContent: Buffer, fileName: string, options: UploadOptions): FileInfo
upload Parameters
NAME
TYPE
DESCRIPTION
The path within the Media Manager where the file will be uploaded.
If the path doesn't yet exist, the missing folders will be created,
for example: /media/files.
If metadataOptions.isVisitorUpload is true (default), the visitor-uploads folder is the root of the file path,
in this case, visitor-uploads/media/files/.
Buffer containing the content to be uploaded.
In this case the fileName is the name you would like your file to appear as in the Media Manager.
Options to use when uploading the file.
Returns
Fulfilled - Information about the file that was uploaded.
Return Type:
NAME
TYPE
DESCRIPTION
Deprecated. Use the fileUrl property instead.
The fileName property is the internal name (unique identifier) which is generated when a file is uploaded by the Media Manager, returned from the importFile(), or upload() functions. The name is the string located in the file's URL. Click here to learn more. Use this name when calling the getFileInfo(), getFileUrl(),
and getVideoPlaybackUrl() functions.
The file's Wix media URL in the following format: 'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'.
File hash.
Size of the uploaded file in bytes.
Type of the file that was uploaded. One of:
"audio""document""image""shape""video"
Whether the link to the uploaded file is public or private. Private links require a token to be used.
ID of the file's parent folder.
Original name of the uploaded file. This is the display name that appears in the Media Manager.
Status of the file that was uploaded. One of:
"IN-DOWNLOAD-QUEUE""IN-QUEUE""READY"
URL where the file was uploaded from.
URL of the file's icon.
List of labels assigned to the file by the Media Manager.
Media height.
Media width.
Date the file was created.
Date the file was updated.
Was this helpful?
Upload a file
1import { mediaManager } from 'wix-media-backend';23export function uploadImage(buffer) {4 return mediaManager.upload(5 "/myUploadFolder/subfolder",6 buffer,7 "myFileName.jpg",8 {9 "mediaOptions": {10 "mimeType": "image/jpeg",11 "mediaType": "image"12 },13 "metadataOptions": {14 "isPrivate": false,15 "isVisitorUpload": false,16 "context": {17 "someKey1": "someValue1",18 "someKey2": "someValue2"19 }20 }21 }22 );23}2425/* Returns a promise that resolves to:26 * {27 * "mediaType": "image",28 * "isPrivate": false,29 * "sizeInBytes": 51085,30 * "mimeType": "image/jpeg",31 * "iconUrl": "wix:image://v1/f6c0f9_g2ae28cf29ec4639bc45698fee57cf56~mv2.jpg/myFileName.jpg#originWidth=300&originHeight=300",32 * "fileUrl": "wix:image://v1/f6c0f9_g2ae28cf29ec4639bc45698fee57cf56~mv2.jpg/myFileName.jpg#originWidth=300&originHeight=300",33 * "originalFileName": "myFileName.jpg",34 * "hash": "bee2f8aab80b0d011499361c2eb189eb",35 * "labels": [36 * "Blue",37 * "Butterfly",38 * "Turquoise"39 * ],40 * "width": 300,41 * "height": 30042 * }43 */