url-search-params.md

Enforce either URLSearchParams or require("url").URLSearchParams (n/prefer-global/url-search-params)

The URLSearchParams class of url module is defined as a global variable.

console.log(URLSearchParams === require("url").URLSearchParams) //→ true

It will be readable if we use either URLSearchParams consistently.

📖 Rule Details

This rule enforces which URLSearchParams we should use.

Options

This rule has a string option.

{
    "n/prefer-global/url-search-params": ["error", "always" | "never"]
}

• "always" (default) ... enforces to use the global variable URLSearchParams rather than require("url").URLSearchParams.
• "never" ... enforces to use require("url").URLSearchParams rather than the global variable URLSearchParams.

always

Examples of 👎 incorrect code for this rule:

/*eslint n/prefer-global/url-search-params: [error]*/

const { URLSearchParams } = require("url")
const u = new URLSearchParams(s)

Examples of 👍 correct code for this rule:

/*eslint n/prefer-global/url-search-params: [error]*/

const u = new URLSearchParams(s)

never

Examples of 👎 incorrect code for the "never" option:

/*eslint n/prefer-global/url-search-params: [error, never]*/

const u = new URLSearchParams(s)

Examples of 👍 correct code for the "never" option:

/*eslint n/prefer-global/url-search-params: [error, never]*/

const { URLSearchParams } = require("url")
const u = new URLSearchParams(s)

🔎 Implementation

• Rule source
• Test source