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

This commit is contained in:
2026-03-15 00:23:19 +05:30
parent c3ee31a565
commit c76c8d2788
3 changed files with 20 additions and 11 deletions

View File

@@ -3,6 +3,11 @@ import { createRuntimeApp, type RuntimeBkndConfig } from "bknd/adapter";
export type SolidStartEnv = NodeJS.ProcessEnv;
export type SolidStartBkndConfig<Env = SolidStartEnv> = RuntimeBkndConfig<Env>;
/**
* Get bknd app instance
* @param config - bknd configuration
* @param args - environment variables
*/
export async function getApp<Env = SolidStartEnv>(
config: SolidStartBkndConfig<Env>,
args: Env = process.env as Env,
@@ -10,7 +15,11 @@ export async function getApp<Env = SolidStartEnv>(
return await createRuntimeApp(config, args);
}
/**
* Create middleware handler for Solid Start
* @param config - bknd configuration
* @param args - environment variables
*/
export function serve<Env = SolidStartEnv>(
config: SolidStartBkndConfig<Env> = {},
args: Env = process.env as Env,