fetchMethodBodies
Disallow providing a body with GET or HEAD fetch requests.
✅ This rule is included in the tslogicalandlogicalStrictpresets.
The Fetch API throws a TypeError at runtime when the request method is GET or HEAD and a body is provided.
This rule detects fetch() calls and new Request() calls that provide a body with a GET or HEAD method.
HTTP methods GET and HEAD are intended to retrieve data without sending a request body.
Per the Fetch specification, providing a body with these methods is invalid and will cause the browser or runtime to throw an error.
Examples
Section titled “Examples”const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
RequestInit.method?: string
A string to set request's method.
method: "GET", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
RequestInit.method?: string
A string to set request's method.
method: "HEAD", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const request: Request
var Request: new (input: RequestInfo | URL, init?: RequestInit) => Request
The Request interface of the Fetch API represents a resource request.
Request("/api", { RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const request: Request
var Request: new (input: RequestInfo | URL, init?: RequestInit) => Request
The Request interface of the Fetch API represents a resource request.
Request("/api", { RequestInit.method?: string
A string to set request's method.
method: "GET", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
RequestInit.method?: string
A string to set request's method.
method: "POST", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const response: Response
function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)
RequestInit.method?: string
A string to set request's method.
method: "PUT", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });const const request: Request
var Request: new (input: RequestInfo | URL, init?: RequestInit) => Request
The Request interface of the Fetch API represents a resource request.
Request("/api", { RequestInit.method?: string
A string to set request's method.
method: "POST", RequestInit.body?: BodyInit | null
A BodyInit object or null to set request's body.
body: "data" });Options
Section titled “Options”This rule is not configurable.
When Not To Use It
Section titled “When Not To Use It”If your codebase uses a custom fetch wrapper or polyfill that accepts different options, this rule might produce false positives.
You can disable it for files that use such wrappers.
Further Reading
Section titled “Further Reading”Equivalents in Other Linters
Section titled “Equivalents in Other Linters”- ESLint:
unicorn/no-invalid-fetch-options - Oxlint:
unicorn/no-invalid-fetch-options