Skip to content

Commit de495ee

Browse files
committed
chore: add some jsdocs
1 parent 6d8ba64 commit de495ee

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

src/generate.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@ import { config } from './config'
66
import { extract } from './extract'
77
import { checkIsolatedDeclarations, getAllTypeScriptFiles, writeToFile } from './utils'
88

9+
/**
10+
* Generate declaration files from TypeScript files.
11+
* @param options - Generation options.
12+
* @returns Promise<void>
13+
* @example ```ts
14+
* // Generate declaration files from all TypeScript files in the src directory.
15+
* const options = {
16+
* cwd: process.cwd(),
17+
* root: './src',
18+
* outdir: './dist',
19+
* clean: true,
20+
* verbose: false,
21+
* }
22+
*
23+
* await generateDeclarationsFromFiles(options)
24+
*/
925
export async function generateDeclarationsFromFiles(options?: DtsGenerationConfig): Promise<void> {
1026
try {
1127
// Check for isolatedModules setting
@@ -51,6 +67,22 @@ export async function generateDeclarationsFromFiles(options?: DtsGenerationConfi
5167
}
5268
}
5369

70+
/**
71+
* Generate TypeScript declaration files.
72+
* @param options - Generation options.
73+
* @returns Promise<void>
74+
* @example ```ts
75+
* // Generate declaration files from all TypeScript files in the src directory.
76+
* const options = {
77+
* cwd: process.cwd(),
78+
* root: './src',
79+
* outdir: './dist',
80+
* clean: true,
81+
* verbose: false,
82+
* }
83+
*
84+
* await generate(options)
85+
*/
5486
export async function generate(options?: DtsGenerationOption): Promise<void> {
5587
await generateDeclarationsFromFiles({ ...config, ...options })
5688
}

0 commit comments

Comments
 (0)