PagedData.pageSize

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Maximum number of entries per page

Possible values are 5 - 1000 entries per page.

Type

number

This property is read-only.

Supported Script Types

Client and server scripts

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

Module

N/search Module

Since

2016.1

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/search Module Script Samples.

          // Add additional code
...
var mySearch = search.create({
    type: search.Type.CUSTOMER,
    columns: [
        'entityid',
        'email'
    ]
});

var myPagedResults = mySearch.runPaged({
    pageSize: 10
});

// In this example, the value of myPagedResults.pageSize is 10
var thePageSize = myPagedResults.pageSize;

// Use PagedData.fetch(options) to retrieve a page of results (as a
// search.Page object) by index
var theData = myPagedResults.fetch({
    index: 5
});
...
// Add additional code

Syntax

Related Topics