Skip to content

Commit fb2625d

Browse files
committed
chore(cli): export defaultConfigFile + add JSDoc
1 parent 82d9318 commit fb2625d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/node/cli.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,17 @@ export async function setDefaults(cliArgs: Args, configArgs?: ConfigArgs): Promi
502502
} as DefaultedArgs // TODO: Technically no guarantee this is fulfilled.
503503
}
504504

505-
async function defaultConfigFile(): Promise<string> {
505+
/**
506+
* Helper function to return the default config file.
507+
*
508+
* @returns The default config file:
509+
*
510+
* - bind-addr: 127.0.0.1:8080
511+
* - auth: password
512+
* - password: <generated-password>
513+
* - cert: false
514+
*/
515+
export async function defaultConfigFile(): Promise<string> {
506516
return `bind-addr: 127.0.0.1:8080
507517
auth: password
508518
password: ${await generatePassword()}

0 commit comments

Comments
 (0)