Type Alias HonoSessionKit<TPayload, TPrincipal>

Type declaration

• Readonlycore: SessionKit<TPayload, TPrincipal>

• context:function

  • context(c: Context): HttpContext

    Parameters

    • c: Context

    Returns HttpContext

• middleware:function

  • middleware(options?: SessionKitHonoAdapterOptions): MiddlewareHandler

    Parameters

    • Optionaloptions: SessionKitHonoAdapterOptions

    Returns MiddlewareHandler

• optionalAuth:function

  • optionalAuth(options?: SessionKitHonoAdapterOptions): MiddlewareHandler

    Parameters

    • Optionaloptions: SessionKitHonoAdapterOptions

    Returns MiddlewareHandler

• requireAuth:function

  • requireAuth(
        requireAuthOptions?: RequireAuthOptions,
        options?: SessionKitHonoAdapterOptions,
    ): MiddlewareHandler

    Parameters

    • OptionalrequireAuthOptions: RequireAuthOptions
    • Optionaloptions: SessionKitHonoAdapterOptions

    Returns MiddlewareHandler

• signIn:function

  • signIn(
        c: Context,
        payload: TPayload,
        options?: SignInOptions,
    ): Promise<SignInResult<TPrincipal>>

    Parameters

    • c: Context
    • payload: TPayload
    • Optionaloptions: SignInOptions

    Returns Promise<SignInResult<TPrincipal>>

• signOut:function

  • signOut(c: Context, options?: SignOutOptions): Promise<void>

    Parameters

    • c: Context
    • Optionaloptions: SignOutOptions

    Returns Promise<void>

• getAuth:function

  • getAuth(c: Context): AuthContext<TPayload, TPrincipal>

    Parameters

    • c: Context

    Returns AuthContext<TPayload, TPrincipal>