Router

Routerは、サイトで使用されているすべてのパスを保存します。

パスの取得

getメソッドは、Streamを返します。たとえば、pathデータを指定された先に保存するには

var data = hexo.route.get("index.html");
var dest = fs.createWriteStream("somewhere");

data.pipe(dest);

パスの設定

setメソッドは、文字列、Buffer、または関数を引数にとります。

// String
hexo.route.set("index.html", "index");

// Buffer
hexo.route.set("index.html", new Buffer("index"));

// Function (Promise)
hexo.route.set("index.html", function () {
  return new Promise(function (resolve, reject) {
    resolve("index");
  });
});

// Function (Callback)
hexo.route.set("index.html", function (callback) {
  callback(null, "index");
});

パスが変更されたかどうかというブール値を設定することもできます。これにより、変更されていないファイルを無視することができ、ファイルの生成が高速化されます。

hexo.route.set("index.html", {
  data: "index",
  modified: false,
});

// hexo.route.isModified('index.html') => false

パスの削除

hexo.route.remove("index.html");

ルートのリストを取得

hexo.route.list();

パスの書式設定

formatメソッドは、文字列を有効なパスに変換します。

hexo.route.format("archives/");
// archives/index.html