API Docs for:
Show:

Operation Class

Defined in: lib/operation.js:5

更新時に、既に保存されている値に対して操作を行うオペレータを扱うモジュールです。(set, getは更新時以外も利用可能。)

DataStore, User, Role, Installation クラスから呼び出し、それぞれのプロトタイプメソッドとして利用します。

Constructor

Operation

()

Defined in lib/operation.js:5

Item Index

Methods

add

(
  • key
  • objects
)

Defined in lib/operation.js:72

更新時に、指定したキーの配列末尾にオブジェクトを追加する設定をします。 objectsは単一オブジェクトおよび配列での複数指定が共に可能。 複数回実行することで、objects末尾にさらにオブジェクトを追加することも可能。

Parameters:

  • key String

    処理を設定したいキー

  • objects Object

    更新時に配列に追加する値もしくは値の配列

Returns:

this

addUnique

(
  • key
  • objects
)

更新時に、指定したキーの配列末尾に、重複したデータを避けてオブジェクトを追加する設定をします。 objectsは単一オブジェクトおよび配列での複数指定が共に可能。 複数回実行することで、objects末尾にさらにオブジェクトを追加することも可能。

Parameters:

  • key String

    処理を設定したいキー

  • objects Object

    配列に追加する値もしくは値の配列。既にobjectsにある値を追加しようとした場合エラーが返る

Returns:

this

get

(
  • key
)

Defined in lib/operation.js:22

指定したキー設定されている値を取得します。

Parameters:

  • key String

    値を取得したいキー

Returns:

this[key] keyに対応する値

remove

(
  • key
  • objects
)

更新時に、指定したキーの配列からオブジェクトを削除する設定をします。 objectsは単一オブジェクトおよび配列での複数指定が共に可能。 複数回実行することで、objects末尾にさらにオブジェクトを追加することも可能。

Parameters:

  • key String

    処理を設定したいキー

  • objects Object

    配列から削除する値もしくは値の配列

Returns:

this

set

(
  • key
  • value
)

Defined in lib/operation.js:34

指定したキーに値を設定します。

Parameters:

  • key String

    値を設定したいキー

  • value Object

    キーに設定する値

Returns:

this

setIncrement

(
  • key
  • amount
)

Defined in lib/operation.js:49

更新時に、指定したキーの値を指定分だけ増加させる設定をします。

Parameters:

  • key String

    処理を設定したいキー

  • amount Number

    更新時の増加量。省略可能で、その場合は1が設定される

Returns:

this