Flush Method

Flushes the parser and checks its end state.

Syntax

idocreader.flush([callback])

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 this 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

When Flush is called, the parser flushes all its buffers, processes all available events, and then checks its end state. If Validate is true, the parser also verifies that all open segments are completed, returning an error if they are not.

Any extra un-parsed data will be populated in the ExtraData property after this method is called.