API リファレンス

riotx.Store

import riotx from 'riotx'

const store = new riotx.Store({ ...options })

riotx.Store constructor

  • state

    • Type: Object ステートオブジェクト 詳細

  • mutations

    • Type: { [String: name]: Function (context, data) return Array[String] }
    • Description: ストアにミューテーションを登録

    • 詳細

    • Arguments

      • context
        • Type: Object
        • Description: Riotxが提供するコンテキスト情報
        • context.state
        • context.getter
          • Type: Function
          • Description: store.getter ショートカット getter関数をつかって、ミューテーションで必要なデータを取得することができる
      • data
    • Return
      • Type: Array
      • Description: ステートの変更を通知するトリガー名を配列で返却 トリガーはコミット完了後に自動で発火

  • actions

    • Type: { [String: name]: Function (Object: context, Object: data) return Promise }
    • Description: ストアにアクションを登録
    • 詳細
    • Arguments
      • context
        • Type: Object
        • Description: Riotxが提供するコンテキスト情報
        • context.commit
        • context.getter
          • Type: Function
          • Description: store.getter ショートカット getter関数をつかって、アクションで必要なデータを取得することができる
      • data
    • Return
      • Type: Promise
      • Description: 連続してのアクション操作や例外処理に使える

  • getters

    • Type: { [String: name]: Function (Object: context, Object: data) return * }
    • Description: ストアにゲッターを登録
    • 詳細
    • Arguments
      • context
        • Type: Object
        • Description: Riotxが提供するコンテキスト情報
        • context.state
        • context.getter
          • Type: Function
          • Description: store.getter ショートカット getter関数をつかって、ゲッターで必要なデータを取得
      • data
        • Type: Object
        • Description: ゲッターに渡したいデータ
    • Return
      • Type: *
      • Description: フィルターした結果を返却

  • plugins

riotx.Store properties

riotx.Store methods

  • reset

    • Type: Function
    • Description: ストアをリセット 内部の参照をすべて切断したりなど、メモリ解放の手助けを行う 厳格モードを使用すると、操作することができなくなります。

  • getter 詳細

    • Type: Function (String: name, Object: data) return *

    • Description: getterを呼び出します。

    • Arguments

  • commit 詳細

  • action 詳細

    • Type: Function (String: name, Object: data) return Promise

    • Description: アクションを呼び出す

    • Arguments

  • change 詳細

    • Type: String: name, Function (state, store)

    • Description: ステートの変更監視を行う

    • Arguments

      • name
        • Type: String
        • Description: トリガー名 ステート - 変更を監視して取得 を参照
      • Function
        • Type: Function
        • Description: 指定したトリガーが発火した際に呼ばれる
        • state
        • store
          • Type: riotx.Store
          • Description: riotx.Store 情報

riotx

import riotx from 'riotx'

riotx properties

  • version

    • Type: String
    • Description: Riotxのバージョン情報

  • Store

    • Type: Class
    • Description: riotx.Store クラス

  • stores

    • Type: { [String: name]: riotx.Store }
    • Description: riotxが管理している ストア データ

riotx methods

  • setChangeBindName 詳細

    • Type: Function (String: name)
    • Default: riotxChange
    • Description: riotカスタムタグでの、ステートの変更監視の関数名を設定
    • TIPS: riotカスタムタグで、this.change を拡張していない場合は、changeに変更するとriotx.Store.changeと同じになり実装が楽になります。

  • add

    • Type: Function (riotx.Store: store)
    • Description: ストア 登録 プラグイン のロードは、このタイミングで行われます。

  • get

    • Type: Function (String: name) return riotx.Store

    • Description: ストア 取得

    • Arguments

    • name
      • Type: String
      • Default: @
      • Description: ストア 名

  • debug

    • Type: Boolean
    • Default: false
    • Description: riotx のデバッグログをコンソールに出力

  • strict 詳細 Experimental

    • Type: Boolean
    • Default: false
    • Description: 厳格モードで動作

  • logger

    • Type: Function (type, ...args)
    • Default: _output
    • Description: ログ出力関数を上書きできます。

  • reset

    • Type: Function
    • Description: riotx.storesで管理しているすべてのストアをリセット

  • size

    • Type: int
    • Description: riotx.storesで管理しているすべてのストアの件数を取得

results matching ""

    No results matching ""