Function useAuth

Returns {
    accessToken?: string;
    accessTokenExpireAt?: string;
    changePassword: ((password, newPassword) => Promise<ResultResponse<boolean>>);
    initial: (() => Promise<void>);
    loadMe: (() => Promise<null | User>);
    loaded: boolean;
    login: ((prefix, username, password, root?) => Promise<{
        data: User;
        model?: string;
    }>);
    logout: (() => void);
    model: undefined | string;
    prefix: "";
    refreshToken?: string;
    refreshTokenExpireAt?: string;
    root: boolean;
    setUser: ((userData, data?) => void);
    signIn: ((signIn) => void);
    signedAt?: string;
    tokenType?: string;
    updateSignInDate: ((day?) => void);
    user: undefined | User;
}

• Optional accessToken?: string

• Optional accessTokenExpireAt?: string

• changePassword: ((password, newPassword) => Promise<ResultResponse<boolean>>)

  • • (password, newPassword): Promise<ResultResponse<boolean>>

    • Parameters

      • password: string

      • newPassword: string

      Returns Promise<ResultResponse<boolean>>

• initial: (() => Promise<void>)

  • • (): Promise<void>

    • Returns Promise<void>

• loadMe: (() => Promise<null | User>)

  • • (): Promise<null | User>

    • Returns Promise<null | User>

• loaded: boolean

• login: ((prefix, username, password, root?) => Promise<{
      data: User;
      model?: string;
  }>)

  로그인을 진행합니다. 직접 사용보다는 LoginForm 컴포넌트를 사용하는 것을 권장합니다.

  Param: prefix

  로그인을 진행할 API의 prefix입니다. 기본적으로 서버에서 생성됩니다.

  Param: username

  로그인할 유저의 유저명입니다.

  Param: password

  로그인할 유저의 비밀번호입니다.

  Param: root

  root 로 로그인을 했을 경우 유저의 정보입니다. root 계정의 정보는 서버가 갖고 있지 않으므로, 클라이언트에서 관리합니다.

  • • (prefix, username, password, root?): Promise<{
          data: User;
          model?: string;
      }>

    • 로그인을 진행합니다. 직접 사용보다는 LoginForm 컴포넌트를 사용하는 것을 권장합니다.

      Parameters

      • prefix: ""

        로그인을 진행할 API의 prefix입니다. 기본적으로 서버에서 생성됩니다.

      • username: string

        로그인할 유저의 유저명입니다.

      • password: string

        로그인할 유저의 비밀번호입니다.

      • Optional root: User

        root 로 로그인을 했을 경우 유저의 정보입니다. root 계정의 정보는 서버가 갖고 있지 않으므로, 클라이언트에서 관리합니다.

      Returns Promise<{
          data: User;
          model?: string;
      }>

• logout: (() => void)

  • • (): void

    • Returns void

• model: undefined | string

• prefix: ""

• Optional refreshToken?: string

• Optional refreshTokenExpireAt?: string

• root: boolean

• setUser: ((userData, data?) => void)

  유저 정보를 강제로 업데이트합니다.

  Param: userData

  유저 정보

  Param: data

  추가로 업데이트할 정보, model 등의 추가 정보를 업데이트할 수 있습니다.

  • • (userData, data?): void

    • 유저 정보를 강제로 업데이트합니다.

      Parameters

      • userData: User

        유저 정보

      • Optional data: Partial<SignInResponse>

        추가로 업데이트할 정보, model 등의 추가 정보를 업데이트할 수 있습니다.

      Returns void

• signIn: ((signIn) => void)

  • • (signIn): void

    • Parameters

      • signIn: SignInResponse

      Returns void

• Optional signedAt?: string

• Optional tokenType?: string

• updateSignInDate: ((day?) => void)

  • • (day?): void

    • Parameters

      • Optional day: Dayjs

      Returns void

• user: undefined | User