DataFormat Types (dw::extension::DataFormat)

The DataFormat module contains what you need to register a new data format for the DataWeave language. For an example, see Custom Data Formats Example.

Type Definition Description

Type	Definition	Description
DataFormat	`type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array<String>, acceptedMimeTypes: Array<MimeType>, reader: (content: Binary, charset: String, settings: ReaderSettings) -> Any, writer: (value: Any, settings: WriterSettings) -> Binary }`	Represents the DataFormat definition. `binaryFormat?: Boolean`: True if this is data format is represented in a binary representation instead of text. If not present, false. `defaultCharset?: String`: The default charset of this format, if any. `fileExtensions?: Array<String>`: Returns the list of file extensions with the . (".json", ".xml", etc…) that should be assigned to this Data Format `acceptedMimeTypes: Array<MimeType>` The list of MimeTypes that are accepted. `reader: (content: Binary, charset: String, settings: ReaderSettings) → Any`: This function will be in charge of reading the raw content and transform it into the DataWeave canonical model. `writer: (value:Any, settings:WriterSettings) → Binary`: This function will be in charge of writing the DataWeave canonical model into Binary content.
EmptySettings	`type EmptySettings = Object`	Represents a configuration with no Settings.
EncodingSettings	`type EncodingSettings = { encoding?: String }`	Represents an Encoding Settings: `encoding?: String`: Encoding to be used by this writer.
MimeType	`type MimeType = String`	Represents a MimeType, such as `application/json`.
Settings	`type Settings = Object`	Represents reader or writer configuration Settings.

DataFormat

type DataFormat = { binaryFormat?: Boolean, defaultCharset?: String, fileExtensions?: Array<String>, acceptedMimeTypes: Array<MimeType>, reader: (content: Binary, charset: String, settings: ReaderSettings) -> Any, writer: (value: Any, settings: WriterSettings) -> Binary }

Represents the DataFormat definition.

binaryFormat?: Boolean: True if this is data format is represented in a binary representation instead of text. If not present, false.
defaultCharset?: String: The default charset of this format, if any.
fileExtensions?: Array<String>: Returns the list of file extensions with the . (".json", ".xml", etc…) that should be assigned to this Data Format
acceptedMimeTypes: Array<MimeType> The list of MimeTypes that are accepted.
reader: (content: Binary, charset: String, settings: ReaderSettings) → Any: This function will be in charge of reading the raw content and transform it into the DataWeave canonical model.
writer: (value:Any, settings:WriterSettings) → Binary: This function will be in charge of writing the DataWeave canonical model into Binary content.

EmptySettings

type EmptySettings = Object

Represents a configuration with no Settings.

EncodingSettings

type EncodingSettings = { encoding?: String }

Represents an Encoding Settings:

encoding?: String: Encoding to be used by this writer.

MimeType

type MimeType = String

Represents a MimeType, such as application/json.

Settings

type Settings = Object

Represents reader or writer configuration Settings.