Craft Key-Value Store

const { kvs } = MODULES;

Table of Contents

• Schemas
  • KeyValueStoreValue
    • Properties
  • KeyValueStoreRet
• Methods
  • get
    • Parameters
  • list
    • Parameters
  • write
    • Parameters
  • checkAndWrite
    • Parameters
  • delete
    • Parameters

Schemas

KeyValueStoreValue

Type: Object

Properties

• created_at string created_at
• expired_at string 値の有効期限
• value object 値

KeyValueStoreRet

Type: Object<string, KeyValueStoreValue>

Methods

get

Craft Key-Value Store から値を取得する

Parameters

• param object

  • param.key string 取得する key (deprecated, use keys instead)
  • param.keys Array<string> 取得する key の配列（複数取得、最大 100 件。重複するキーは自動的に除去される）

Returns Promise<KeyValueStoreRet> 単一の場合は{key: value}、複数の場合は各 key の結果（存在しないキーは null）

list

Craft Key-Value Store から複数の値を取得する

Parameters

• param object (optional, default {startKey:null,stopKey:null,startCursor:null,pageSize:10})

  • param.startCursor string 取得する cursor の開始位置
  • param.pageSize number 取得する件数。最大 30 件
  • param.stopKey string 取得する key の終了位置
  • param.startKey string 取得する key の開始位置

Returns Promise<{item: KeyValueStoreRet, endCursor: string, isMoreResults: boolean}>

write

Craft Key-Value Store に値を書き込む

Parameters

• param object

  • param.key string 書き込む key
  • param.value string 書き込む value
  • param.minutesToExpire number? 値の有効期限(分)

Returns Promise<object> empty object

checkAndWrite

Craft Key-Value Store にチェックに合致した値を書き込む

Parameters

• param object

  • param.key string 書き込む key
  • param.value string 書き込む value
  • param.operator string < > = <= >=のいずれか
  • param.unixtimeMs number 比較対象の unixtime(ms)
  • param.minutesToExpire number? 値の有効期限(分)

Returns Promise<object> empty object

delete

Craft Key-Value Store から値を削除する

Parameters

• param object

  • param.key string 削除する key

Returns Promise<object> empty object