flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[valid-url] Fixed return and argument type (#43332)

Browse Source
This commit is contained in:
Gabriel Cangussu 2020-03-24 21:38:51 -03:00 committed by GitHub
parent 04c3840719
commit 5afe412a64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
types/valid-url/index.d.ts vendored
View File

@ -1,15 +1,16 @@
// Type definitions for valid-url v1.0.9
// Project: https://github.com/ogt/valid-url
// Definitions by: Steve Hipwell <https://github.com/stevehipwell>
// Gabriel Cangussu <https://github.com/gcangussu>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* 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.
* @param {string} value - The potential URI to test.
* @returns {string} - The untainted RFC 3986 URI on success, undefined on failure.
* @param value - The potential URI to test.
* @returns The untainted RFC 3986 URI on success, undefined on failure.
*/
export function isUri(value: any): string;
export function isUri(value: string): string | undefined;
/**
* Is the value a well-formed HTTP uri?
@ -20,24 +21,24 @@ export function isUri(value: any): string;
* 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.
* @param {string} value - The potential URI to test.
* @returns {string} - The untainted RFC 3986 URI on success, undefined on failure.
* @param value - The potential URI to test.
* @returns The untainted RFC 3986 URI on success, undefined on failure.
*/
export function isHttpUri(value: any): string;
export function isHttpUri(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().
* @param {string} value - The potential URI to test.
* @returns {string} - The untainted RFC 3986 URI on success, undefined on failure.
* @param value - The potential URI to test.
* @returns The untainted RFC 3986 URI on success, undefined on failure.
*/
export function isHttpsUri(value: any): string;
export function isHttpsUri(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.
* @param {string} value - The potential URI to test.
* @returns {string} - The untainted RFC 3986 URI on success, undefined on failure.
* @param value - The potential URI to test.
* @returns The untainted RFC 3986 URI on success, undefined on failure.
*/
export function isWebUri(value: any): string;
export function isWebUri(value: string): string | undefined;