From c76c8d27889c323ca041a04a37a99957d26d2c44 Mon Sep 17 00:00:00 2001 From: Shishant Biswas Date: Sun, 15 Mar 2026 00:23:19 +0530 Subject: [PATCH] docs(solid-start): add JSDoc comments to adapter functions --- .../adapter/solid-start/solid-start.adapter.ts | 11 ++++++++++- examples/solid/src/routes/index.tsx | 18 +++++++++--------- examples/solid/src/routes/user.tsx | 2 +- 3 files changed, 20 insertions(+), 11 deletions(-) diff --git a/app/src/adapter/solid-start/solid-start.adapter.ts b/app/src/adapter/solid-start/solid-start.adapter.ts index 37c6fe1..8ada7f6 100644 --- a/app/src/adapter/solid-start/solid-start.adapter.ts +++ b/app/src/adapter/solid-start/solid-start.adapter.ts @@ -3,6 +3,11 @@ import { createRuntimeApp, type RuntimeBkndConfig } from "bknd/adapter"; export type SolidStartEnv = NodeJS.ProcessEnv; export type SolidStartBkndConfig = RuntimeBkndConfig; +/** + * Get bknd app instance + * @param config - bknd configuration + * @param args - environment variables + */ export async function getApp( config: SolidStartBkndConfig, args: Env = process.env as Env, @@ -10,7 +15,11 @@ export async function getApp( return await createRuntimeApp(config, args); } - +/** + * Create middleware handler for Solid Start + * @param config - bknd configuration + * @param args - environment variables + */ export function serve( config: SolidStartBkndConfig = {}, args: Env = process.env as Env, diff --git a/examples/solid/src/routes/index.tsx b/examples/solid/src/routes/index.tsx index 3423bf0..b83a991 100644 --- a/examples/solid/src/routes/index.tsx +++ b/examples/solid/src/routes/index.tsx @@ -1,5 +1,5 @@ import type { DB } from "bknd"; -import { Suspense } from "solid-js"; +import { For, Suspense } from "solid-js"; import { Footer } from "~/components/Footer"; import { List } from "~/components/List"; import { getApi } from "~/lib/bknd"; @@ -58,9 +58,9 @@ export default function Home() { return (
-
+
Solid Start logo @@ -86,15 +86,14 @@ export default function Home() {
)}
- {data()?.todos?. - splice(0, data()?.limit ?? 0) - .map((todo) => ( + + {(todo) => (
{ await updateTodo(todo); }} @@ -113,7 +112,8 @@ export default function Home() { ❌
- ))} + )} +