Skip to content

Commit

Permalink
📝 Document options argument
Browse files Browse the repository at this point in the history
  • Loading branch information
marcofugaro committed Jan 4, 2024
1 parent cd90d9f commit f1e80a2
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,20 @@ browserslistToEsbuild(['>0.2%', 'not dead', 'not op_mini all'])

## API

### browserslistToEsbuild(browserslistConfig?)
### browserslistToEsbuild(browserslistConfig?, options?)

#### browserslistConfig

Type: `array | string | undefined`

An array of string of browsers [compatible with browserslist](https://github.com/browserslist/browserslist#full-list). If none is passed, a browserslist config is searched in the script running directory.

#### options

Type: `object | undefined`

An object containing the options that will be forwarded to browserslist. You can check out the [browserslist options documentation](https://github.com/browserslist/browserslist?tab=readme-ov-file#js-api) to see all the options available.

## CLI

You can also use this package on the cli to test out the command in your project.
Expand Down

0 comments on commit f1e80a2

Please sign in to comment.