EOL Property

Used to break the stdout data stream into chunks separated by its value.

Syntax

 rshell.getEOL([callback])
 rshell.setEOL( EOL_Buffer, [callback])

Default Value

"ASCII code 10 (newline)"

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getEOL([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setEOL([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The EOL property is used to define boundaries in the Stdout stream using the value of the property.

This property is not available at design time.

Data Type

Buffer