Skip to content

Commit 31c72bb

Browse files
committed
chore: adjust readme
1 parent b156264 commit 31c72bb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
- Fast .d.ts generation _(via isolatedDeclaration)_
1212
- Highly configurable
13+
- Lightweight library
1314
- Cross-platform binary
14-
- Lightweight & dependency-free library
1515

1616
## Install
1717

@@ -39,19 +39,19 @@ Given the npm package is installed, you can use the `generate` function to gener
3939
### Usage
4040

4141
```ts
42+
import type { DtsGenerationOptions } from '@stacksjs/dtsx'
4243
import { generate } from '@stacksjs/dtsx'
4344

44-
interface Options {
45-
cwd?: string // default: process.cwd()
46-
root?: string // default: './src'
47-
entrypoints?: string[] // default: ['**/*.ts']
48-
outdir?: string // default: './dist'
49-
keepComments?: boolean // default: true
50-
clean?: boolean // default: false
51-
tsconfigPath?: string // default: './tsconfig.json'
45+
const options: DtsGenerationOptions = {
46+
cwd: './', // default: process.cwd()
47+
root: './src', // default: './src'
48+
entrypoints: ['**/*.ts'], // default: ['**/*.ts']
49+
outdir: './dist', // default: './dist'
50+
keepComments: true, // default: true
51+
clean: true, // default: false
5252
}
5353

54-
await generate(options?: Options)
54+
await generate(options)
5555
```
5656

5757
_Available options:_

0 commit comments

Comments
 (0)