Skip to content

Commit

Permalink
Update index.d.ts
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus authored Oct 14, 2024
1 parent 4a146e9 commit 077ca25
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@ export type Options = {
/**
Specify customized options for each window.
The accepted function receives the window to apply the filter or new options to.
It must return one of these values:
The given function receives the window to apply the filter or new options to.
It must return one of these values:
- `true`: To enable debug with the global options for the given window.
- `false`: Disable debug for the given window (same as returning `{isEnabled: false}`).
- `Partial<Options>`: Object to override global options just for the given window. It does a shallow merge.
@default () => true
@example
```
import debug from 'electron-debug';
Expand Down

0 comments on commit 077ca25

Please sign in to comment.