API Reference

Box.File Class

Defined in lib/box/file.js:6

Description

The file object of the Box class.

Constructor

Box.File

(box, source, path, type, params)
Defined in lib/box/file.js:6

The file object of the Box class.

Parameters

Methods

read

([options], [callback]) async
Defined in lib/box/file.js:27

Reads the file.

Parameters

read

([options]) String
Defined in lib/box/file.js:48

Reads the file synchronizedly.

Parameters

Returns

render

([options], [callback]) async
Defined in lib/box/file.js:80

Renders the file with renderers.

Parameters

renderSync

([options]) String
Defined in lib/box/file.js:101

Renders the file with renderers synchronizedly.

Parameters

Returns

stat

(callback) async
Defined in lib/box/file.js:59

Gets the file status.

Parameters

statSync

fs.Stats
Defined in lib/box/file.js:70

Gets the file status synchronizedly.

Returns