DocumentMetadata.byteLength

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The size of the normalized JSON document body in bytes.

This property is read-only. The size is measured after UTF-8 encoding and excludes the generated _id. For the document-size limit, see dataStore.Document.

Type

number

Supported Script Types

Server scripts

Module

N/dataStore Module

Parent Object

dataStore.DocumentMetadata

Sibling Object Members

DocumentMetadata Object Members

Since

2026.2

Syntax

Important:

The following code sample shows the syntax for this member. It isn't a functional example. For a complete script example, see N/dataStore Module Script Samples.

            // Add additional code
...

const value = metadata.byteLength;

...
// Add additional code 

          

General Notices