Overwrite Property

Whether to overwrite the file.

Syntax

 edifacttranslator.getOverwrite([callback])
 edifacttranslator.setOverwrite( overwrite, [callback])

Default Value

FALSE

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 getOverwrite([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setOverwrite([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

This property specifies whether the file is overwritten. If set to False (default) the class fails with an error when attempting to write to a file which already exists. If set to True the class will overwrite the existing file. This property is applicable to the following methods:

Data Type

Boolean