Skip to content

Commit

Permalink
docs: replace RuntimeOptions by RuntimeFileOptions runASTAnalysisOnFi…
Browse files Browse the repository at this point in the history
…le description
  • Loading branch information
jean-michelet committed Jan 31, 2024
1 parent 341b27c commit 98d4797
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ This section describe all the possible warnings returned by JSXRay. Click on the
| [shady-link](./docs/shady-link.md) | ✔️ | The code contains shady/unsafe link |

## API

<details>
<summary>runASTAnalysis(str: string, options?: RuntimeOptions): Report</summary>

Expand Down Expand Up @@ -165,10 +164,10 @@ interface Report {
<summary>runASTAnalysisOnFile(pathToFile: string, options?: RuntimeFileOptions): Promise< ReportOnFile ></summary>

```ts
interface RuntimeOptions {
interface RuntimeFileOptions {
module?: boolean;
isMinified?: boolean;
removeHTMLComments?: boolean;
packageName?: string;
}
```

Expand Down

0 comments on commit 98d4797

Please sign in to comment.