Skip to content

docs(eslint-plugin): [prefer-readonly-parameter-types] fix broken code samples #8135

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
JoshuaKGoldberg merged 2 commits into from
Dec 26, 2023
Merged

docs(eslint-plugin): [prefer-readonly-parameter-types] fix broken code samples #8135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1b1703
docs(eslint-plugin): [prefer-readonly-parameter-types] fix broken cod…
auvred Dec 26, 2023
886e147
auvred Dec 26, 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
13 changes: 8 additions & 5 deletions packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ interface Foo {
interface Foo {
new (arg: string[]): void;
}
const x = { foo(arg: string[]): void; };
const x = { foo(arg: string[]): void {} };
function foo(arg: string[]);
type Foo = (arg: string[]) => void;
interface Foo {
Expand Down Expand Up @@ -91,7 +91,7 @@ interface CustomFunction {
}
function custom2(arg: CustomFunction) {}

function union(arg: readonly string[] | ReadonlyArray<number[]>) {}
function union(arg: readonly string[] | ReadonlyArray<number>) {}

function primitive1(arg: string) {}
function primitive2(arg: number) {}
Expand All @@ -105,8 +105,11 @@ function primitive9(arg: string | number | undefined) {}

function fnSig(arg: () => void) {}

enum Foo { a, b }
function enum(arg: Foo) {}
enum Foo {
a,
b,
}
function enumArg(arg: Foo) {}

function symb1(arg: symbol) {}
const customSymbol = Symbol('a');
Expand All @@ -119,7 +122,7 @@ interface Foo {
interface Foo {
new (arg: readonly string[]): void;
}
const x = { foo(arg: readonly string[]): void; };
const x = { foo(arg: readonly string[]): void {} };
function foo(arg: readonly string[]);
type Foo = (arg: readonly string[]) => void;
interface Foo {
Expand Down