Package Health Score

95 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
4.11.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.10.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.59.0	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.21.3	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.22.2	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

GPL-2.0-or-later

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (76,553)

GitHub Stars: 10.46K
Forks: 4.17K
Contributors: 390

Direct Usage Popularity

The npm package @wordpress/url receives a total of 76,553 downloads a week. As such, we scored @wordpress/url popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @wordpress/url, we found that it has been starred 10,455 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 390
Funding: No

A good and healthy external contribution signal for @wordpress/url project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 6.13K
Open PR: 1.29K
Last Release: 9 days ago
Last Commit: 23 days ago

Further analysis of the maintenance status of @wordpress/url based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @wordpress/url demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.12.0

Age: 7 years
Dependencies: 2 Direct
Versions: 178
Install Size: 320 kB
Dist-tags: 14
# of Files: 215
Maintainers: 23
TS Typings: Yes

@wordpress/url has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @wordpress/url?

To help you get started, we've collected the most common ways that @wordpress/url is being used within popular public projects.

google / site-kit-wp / tests / e2e / config / bootstrap.js View on Github

function observeRestRequest( req ) {
	if ( req.url().match( 'wp-json' ) ) {
		// eslint-disable-next-line no-console
		console.log( '>>>', req.method(), req.url(), req.postData() );
	}
	if ( req.url().match( 'google-site-kit/v1/data/' ) ) {
		const rawBatchRequest = getQueryArg( req.url(), 'request' );
		try {
			const batchRequests = JSON.parse( rawBatchRequest );
			if ( Array.isArray( batchRequests ) ) {
				batchRequests.forEach( ( r ) => {
					// eslint-disable-next-line no-console
					console.log( '>>>', r.key, r.data );
				} );
			}
		} catch {}
	}
}

View more ways to use @wordpress/url

URL

A collection of utilities to manipulate URLs.

Installation

Install the module

npm install @wordpress/url --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

Usage

addQueryArgs

Appends arguments as querystring to the provided URL. If the URL already includes query arguments, the arguments are merged with (and take precedent over) the existing set.

Usage

const newURL = addQueryArgs( 'https://google.com', { q: 'test' } ); // https://google.com/?q=test

Parameters

url [string]: URL to which arguments should be appended. If omitted, only the resulting querystring is returned.
args [Object]: Query arguments to apply to URL.

Returns

string: URL with arguments applied.

buildQueryString

Generates URL-encoded query string using input query data.

It is intended to behave equivalent as PHP's http_build_query, configured with encoding type PHP_QUERY_RFC3986 (spaces as %20).

Usage

const queryString = buildQueryString( {
	simple: 'is ok',
	arrays: [ 'are', 'fine', 'too' ],
	objects: {
		evenNested: {
			ok: 'yes',
		},
	},
} );
// "simple=is%20ok&amp;arrays%5B0%5D=are&amp;arrays%5B1%5D=fine&amp;arrays%5B2%5D=too&amp;objects%5BevenNested%5D%5Bok%5D=yes"

Parameters

data Record: Data to encode.

Returns

string: Query string.

cleanForSlug

Performs some basic cleanup of a string for use as a post slug.

This replicates some of what sanitize_title() does in WordPress core, but is only designed to approximate what the slug will be.

Converts Latin-1 Supplement and Latin Extended-A letters to basic Latin letters. Removes combining diacritical marks. Converts whitespace, periods, and forward slashes to hyphens. Removes any remaining non-word characters except hyphens. Converts remaining string to lowercase. It does not account for octets, HTML entities, or other encoded characters.

Parameters

string string: Title or slug to be processed.

Returns

string: Processed string.

filterURLForDisplay

Returns a URL for display.

Usage

const displayUrl = filterURLForDisplay(
	'https://www.wordpress.org/gutenberg/'
); // wordpress.org/gutenberg
const imageUrl = filterURLForDisplay(
	'https://www.wordpress.org/wp-content/uploads/img.png',
	20
); // …ent/uploads/img.png

Parameters

url string: Original URL.
maxLength number|null: URL length.

Returns

string: Displayed URL.

getAuthority

Returns the authority part of the URL.

Usage

const authority1 = getAuthority( 'https://wordpress.org/help/' ); // 'wordpress.org'
const authority2 = getAuthority( 'https://localhost:8080/test/' ); // 'localhost:8080'

