Skip to main content

IMMe Hooks

info

全てのhooksは引数にcontextを渡すことができます。
この引数は、Providerでcontextを設定した場合に利用される事を想定しています。

useMeState​

現在のプロファイルの状態を返します。
状態が変更されるとIMMeは再レンダーを発生させます。

Returns​

Example Usage​

import { useMeState } from "@intra-mart/smartlime";
const App = () => {
  const state = useMeState();
}

useMe​

プロファイルの状態を操作するためのいくつかのFunctionを返します。

Returns​

getMe​

  • 現在のプロファイル情報を返します。。
  • useMeStateとの違いはトップレベル以外でも呼び出せる事と再レンダーが発生しない点です。
  • Returns
    • meState | null

request​

  • プロファイル情報の取得を行います。
  • Returns
    • Promise<SuccessResult | ErrorResult>

update​

  • プロファイル情報の更新を行います。
  • Returns
    • Promise<SuccessResult | ErrorResult>
tip

現在のバージョンにおいてはrequestとupdateは全く同一のものです。 将来的にupdate独自の処理を追加する可能性があるためインターフェイスが分けられています。

Example Usage​

import { useMe } from "@intra-mart/smartlime";
const App = () => {
    const  { getMe, request, update } = useMe();
}