Skip to content
On this page

user

ユーザーに関する操作です。

メソッド

checkRegistrationState()

引数必須内容
emailstringメールアドレス
type
Promise<UserRegistrationState>

メールアドレスの登録状態を取得します。状態は以下の3種類です。

  • Registerd (登録済み)
  • Unverified (メールアドレス未認証)
  • Unregistered (登録なし)

使用方法

ts
  const state = await Hedgehog.user.checkRegistrationState("メールアドレス");

create()

引数必須内容
namestringユーザー名
emailstringメールアドレス
passwordstringパスワード

ユーザーを作成し、作成したユーザーへの参照を返します。

INFO

入力されたメールアドレスに確認のメールが送信され、認証され次第アカウントが使用可能になります。

使用方法

ts
const user = await Hedgehog.user.create(
  "ユーザー名",
  "メールアドレス",
  "パスワード"
);

ref()

引数必須内容
emailstringメールアドレス

メールアドレスからユーザーの参照を取得します。

使用方法

ts
  const user = await Hedgehog.user.ref("メールアドレス");

resendConfirmEmail()

引数必須内容
emailstringメールアドレス
type
Promise<UserRegistrationState>

未認証のメールアドレスに対して、再度認証メールを送信します。

使用方法

ts
  await Hedgehog.user.resendConfirmEmail("メールアドレス");

signin()

引数必須内容
emailstringメールアドレス
passwordstringパスワード

メールアドレスとパスワードを用いてサインインを行い、認証したユーザーへの参照を返します。

使用方法

ts
  const user = await Hedgehog.user.signin("ユーザー名", "パスワード");

signinWithRefreshToken()

引数必須内容
refreshTokenstringリフレッシュトークン

リフレッシュトークンを用いてサインインを行い、認証したユーザーへの参照を返します。

使用方法

ts
const user = await Hedgehog.user.signinWithRefreshToken(
  "リフレッシュトークン"
);