Skip to content

Commit

Permalink
docs: symbol docs
Browse files Browse the repository at this point in the history
  • Loading branch information
syi0808 committed Oct 16, 2024
1 parent 5e3a147 commit 09d01b7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@ import { resolveOptions } from './options.js';
import { run } from './tasks/runner.js';
import type { Options } from './types/options.js';

/**
* Runs the `pubm` function with the provided options.
*
* This function executes the publish process using the specified options.
* The `version` field in the `options` parameter is required for the function
* to run correctly.
*
* @async
* @function
*/
export async function pubm(options: Options) {
const resolvedOptions = resolveOptions({ ...options });

await run(resolvedOptions);
}

/**
* Options for configuring the {@linkcode pubm} function.
*/
export type { Options } from './types/options.js';

0 comments on commit 09d01b7

Please sign in to comment.