are we there yet are we there yetソースコードのダウンロード

are we there yet

その他のソースコード

v4.0.2

ダウンロード

まだそこにいるの

非同期タスクの完了ステータスの複雑な階層を追跡します。これは、非同期でよく見られる大規模な再帰的ファンアウトおよび収集タイプのワークフローの進行状況を記録およびレポートする方法を提供することを目的としています。

この完了データをどうするかはあなた次第ですが、最も一般的な使用例は、それを多くのプログレスバーモジュールの 1 つにフィードすることです。

ほとんどのプログレスバーモジュールにはこれの初歩的なバージョンが含まれていますが、私のニーズはより複雑でした。

使用法

 var TrackerGroup = require ( "are-we-there-yet" ) . TrackerGroup

var top = new TrackerGroup ( "program" )

var single = top . newItem ( "one thing" , 100 )
single . completeWork ( 20 )

console . log ( top . completed ( ) ) // 0.2

fs . stat ( "file" , function ( er , stat ) {
  if ( er ) throw er  
  var stream = top . newStream ( "file" , stat . size )
  console . log ( top . completed ( ) ) // now 0.1 as single is 50% of the job and is 20% complete
                              // and 50% * 20% == 10%
  fs . createReadStream ( "file" ) . pipe ( stream ) . on ( "data" , function ( chunk ) {
    // do stuff with chunk
  } )
  top . on ( "change" , function ( name ) {
    // called each time a chunk is read from "file"
    // top.completed() will start at 0.1 and fill up to 0.6 as the file is read
  } )
} )

共有メソッド

var completed = tracker.completed()

実装場所: Tracker 、 TrackerGroup 、 TrackerStream

完了した作業とこれから実行される作業の比率を返します。範囲は 0 ～ 1。

トラッカー.フィニッシュ()

実装場所: Tracker 、 TrackerGroup

トラッカーを完了としてマークします。 TrackerGroup を使用すると、そのすべてのコンポーネントが完了としてマークされます。

このトラッカーのすべてのコンポーネントを完了としてマークします。これは、このトラッカーのtracker.completed() 1 になることを意味します。

これにより、1 つ以上のchangeイベントが発行されます。

イベント

すべてのトラッカーオブジェクトは、次の引数を使用してchangeイベントを発行します。

 function (name, completed, tracker)

name 、最初にイベントを発行したトラッカーの名前、またはイベントを持たなかった場合は、イベントを持っていた最初の包含トラッカーグループの名前です。

completed完了率 ( tracker.completed()メソッドによって返される) です。

trackerイベントをリッスンしているトラッカーオブジェクトです。

トラッカーグループ

var tracker = 新しい TrackerGroup( name )
- name (オプション) - このトラッカーグループの名前。コンポーネントの更新に名前がなかった場合に変更通知で使用されます。デフォルトは未定義です。

新しい空のトラッカー集約グループを作成します。これらは、この集約グループに追加された他のトラッカーの完了ステータスによって完了ステータスが決定されるトラッカーです。

元。

 var tracker = new TrackerGroup ( "parent" )
var foo = tracker . newItem ( "firstChild" , 100 )
var bar = tracker . newItem ( "secondChild" , 100 )

foo . finish ( )
console . log ( tracker . completed ( ) ) // 0.5
bar . finish ( )
console . log ( tracker . completed ( ) ) // 1

tracker.addUnit( otherTracker ,重み)
- otherTracker - 他の are-we-there-yet トラッカーオブジェクトのいずれか
- 重み(オプション) - トラッカーに与える重み。デフォルトは 1 です。

otherTracker をこの集約グループに追加します。重みによって、このトラッカーが完了するまでにかかる時間が他のユニットに比例して決まります。たとえば、重み 1 のトラッカーを 1 つ追加し、重み 2 のトラッカーをもう 1 つ追加した場合、2 番目のトラッカーの完了には最初のトラッカーの 2 倍の時間がかかることになります。したがって、最初のものがこのトラッカーの完了の 33% を占め、2 つ目が残りの 67% を占めます。

otherTrackerを返します。

var subGroup = tracker.newGroup(名前,重み)

上記は次とまったく同じです。

  var subGroup = tracker . addUnit ( new TrackerGroup ( name ) , weight )

var subItem = tracker.newItem(名前, todo ,重み)

上記は次とまったく同じです。

  var subItem = tracker . addUnit ( new Tracker ( name , todo ) , weight )

var subStream = tracker.newStream(名前, todo ,重み)

上記は次とまったく同じです。

  var subStream = tracker . addUnit ( new TrackerStream ( name , todo ) , weight )

console.log( tracker.debug() )

すべての子を再帰的に入力することを含め、このトラッカーグループとそのすべての子の完了を示すツリーを返します。

トラッカー

var tracker = new Tracker( name , todo )
- name (オプション)変更イベントで報告するこのカウンターの名前。デフォルトは未定義です。
- todo (オプション) todo の作業量 (数値)。デフォルトは 0 です。

通常、これらはトラッカーグループの一部として構築されます ( newItem経由)。

var completed = tracker.completed()

完了した作業とこれから実行される作業の比率を返します。 0 ～ 1 の範囲。実行する作業の合計が 0 の場合は、0 を返します。

tracker.addWork( todo )
- todo実行する作業量に追加する数値。

実行する作業量が増加するため、完了率が低下します。 changeイベントをトリガーします。

tracker.completeWork(完了)
- completed作業完了に追加する番号

完了する作業量が増加し、完了率が向上します。 Todo の作業量を超えて完了した作業が増えることはありません。つまり、100% を超えるパーセンテージは許可されません。 changeイベントをトリガーします。

トラッカー.フィニッシュ()

このトラッカーを完了としてマークします。tracker.completed() は 1 になります。 changeイベントをトリガーします。

トラッカーストリーム

var tracker = new TrackerStream(名前,サイズ,オプション)
- name (オプション)変更イベントで報告するこのカウンターの名前。デフォルトは未定義です。
- size (オプション)このストリームを通じて送信されるバイト数。
- options (オプション)ストリームオプションのハッシュ