shishantbiswas/bknd
1
0
Fork 0
mirror of https://github.com/shishantbiswas/bknd.git synced 2026-03-15 20:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(tanstack-start): add JSDoc comments to adapter functions

Browse Source
This commit is contained in:
Shishant Biswas
2026-02-12 16:44:25 +05:30
parent 01483b912f
commit 51237f5e1a
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
app/src/adapter/tanstack-start/tanstack-start.adapter.ts
View File

@@ -5,15 +5,25 @@ export type TanstackStartEnv = NodeJS.ProcessEnv;
export type TanstackStartConfig<Env = TanstackStartEnv> = export type TanstackStartConfig<Env = TanstackStartEnv> =
FrameworkBkndConfig<Env>; FrameworkBkndConfig<Env>;
/**
* Get bknd app instance
* @param config - bknd configuration
* @param args - environment variables
*/
export async function getApp<Env = TanstackStartEnv>( export async function getApp<Env = TanstackStartEnv>(
config: TanstackStartConfig<Env>, config: TanstackStartConfig<Env> = {},
args: Env = process.env as Env, args: Env = process.env as Env,
) { ) {
return await createFrameworkApp(config, args); return await createFrameworkApp(config, args);
} }
/**
* Create request handler for src/routes/api.$.ts
* @param config - bknd configuration
* @param args - environment variables
*/
export function serve<Env = TanstackStartEnv>( export function serve<Env = TanstackStartEnv>(
{ ...config }: TanstackStartConfig<Env> = {}, config: TanstackStartConfig<Env> = {},
args: Env = process.env as Env, args: Env = process.env as Env,
) { ) {
return async (request: Request) => { return async (request: Request) => {