Users: setUserInfo()

ユーザ情報を設定します。

この関数は非同期関数です。

構文

Users.setUserInfo(userId, userInfo) => Promise<boolean>
Users.setUserInfo(userId, userInfo, options) => Promise<boolean>

引数

  • userId: string

    ユーザの識別子です。

  • userInfo: { [info: string]: string | number | boolean }

    設定するユーザ情報です。

  • options: { [tableName] }?

    オプション引数です。

    • tableName: string?

      registerTable() で登録されたテーブル名です。

      • 既定では最初に登録されたテーブルが使用されます。

返値: Promise<boolean>

ユーザ情報の設定に成功したかどうかを返すプロミスです。

例外

  • TypeError
    • userId が文字列以外だった場合。

解説

ユーザ情報を userInfo で指定されたキーの値で更新します。新しいキーは追加されません。