credentials: registerTable

ユーザ管理テーブルを登録します。

構文

Credentials.registerTable(tableName, storeType, args) => void
Credentials.registerTable(tableName, storeType, args, defaultUserInfo) => void

引数

• tableName: string

  テーブル名です。

• storeType: string

  使用したいストアクラスのストア名を指定してください。フレームワークで提供されているストアクラスはストアクラスの項を参照してください。また、アプリ内では StoreClasses.available() で利用可能なストアクラスのストア名のリストを取得できます。

• args: object

  オプション引数です。ストアクラスのコンストラクタに渡されます。

• defaultUserInfo: { [info: string]: string | number | boolean | null | function }?

  デフォルトのユーザ情報です。ユーザが登録されたときにユーザ情報にこの値が設定されます。

例外

• TypeError
  • defaultUserInfo が想定された型でなかった場合。
• Error
  • tableName がすでに存在していた場合。
  • storeType が存在しない場合。

解説

defaultUserInfo のプロパティ値で関数が渡された場合、ユーザ登録時にその関数を呼び出した結果をそのプロパティの値とします。この関数は () => string | number | boolean | null となるようにしてください。