task()

注意: このAPIはもはや推奨されるパターンではありません - タスクをエクスポートしてください。

タスクシステム内にタスクを定義します。タスクは、コマンドラインおよび`series()`、`parallel()`、`lastRun()` APIからアクセスできます。

使用方法

名前付き関数をタスクとして登録する

const { task } = require('gulp');

function build(cb) {

// 本文は省略

cb();

}

task(build);

匿名関数をタスクとして登録する

const { task } = require('gulp');

task('build', function(cb) {

// 本文は省略

cb();

});

以前に登録されたタスクを取得する

const { task } = require('gulp');

task('build', function(cb) {

// 本文は省略

cb();

});

const build = task('build');

シグネチャ

task([taskName], taskFunction)

パラメータ

`taskName`が指定されていない場合、タスクは名前付き関数の`name`プロパティまたはユーザー定義の`displayName`プロパティによって参照されます。 `displayName`プロパティがない匿名関数には、`taskName`パラメータを使用する必要があります。

登録されているタスクはコマンドラインから実行できるため、タスク名にスペースを使用しないでください。

パラメータ	型	備考
taskName	文字列	タスクシステム内のタスク関数のエイリアス。 `taskFunction`に名前付き関数を使用する場合、これは不要です。
taskFunction (必須)	関数	タスク関数または`series()`と`parallel()`によって生成された複合タスク。理想的には名前付き関数。 タスクメタデータを添付して、コマンドラインに追加情報を提供できます。

戻り値

タスクを登録する場合、何も返されません。

タスクを取得する場合、`taskName`として登録されたラップされたタスク（元の関数ではありません）が返されます。ラップされたタスクには、元の関数を返す`unwrap()`メソッドがあります。

エラー

`taskName`が欠落しており、`taskFunction`が匿名であるタスクを登録すると、「タスク名を指定する必要があります」というメッセージのエラーがスローされます。

タスクメタデータ

プロパティ	型	備考
名前	文字列	名前付き関数の特別なプロパティ。タスクの登録に使用されます。 **注意:** `name`は書き込み不可です。設定または変更できません。
displayName	文字列	`taskFunction`に添付すると、タスクのエイリアスが作成されます。関数名に使用できない文字を使用する場合は、このプロパティを使用します。
description	文字列	`taskFunction`に添付すると、タスクを一覧表示する際にコマンドラインによって出力される説明が提供されます。
flags	オブジェクト	`taskFunction`に添付すると、タスクを一覧表示する際にコマンドラインによって出力されるフラグが提供されます。オブジェクトのキーはフラグを表し、値はその説明です。

const { task } = require('gulp');

const clean = function(cb) {

// 本文は省略

cb();

};

clean.displayName = 'clean:all';

task(clean);

function build(cb) {

// 本文は省略

cb();

}

build.description = 'プロジェクトをビルドする';

build.flags = { '-e': 'フラグの例' };

task(build);