Skip to content

docs: modify examples for explicit-module-boundary-types #7404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 29, 2023
Merged

docs: modify examples for explicit-module-boundary-types #7404

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
557b6c7
docs : modify examples for explicit-module-boundary-types
Ryan-Dia Aug 3, 2023
8eaf4cd
docs : update examples for explicit-module-boundary-types
Ryan-Dia Aug 3, 2023
02d4b74
docs: fix atx-style
Ryan-Dia Aug 6, 2023
0e683c7
Merge branch 'typescript-eslint:main' into Ryan-Dia-patch-1
Ryan-Dia Sep 13, 2023
82081e3
docs: update code based on the request
Ryan-Dia Sep 13, 2023
b2092bc
docs: fix typo
Ryan-Dia Sep 13, 2023
e056692
Merge branch 'typescript-eslint:main' into Ryan-Dia-patch-1
Ryan-Dia Dec 19, 2023
5b6d95b
docs: change case 3 to case 1
Ryan-Dia Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,6 @@ export function test() {
return;
}

// Should indicate that a number is returned
export default function () {
return 1;
}

// Should indicate that a string is returned
export var arrowFn = () => 'test';

Expand All @@ -45,29 +40,29 @@ export class Test {
### ✅ Correct

```ts
// Function is not exported
function test() {
// A function with no return value (void)
export function test(): void {
return;
}

// A return value of type number
export var fn = function (): number {
return 1;
};

// A return value of type string
export var arrowFn = (): string => 'test';

// All arguments should be typed
export var arrowFn = (arg: string): string => `test ${arg}`;
export var arrowFn = (arg: unknown): string => `test ${arg}`;

// Class is not exported
class Test {
method() {
export class Test {
// A class method with no return value (void)
method(): void {
return;
}
}

// The function does not apply because it is not an exported function.
function test() {
return;
}
```

## Options
Expand Down