Skip to content

Commit

Permalink
chore: adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbbreuer committed Oct 19, 2024
1 parent b156264 commit 31c72bb
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

- Fast .d.ts generation _(via isolatedDeclaration)_
- Highly configurable
- Lightweight library
- Cross-platform binary
- Lightweight & dependency-free library

## Install

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

```ts
import type { DtsGenerationOptions } from '@stacksjs/dtsx'
import { generate } from '@stacksjs/dtsx'

interface Options {
cwd?: string // default: process.cwd()
root?: string // default: './src'
entrypoints?: string[] // default: ['**/*.ts']
outdir?: string // default: './dist'
keepComments?: boolean // default: true
clean?: boolean // default: false
tsconfigPath?: string // default: './tsconfig.json'
const options: DtsGenerationOptions = {
cwd: './', // default: process.cwd()
root: './src', // default: './src'
entrypoints: ['**/*.ts'], // default: ['**/*.ts']
outdir: './dist', // default: './dist'
keepComments: true, // default: true
clean: true, // default: false
}

await generate(options?: Options)
await generate(options)
```

_Available options:_
Expand Down

0 comments on commit 31c72bb

Please sign in to comment.