API · オブザーバブル

riot.observable(el)

与えられたオブジェクトelObserver機能を付加するか、引数をとらない場合は新しいオブジェクトを生成して返します。この後、オブジェクトはイベントのトリガーおよび監視ができるようになります。例:

function Car() {

  // Carインスタンスを監視できるようにする
  riot.observable(this)

  // 'start'イベントの監視を始める
  this.on('start', function() {
    // エンジン、スタート
  })

}

// 新しいCarインスタンスを作る
var car = new Car()

// 'start'イベントを発火
car.trigger('start')

@returns 与えられたelオブジェクト、または新しいobservableインスタンス

el.on(events, callback)

与えられたイベントを監視して、イベントがトリガーされるごとにcallbackを実行します。

// ひとつのイベントを監視
el.on('start', function(args) {

})

// すべてのイベントを監視
el.on('all', function(event, param1, param2) {
  // eventはイベントの名前
  // パラメータによってここで何かをする
})

@returns el

el.one(events, callback)

一度だけ、与えられたeventsを監視し、callbackを実行します。

// 'start'が何回発火されても、一度だけ実行する
el.one('start', function() {

})

@returns el

el.off(events)

指定されたイベントのリスナ(コールバック)を削除します。

el.off('start')

@returns el

el.off(events, fn)

指定されたイベントについて、特定のリスナfnを削除します。

function doIt() {
  console.log('starting or ending')
}

el.on('start', doIt)

// 特定のリスナを削除
el.off('start', doIt)

@returns el

el.off(‘*’)

すべてのイベントのすべてのリスナを削除します。

@returns el

el.off(‘*’, fn)

すべてのイベントの特定のコールバック関数を削除します。

@returns el

el.trigger(events)

eventsを監視しているすべてのコールバック関数を実行します。

el.trigger('start')
el.trigger('render')

@returns el

el.trigger(event, arg1 … argN)

eventを監視しているすべてのコールバック関数を実行します。任意の数の引数をリスナに渡すことができます。

// startイベントを監視して、引数を待ち受け
el.on('start', function(engine_details, is_rainy_day) {

})

// 引数とともに、startイベントをトリガー
el.trigger('start', { fuel: 89 }, true)

@returns el