Users: signup()

新しくユーザを登録します。

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

構文

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

引数

  • userId: string

    ユーザの識別子です。

  • options: { [content][, tableName] }?

    オプション引数です。

    • content: any?

      初期値です。

    • tableName: string?

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

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

返値: Promise<boolean>

登録に成功したかどうかを返すプロミスです。

例外

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

解説

tableName からテーブル AbstractCredentialStore を取得後、そのテーブルの登録メソッド AbstractCredentialStore::signup() でユーザと初期値を登録します。

返値は AbstractCredentialStore::signup() の結果と同じ値です。