Reader.readChars(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Returns the next options.number characters from the current position. Returns less than the number if there is not enough characters to read in the file. Returns null if reading is already finished.
Returns	string
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/file Module
Since	2019.1

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.number	number	required	The number of characters to read.	2019.1

Errors

Error Code	Message	Thrown If
SSS_INVALID_READ_SIZE	Read size must be positive.	The options.number argument is not greater than zero.
SSS_INVALID_ARG_TYPE	You have entered an invalid type argument: <passed type argument>	The options.number argument is not a number.
SSS_MISSING_REQD_ARGUMENT	<name of missing parameter>	A required argument is not passed.

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 reader = context.input.file.getReader();

var textUntilFirstComma = reader.readUntil(',');
var next10Characters = reader.readChars(10);
var textUntilNextNewLine = reader.readUntil('\n');
var next100Characters = reader.readChars(100);

...
// Add additional code 

        

Related Topics

file.File

N/file Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices