Skip to content

Commit 09d01b7

Browse files
committed
docs: symbol docs
1 parent 5e3a147 commit 09d01b7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/index.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,23 @@ import { resolveOptions } from './options.js';
22
import { run } from './tasks/runner.js';
33
import type { Options } from './types/options.js';
44

5+
/**
6+
* Runs the `pubm` function with the provided options.
7+
*
8+
* This function executes the publish process using the specified options.
9+
* The `version` field in the `options` parameter is required for the function
10+
* to run correctly.
11+
*
12+
* @async
13+
* @function
14+
*/
515
export async function pubm(options: Options) {
616
const resolvedOptions = resolveOptions({ ...options });
717

818
await run(resolvedOptions);
919
}
20+
21+
/**
22+
* Options for configuring the {@linkcode pubm} function.
23+
*/
24+
export type { Options } from './types/options.js';

0 commit comments

Comments
 (0)