フックスペック
概要
各Sailsフックは、単一の引数（実行中のsailsインスタンスへの参照）を取り、このドキュメントで後述するキーの1つ以上を持つオブジェクトを返すJavaScript関数として実装されます。最も基本的なフックは次のようになります。
module.exports = function myBasicHook(sails) {
return {};
}
あまり機能はしませんが、動作はします！
各フックは、ファイル名index.jsで独自のフォルダーに保存する必要があります。フォルダー名はフックを一意に識別する必要があり、フォルダーには任意の数の追加ファイルとサブフォルダーを含めることができます。前の例を拡張して、Sailsプロジェクト内のフォルダーapi/hooks/my-basic-hookにmyBasicHookを含むファイルをindex.jsとして保存し、sails lift --verboseでアプリを起動した場合、出力に次の内容が表示されます。
verbose: my-basic-hook フックが正常にロードされました。
フックの機能
以下の機能は、フックに実装するために利用できます。すべての機能はオプションであり、フック関数によって返されるオブジェクトに追加することで実装できます。
カスタムフックのデータと関数
メインフック関数から返されるオブジェクトに追加されたその他のキーは、sails.hooks[<hook name>]オブジェクトで提供されます。これは、カスタムフック機能がエンドユーザーに提供される方法です。フックに対してプライベートにしたいデータや関数は、返されるオブジェクトの外側に追加できます。
// File api/hooks/myhook/index.js
module.exports = function (sails) {
// This var will be private
var foo = 'bar';
return {
// This var will be public
abc: 123,
// This function will be public
sayHi: function (name) {
console.log(greet(name));
}
};
// This function will be private
function greet (name) {
return 'Hi, ' + name + '!';
}
};
上記のパブリック変数と関数は、それぞれsails.hooks.myhook.abcおよびsails.hooks.myhook.sayHiとして使用可能になります。
sailsjs.comでのより良い体験のために、ブラウザを更新してください。
概念
愛を込めて構築されました
Sailsフレームワークは、テキサス州オースティンのWeb＆モバイルショップによって、コントリビューターの助けを借りて構築されています。 2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。 当然のことながら、オープンソース化しました。 それがあなたの生活を少しでも楽にすることを願っています！
© 2012-2024 The Sails Company。
SailsフレームワークはMITライセンスの下で無料でオープンソースです。
イラスト：Edamame。