IPWorks EDIFACT 2020 Node.js Edition

Questions / Feedback?

OutputFormat Property

The format of the output data.

Syntax

 edifacttranslator.getOutputFormat([callback])
 edifacttranslator.setOutputFormat( outputFormat, [callback])

Possible Values

  0 (eofXML), 
  1 (eofJSON), 
  2 (eofEDIFACT)

Default Value

0

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 getOutputFormat([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 setOutputFormat([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 the format of the output data. The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

  • 0 (ofXML)
  • 1 (ofJSON)
  • 2 (ofEDIFACT)
Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to EDI and vice versa are supported. If InputFormat is ifXML or ifJSON, OutputFormat must be an EDI format. Similarly, if InputFormat is an EDI format, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDIFACT 2020 Node.js Edition - Version 20.0 [Build 8162]