1. Homepage
  2. DataWeave (2.4)
  3. DataWeave リファレンス
  4. dw::extension::DataFormat

  5. DataFormat 型

DataFormat 型 (dw::extension::DataFormat)

DataFormat モジュールにより、DataWeave 言語の新しいデータ形式を登録するためのリソースが提供されます。例については、 「Custom Data Formats Example (カスタムデータ形式の例)」​を参照してください。

型 定義 説明

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 }

DataFormat 定義を表します。

  • binaryFormat?: Boolean​: これがテキストではなくバイナリとして表されるデータ形式の場合は true。存在しない場合は false。

  • defaultCharset?: String​: この形式のデフォルトの文字セット (ある場合)。

  • fileExtensions?: Array<String>​: このデータ形式に割り当てる ​.​ を含めたファイル拡張子 (たとえば、​.json​、​`.xml​) のリストを返します。

  • acceptedMimeTypes: Array<MimeType>​: 受け入れる MIME タイプのリスト。

  • reader: (content: Binary, charset: String, settings: ReaderSettings) → Any​: 未加工コンテンツを読み取り、DataWeave 正規モデルに変換する関数。

  • writer: (value:Any, settings:WriterSettings) → Binary​: DataWeave 正規モデルをバイナリコンテンツに書き込む関数。

EmptySettings

​type EmptySettings = Object

何も設定されていない設定を表します。

EncodingSettings

​type EncodingSettings = { encoding?: String }

エンコード設定を表します。

  • encoding?: String​: ライターで出力に使用されるエンコード。デフォルトは「UTF-8」です。

MimeType

​type MimeType = String

MIME タイプを表します (​application/json​ など)。

DataWeave バージョン 2.2.0 で導入されました。​

Settings

​type Settings = Object

リーダーまたはライターの設定。

DataWeave バージョン 2.2.0 で導入されました。​