spec.masao.space

masao.format

masao.formatはmasao-json-formatで表されたデータを扱うためのAPIです。

const {
  format,
} = require('masao');

format.load(obj)

format.loadは渡されたオブジェクトをmasao-json-formatに従って解釈するメソッドです。返り値は新しいオブジェクトです。

返り値のオブジェクトは元のオブジェクトと同じデータを表すmasao-json-formatに従ったオブジェクトです。元のオブジェクトが古いバージョンのmasao-json-formatに従っている場合でも、返り値のオブジェクトは最新のmasao-json-format (draft-4)に従ったものになります。

引数として渡されたオブジェクトがmasao-json-formatに従っていない場合はエラーとなります。

masao-json-formatに定義されていない独自のプロパティは返り値のオブジェクトにそのまま引き継がれます。

例

// 文字列データをmasao-json-formatで読み込む例
let data = '...';

try {
  const rawObj = JSON.parse(data);
  const gameObj = format.load(rawObj);

  console.log('これは正男オブジェクトです', gameObj);
} catch(e) {
  console.error('これは正男オブジェクトではありません！', e);
}

format.make(options)

optionsとして渡されたフィールドの一覧からmasao-json-formatに従ったオブジェクトを生成して返します。

optionsのデータが不正な場合はエラーを発生させます。optionsには次のフィールドを渡すことができます。これらのフィールドはmasao-json-formatのものと対応しています。