Parameters

url string: The full URL.

Returns

string|void: The authority part of the URL.

getFilename

Returns the filename part of the URL.

Usage

const filename1 = getFilename( 'https://localhost:8080/this/is/a/test.jpg' ); // 'test.jpg'
const filename2 = getFilename( '/this/is/a/test.png' ); // 'test.png'

Parameters

url string: The full URL.

Returns

string|void: The filename part of the URL.

getFragment

Returns the fragment part of the URL.

Usage

const fragment1 = getFragment(
	'https://localhost:8080/this/is/a/test?query=true#fragment'
); // '#fragment'
const fragment2 = getFragment(
	'https://wordpress.org#another-fragment?query=true'
); // '#another-fragment'

Parameters

url string: The full URL

Returns

string|void: The fragment part of the URL.

getPath

Returns the path part of the URL.

Usage

const path1 = getPath( 'https://localhost:8080/this/is/a/test?query=true' ); // 'this/is/a/test'
const path2 = getPath( 'https://wordpress.org/help/faq/' ); // 'help/faq'

Parameters

url string: The full URL.

Returns

string|void: The path part of the URL.

getPathAndQueryString

Returns the path part and query string part of the URL.

Usage

const pathAndQueryString1 = getPathAndQueryString(
	'https://localhost:8080/this/is/a/test?query=true'
); // '/this/is/a/test?query=true'
const pathAndQueryString2 = getPathAndQueryString(
	'https://wordpress.org/help/faq/'
); // '/help/faq'

Parameters

url string: The full URL.

Returns

string: The path part and query string part of the URL.

getProtocol

Returns the protocol part of the URL.

Usage

const protocol1 = getProtocol( 'tel:012345678' ); // 'tel:'
const protocol2 = getProtocol( 'https://wordpress.org' ); // 'https:'

Parameters

url string: The full URL.

Returns

string|void: The protocol part of the URL.

getQueryArg

Returns a single query argument of the url

Usage

const foo = getQueryArg( 'https://wordpress.org?foo=bar&amp;bar=baz', 'foo' ); // bar

Parameters

url string: URL.
arg string: Query arg name.

Returns

QueryArgParsed|void: Query arg value.

getQueryArgs

Returns an object of query arguments of the given URL. If the given URL is invalid or has no querystring, an empty object is returned.

Usage

const foo = getQueryArgs( 'https://wordpress.org?foo=bar&amp;bar=baz' );
// { "foo": "bar", "bar": "baz" }

Parameters

url string: URL.

Returns

QueryArgs: Query args object.

getQueryString

Returns the query string part of the URL.

Usage

const queryString = getQueryString(
	'https://localhost:8080/this/is/a/test?query=true#fragment'
); // 'query=true'

Parameters

url string: The full URL.

Returns

string|void: The query string part of the URL.

hasQueryArg

Determines whether the URL contains a given query arg.

Usage

const hasBar = hasQueryArg( 'https://wordpress.org?foo=bar&amp;bar=baz', 'bar' ); // true

Parameters

url string: URL.
arg string: Query arg name.

Returns

boolean: Whether or not the URL contains the query arg.

isEmail

Determines whether the given string looks like an email.

Usage

const isEmail = isEmail( 'hello@wordpress.org' ); // true

Parameters

email string: The string to scrutinise.

Returns

boolean: Whether or not it looks like an email.

isPhoneNumber

Determines whether the given string looks like a phone number.

Usage

const isPhoneNumber = isPhoneNumber( '+1 (555) 123-4567' ); // true

Parameters

phoneNumber string: The string to scrutinize.

Returns

boolean: Whether or not it looks like a phone number.

isURL

Determines whether the given string looks like a URL.

Related

Usage

const isURL = isURL( 'https://wordpress.org' ); // true

Parameters

url string: The string to scrutinise.

Returns

boolean: Whether or not it looks like a URL.

isValidAuthority

Checks for invalid characters within the provided authority.

Usage

const isValid = isValidAuthority( 'wordpress.org' ); // true
const isNotValid = isValidAuthority( 'wordpress#org' ); // false

Parameters

authority string: A string containing the URL authority.

Returns

boolean: True if the argument contains a valid authority.

isValidFragment

