Craft Counter

const { counter } = MODULES;

Table of Contents

• get
  • Parameters
• set
  • Parameters
• increment
  • Parameters
• decrement
  • Parameters

get

Craft Counterの数値を読む

Parameters

• param Object

  • param.keys Array<string> 読み込むkeyの配列

Returns Promise<Array<number>> カウンターの値を配列として返す

set

Craft Counterに数値を書き込む

Parameters

• param Object

  • param.key string 書き込むkey
  • param.value number 書き込むvalue
  • param.secondsToExpire number? 値の有効期限(秒). デフォルトは86400(1日). 最大値は2592000(30日).

Returns Promise<{}> empty object

increment

Craft Counterの数値をインクリメントする

Parameters

• param Object

  • param.key string インクリメントするkey
  • param.changeAmount number? インクリメントする値. デフォルトは1
  • param.secondsToExpire number? 値の有効期限(秒). 空の場合は現在の有効期限を維持する. 最大値は2592000(30日).

Returns Promise<number> インクリメント後の値

decrement

Craft Counterの数値をデクリメントする

Parameters

• param Object

  • param.key string デクリメントするkey
  • param.changeAmount number? デクリメントする値. デフォルトは1
  • param.secondsToExpire number? 値の有効期限(秒). 空の場合は現在の有効期限を維持する. 最大値は2592000(30日).

Returns Promise<number> デクリメント後の値