files - Backendjs Documentation

files

↓ Methods.

module:files

Description:

Files storage, upload and retrieval, local fs or S3

Source:

files.js, line 31

Methods

(async, static) acopy(source, dest, options) → {Promise(object)}

Description:

Async version of module:files.copy

Source:

files.js, line 426

Parameters:

Name	Type	Description
`source`	string
`dest`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) adel(file, options) → {Promise(object)}

Description:

Async version of module:files.del

Source:

files.js, line 519

Parameters:

Name	Type	Description
`file`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) adetect(file, flagsopt) → {Promise(object)}

Description:

Async version of module:files.detect

Source:

files.js, line 537

Parameters:

Name	Type	Attributes	Description
`file`	string \| Buffer
`flags`	string	<optional>

Returns:

Type	Description
Promise(object)	in format { err, data, ext }

(async, static) adetectAndStore(file, outfile, options) → {Promise(object)}

Description:

Async version of module:files.detectAndStore

Source:

files.js, line 481

Parameters:

Name	Type	Description
`file`	string \| Buffer
`outfile`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) alist(options) → {Promise(object)}

Description:

Async version of module:files.list

Source:

files.js, line 445

Parameters:

Name	Type	Description
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) aread(file, options) → {Promise(object)}

Description:

Async version of module:files.read

Source:

files.js, line 408

Parameters:

Name	Type	Description
`file`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) astore(tmpfile, outfile, options) → {Promise(object)}

Description:

Async version of module:files.store

Source:

files.js, line 500

Parameters:

Name	Type	Description
`tmpfile`	string \| Buffer
`outfile`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(async, static) aupload(req, name, options) → {Promise(object)}

Description:

Async version of module:files.upload

Source:

files.js, line 462

Parameters:

Name	Type	Description
`req`	Request
`name`	string
`options`	object

Returns:

Type	Description
Promise(object)	in format { err, data }

(static) copy(source, dest, options, callback)

Description:

Copy a file from one location to another, can deal with local and S3 files if starts with s3:// prefix

Source:

files.js, line 110

Parameters:

Name	Type	Description
`source`	string
`dest`	string
`options`	object
`callback`	function

(static) del(file, options, callback)

Description:

Delete file by name from the local filesystem or S3 drive if s3 is defined in api or options objects, no error is returned if the file does not exist to be compatible with S3 delete object

Source:

files.js, line 351

Parameters:

Name	Type	Description
`file`	string
`options`	object
`callback`	function

(static) detect(file, flagsopt, callbackopt)

Description:

Returns detected mime type and ext for a file, using the "file" utility, flags can be passed to the file utility to customize the output

Source:

files.js, line 375

Parameters:

Name	Type	Attributes	Description
`file`	string \| Buffer		file or data
`flags`	string	<optional>	command line flags for the file utility (--mime-type)
`callback`	function	<optional>	(err, mimeType, ext)

(static) detectAndStore(file, outfile, options, callback)

Description:

Detect file type and storee in one set

Source:

files.js, line 248

Parameters:

Name	Type	Description
`file`	string \| Buffer
`outfile`	string
`options`	object
`callback`	function

(static) list(options, callback)

Description:

Returns a list of file names inside the given path or S3 bucket

Source:

files.js, line 147

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Description
`path`	string	<optional>	path prefix
`filter`	string	<optional>	can be a regexp to restrict which files to return
`details`	boolean	<optional>	return list of objects as { file, size, mtime }

callback function

(static) read(file, optionsopt, callback)

Description:

Returns contents of a file, all specific parameters are passed as is, the contents of the file is returned to the callback, see module:lib.readFile or module.aws.s3GetFile for specific options.

Source:

files.js, line 72

Parameters:

Name Type Attributes Description

file string

options

object

Properties

Name	Type	Attributes	Description
`cfg`	boolean	<optional>	parse file in config format, name=value per line, return a list of args
`json`	boolean	<optional>	parse file as JSON, return an object, in case of error an empty object
`list`	string	<optional>	split contents with the given separator

callback function

(static) send(req, file, optionsopt)

Description:

Send a file to the client

Source:

files.js, line 38

Parameters:

Name Type Attributes Description

req

Request

Express request

file

string

file path

options

object

Properties

Name	Type	Attributes	Description
`attachment`	boolean \| string	<optional>	download the file
`s3`	string	<optional>	S3 bucket
`root`	string	<optional>	root folder, takes precedence over s3

(static) store(tmpfile, outfile, options, callback)

Description:

Place the uploaded tmpfile to the destination pointed by outfile

Source:

files.js, line 285

Parameters:

Name	Type	Description
`tmpfile`	string \| Buffer
`outfile`	string
`options`	object
`callback`	function

(static) upload(req, name, options, callback)

Description:

Upload file and store in the filesystem or S3, try to find the file in multipart form or in the body by the given name On return the options may have the following properties set:
- filesize - size of the file in bytes if available
- filetype - file extention with dot
- mimetype - file mime type if detected

Source:

files.js, line 183

Parameters:

Name Type Description

req Request

name

string

is the name property to look for in the multipart body or in the request body

options

object

Output file name is built according to the following options properties:

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	defines the output name for the file, if not given same name as property will be used
`prefix`	string	<optional>	the folder prefix where the file will be uploaded, all leading folders will be created automatically
`ext`	string	<optional>	what file extention to use, appended to the name, if no ext is given the extension from the uploaded file will be used or no extention if could not determine one.
`extkeep`	boolean	<optional>	keep actual extention from the uploaded file, ignore the ext parameter
`extmap`	object	<optional>	an object which extensions must be replaced
`namekeep`	boolean	<optional>	keep the name of the uploaded file if present in the multipart form
`encoding`	string	<optional>	encoding of the body, default is base64
`allow`	regexp	<optional>	a Regexp with allowed MIME types, this will use `detect` method to discover file type by the contents
`maxsize`	int	<optional>	refuse to save if the payload exceeds the given size

callback

function

will be called with err and actual filename saved