Checks for invalid characters within the provided fragment.

Usage

const isValid = isValidFragment( '#valid-fragment' ); // true
const isNotValid = isValidFragment( '#invalid-#fragment' ); // false

Parameters

fragment string: The url fragment.

Returns

boolean: True if the argument contains a valid fragment.

isValidPath

Checks for invalid characters within the provided path.

Usage

const isValid = isValidPath( 'test/path/' ); // true
const isNotValid = isValidPath( '/invalid?test/path/' ); // false

Parameters

path string: The URL path.

Returns

boolean: True if the argument contains a valid path

isValidProtocol

Tests if a url protocol is valid.

Usage

const isValid = isValidProtocol( 'https:' ); // true
const isNotValid = isValidProtocol( 'https :' ); // false

Parameters

protocol string: The url protocol.

Returns

boolean: True if the argument is a valid protocol (e.g. https:, tel:).

isValidQueryString

Checks for invalid characters within the provided query string.

Usage

const isValid = isValidQueryString( 'query=true&amp;another=false' ); // true
const isNotValid = isValidQueryString( 'query=true?another=false' ); // false

Parameters

queryString string: The query string.

Returns

boolean: True if the argument contains a valid query string.

normalizePath

Given a path, returns a normalized path where equal query parameter values will be treated as identical, regardless of order they appear in the original text.

Parameters

path string: Original path.

Returns

string: Normalized path.

prependHTTP

Prepends "https://" to a url, if it looks like something that is meant to be a TLD.

Usage

const actualURL = prependHTTP( 'wordpress.org' ); // https://wordpress.org

Parameters

url string: The URL to test.

Returns

string: The updated URL.

prependHTTPS

Prepends "https://" to a url, if it looks like something that is meant to be a TLD.

Note: this will not replace "https://" with ".

Usage

const actualURL = prependHTTPS( 'wordpress.org' ); // https://wordpress.org

Parameters

url string: The URL to test.

Returns

string: The updated URL.

removeQueryArgs

Removes arguments from the query string of the url

Usage

const newUrl = removeQueryArgs(
	'https://wordpress.org?foo=bar&amp;bar=baz&amp;baz=foobar',
	'foo',
	'bar'
); // https://wordpress.org?baz=foobar

Parameters

url string: URL.
args ...string: Query Args.

Returns

string: Updated URL.

safeDecodeURI

Safely decodes a URI with decodeURI. Returns the URI unmodified if decodeURI throws an error.

Usage

const badUri = safeDecodeURI( '%z' ); // does not throw an Error, simply returns '%z'

Parameters

uri string: URI to decode.

Returns

string: Decoded URI if possible.

safeDecodeURIComponent

Safely decodes a URI component with decodeURIComponent. Returns the URI component unmodified if decodeURIComponent throws an error.

Parameters

uriComponent string: URI component to decode.

Returns

string: Decoded URI component if possible.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.

Code is Poetry.

@wordpress/url dependencies

@babel/runtime remove-accents

FAQs

What is @wordpress/url?

WordPress URL utilities. Visit Snyk Advisor to see a full health score report for @wordpress/url, including popularity, security, maintenance & community analysis.

Is @wordpress/url popular?

The npm package @wordpress/url receives a total of 76,553 weekly downloads. As such, @wordpress/url popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @wordpress/url well maintained?

We found that @wordpress/url demonstrated a healthy version release cadence and project activity. It has a community of 390 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @wordpress/url safe to use?

The npm package @wordpress/url was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 20:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (76,553)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @wordpress/url?

URL

Installation

Usage

addQueryArgs

buildQueryString

cleanForSlug

filterURLForDisplay

getAuthority

getFilename

getFragment

getPath

getPathAndQueryString

getProtocol

getQueryArg

getQueryArgs

getQueryString

hasQueryArg

isEmail

isPhoneNumber

isURL

isValidAuthority

isValidFragment

isValidPath

isValidProtocol

isValidQueryString

normalizePath

prependHTTP

prependHTTPS

removeQueryArgs

safeDecodeURI

safeDecodeURIComponent

Contributing to this package

@wordpress/url dependencies

FAQs

What is @wordpress/url?

Is @wordpress/url popular?

Is @wordpress/url well maintained?

Is @wordpress/url safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues