(fix): better explentations
This commit is contained in:
parent
a8fabbf0a0
commit
0e87a9df8b
4 changed files with 20 additions and 3 deletions
6
dist/index.d.ts
vendored
6
dist/index.d.ts
vendored
|
|
@ -2,7 +2,13 @@ import { type TransportClient, READY_STATE } from "@tensamin/ttp-core";
|
|||
import { createSchema } from "./schema";
|
||||
import type { z, ZodObject } from "zod";
|
||||
/**
|
||||
* @param identifier Your app's domain.
|
||||
* @param redirectUrl The URL should point to the TAuth HTTP Server at http://hostname:port/callback
|
||||
* @param frontendUrl The URL of the frontend the user interacts with. Only used in development.
|
||||
* @param appData A Zod schema defining the shape of the app data you want to load/save for each user.
|
||||
* @param saveSession A function that saves the session ID for a given user ID. This is called after a successful authentication.
|
||||
* @param httpServer Optional configuration for the TAuth HTTP Server. Defaults to { port: 7878, hostname: "localhost" }.
|
||||
* @param htmlSuccessPage Optional HTML string or path to an HTML file to be served upon successful authentication.
|
||||
*/
|
||||
export declare class TAuthClient {
|
||||
frontendUrl: string;
|
||||
|
|
|
|||
Loading…
Reference in a new issue