File.size

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The size of a file in bytes.

This property is read-only.

Note:

You can use this value to determine if the file is within size limits for File.getContents(). Size will reflect any lines you have streamed into a file. For example, the original file size plus lines appended.

Type

number

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/file Module

Since

2015.2

Errors

Error Code

Message

Thrown If

READ_ONLY_PROPERTY

You attempt to edit this property.

Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/file Module Script Samples.

          //Add additional code 
...
var fileObj = file.load({
    id: 'Images/myImageFile.jpg'
});
log.debug({
    details: "File Size: " + fileObj.size
});
...
 //Add additional code 

        

Related Topics

file.File
N/file Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices