$fn.getFile(path)

Retrieves the file at the specified path. "asynchronous"

Note

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of file to be retrieved

Note

If "path" is specified as empty, undefined, or null, the process ignores it.

Return value

Type	Description
Promise<{data: Buffer}>	Object with properties of binary data (data: Buffer type) to be retrieved from Amazon S3

Note

If the file is text and you want to retrieve the content string, you can use Buffer#toString().

Sample

try {
     const file = await $fn.getFile('/note.json');
     const buffer = file.data;
     // JSON object
     const obj = JSON.parse(buffer.toString());
 } catch (err) {
     console.log("Error", err);
 }