mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 04:27:21 +00:00
docs(solid-start): add JSDoc comments to adapter functions
This commit is contained in:
@@ -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,
|
||||
|
||||
Reference in New Issue
Block a user