@types/valid-url
- Version 1.0.7
- Published
- 6.99 kB
- No dependencies
- MIT license
Install
npm i @types/valid-url
yarn add @types/valid-url
pnpm add @types/valid-url
Overview
TypeScript definitions for valid-url
Index
Functions
function isHttpsUri
isHttpsUri: (value: string) => string | undefined;
Is the value a well-formed HTTPS uri? See is_http_uri() for details. This version only likes the https URI scheme. Otherwise it's identical to is_http_uri().
Parameter value
The potential URI to test.
Returns
The untainted RFC 3986 URI on success, undefined on failure.
function isHttpUri
isHttpUri: (value: string) => string | undefined;
Is the value a well-formed HTTP uri? Specialized version of isUri() that only likes http:// urls. As a result, it can also do a much more thorough job validating. Also, unlike isUri() it is more concerned with only allowing real-world URIs through. Things like relative hostnames are allowed by the standards, but probably aren't wise. Conversely, null paths aren't allowed per RFC 2616 (should be '/' instead), but are allowed by this function.
This function only works for fully-qualified URIs. /bob.html won't work. See RFC 3986 for the appropriate method to turn a relative URI into an absolute one given its context.
Note that you probably want to either call this in combo with is_https_uri(). i.e. if(isHttpUri(uri) || isHttpsUri(uri)) console.log('Good'); or use the convenience method isWebUri which is equivalent.
Parameter value
The potential URI to test.
Returns
The untainted RFC 3986 URI on success, undefined on failure.
function isUri
isUri: (value: string) => string | undefined;
Is the value a well-formed uri? Returns the untainted URI if the test value appears to be well-formed. Note that you may really want one of the more practical methods like is_http_uri or is_https_uri, since the URI standard (RFC 3986) allows a lot of things you probably don't want.
Parameter value
The potential URI to test.
Returns
The untainted RFC 3986 URI on success, undefined on failure.
function isWebUri
isWebUri: (value: string) => string | undefined;
Is the value a well-formed HTTP or HTTPS uri? This is just a convenience method that combines isHttpUri and isHttpsUri to accept most common real-world URLs.
Parameter value
The potential URI to test.
Returns
The untainted RFC 3986 URI on success, undefined on failure.
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/valid-url
.
- Markdown[](https://www.jsdocs.io/package/@types/valid-url)
- HTML<a href="https://www.jsdocs.io/package/@types/valid-url"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2744 ms. - Missing or incorrect documentation? Open an issue for this package.