Skip to content

Commit

Permalink
docs(eslint-plugin): add triple-slash-reference options schema and de…
Browse files Browse the repository at this point in the history
…faults (#5039)
  • Loading branch information
btmills committed May 23, 2022
1 parent 78d9356 commit 1012e0b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions packages/eslint-plugin/docs/rules/triple-slash-reference.md
Expand Up @@ -44,6 +44,22 @@ import * as foo from 'foo';
import foo = require('foo');
```

## Options

```ts
type Options = {
lib?: 'always' | 'never';
path?: 'always' | 'never';
types?: 'always' | 'never' | 'prefer-import';
};

const defaultOptions: Options = {
lib: 'always',
path: 'never',
types: 'prefer-import',
};
```

## When To Use It

If you want to ban use of one or all of the triple slash reference directives, or any time you might use triple-slash type reference directives and ES6 import declarations in the same file.
Expand Down

0 comments on commit 1012e0b

Please sign in to comment.