Files

To place a file in the Store, you need to create a file handle using the createFile(...) function. The function accepts a StoreId, public and private metadata,the total size of the file that will be uploaded, and set up a flag that tells whether the file has the random write feature enabled.

Then you need to call writeToFile(...) providing the created file handle and a portion of data to write. For small files, you can write the entire file with one request. For large files, it's more optimal to write them piece by piece, loading them in portions, for example from the disk, and then calling writeToFile(...) on each piece. To complete the entire file upload process - call closeFile(...) with the file handle as a parameter.

// for example, let's put some extra file info in the file's private meta
const sampleFileInfo = {
    name: file.name,
    mimetype: file.type
};

const sampleFileData = serializeObject("sample file data");

const fileHandle = await storeApi.createFile(storeId,
    serializeObject("file's public meta-data"),
    serializeObject(sampleFileInfo),
    sampleFileData.length,
    true
);

await storeApi.writeToFile(fileHandle, sampleFileData);
const fileId = await storeApi.closeFile(fileHandle);

A detailed code sample of how to upload (stream) a large file can be found here.

To update information about a file, you need to use the updateFileMeta(...).

// Example: let's update given file's private meta to reflect the file's name change.
const currentFile =  storeApi.getFile(fileId);
const currentFilePrivateMeta = deserializeObject(currentFile.privateMeta);
const newFilePrivateMeta = {
    name: "newFileName"
};
await storeApi.updateFileMeta(
    fileId,
    currentFile.publicMeta,
    serializeObject(newFilePrivateMeta)
);