Skip to content

Commit

Permalink
docs: Fix doc comment in deno lib
Browse files Browse the repository at this point in the history
  • Loading branch information
pklaschka committed Dec 14, 2023
1 parent 8ab1f40 commit 7c95129
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions backend-deno/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export type StartServiceConfig = z.infer<typeof StartServiceConfigSchema>;
* @throws If the service couldn't be started.
*
* @example
* ```ts
* import {startService, JSONCodec} from "./lib.ts";
*
* const {nc, serviceName} = await startService();
Expand All @@ -45,6 +46,7 @@ export type StartServiceConfig = z.infer<typeof StartServiceConfigSchema>;
* console.log("Message published!");
*
* await nc.drain();
* ```
*/
export async function startService(
rawOptions: StartServiceConfig = StartServiceConfigSchema.parse({}),
Expand Down

0 comments on commit 7c95129

Please sign in to comment.