Reader.readUntil(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Returns string from current position to the next occurrence of options.tag. Returns the rest of the string if tag is not found. Returns null if reading is already finished. All types of characters are supported. If there's a character that does not exist until the end of the file, the rest of the file is returned.
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.tag	string	required	String containing a tag	2019.1

Errors

Error Code	Message	Thrown If
SSS_TAG_CANNOT_BE_EMPTY	Tag cannot be empty.	The options.tag argument is empty.
SSS_INVALID_ARG_TYPE	You have entered an invalid type argument: <passed type argument>	The options.tag argument is not a string.
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