Package Exports
- @stdlib/assert-is-uri
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-uri) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
isURI
Test if a value is a URI.
Installation
npm install @stdlib/assert-is-uriUsage
var isURI = require( '@stdlib/assert-is-uri' );isURI( value )
Tests if a value is a URI.
var bool = isURI( 'https://google.com' );
// returns true
bool = isURI( 'ftp://ftp.is.co.za/rfc/rfc1808.txt' );
// returns true
bool = isURI( '' );
// returns false
bool = isURI( 'foo' );
// returns false
bool = isURI( null );
// returns false
bool = isURI( NaN );
// returns false
bool = isURI( true );
// returns falseNotes
- For more information regarding the URI scheme, see RFC 3986 and Wikipedia.
- On the distinction between URI, URL, and URN, see The Difference Between URLs and URIs.
Examples
var isURI = require( '@stdlib/assert-is-uri' );
/* Valid */
var bool = isURI( 'http://google.com' );
// returns true
bool = isURI( 'http://localhost/' );
// returns true
bool = isURI( 'http://example.w3.org/path%20with%20spaces.html' );
// returns true
bool = isURI( 'http://example.w3.org/%20' );
// returns true
bool = isURI( 'ftp://ftp.is.co.za/rfc/rfc1808.txt' );
// returns true
bool = isURI( 'ftp://ftp.is.co.za/../../../rfc/rfc1808.txt' );
// returns true
bool = isURI( 'http://www.ietf.org/rfc/rfc2396.txt' );
// returns true
bool = isURI( 'ldap://[2001:db8::7]/c=GB?objectClass?one' );
// returns true
bool = isURI( 'mailto:John.Doe@example.com' );
// returns true
bool = isURI( 'news:comp.infosystems.www.servers.unix' );
// returns true
bool = isURI( 'tel:+1-816-555-1212' );
// returns true
bool = isURI( 'telnet://192.0.2.16:80/' );
// returns true
bool = isURI( 'urn:oasis:names:specification:docbook:dtd:xml:4.1.2' );
// returns true
/* Invalid */
// No scheme:
bool = isURI( '' );
// returns false
// No scheme:
bool = isURI( 'foo' );
// returns false
// No scheme:
bool = isURI( 'foo@bar' );
// returns false
// No scheme:
bool = isURI( '://foo/' );
// returns false
// Illegal characters:
bool = isURI( 'http://<foo>' );
// returns false
// Invalid path:
bool = isURI( 'http:////foo.html' );
// returns false
// Incomplete hex escapes...
bool = isURI( 'http://example.w3.org/%a' );
// returns false
bool = isURI( 'http://example.w3.org/%a/foo' );
// returns false
bool = isURI( 'http://example.w3.org/%at' );
// returns falseCLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/assert-is-uriUsage
Usage: is-uri [options] [<uri>]
Options:
-h, --help Print this message.
-V, --version Print the package version.Examples
$ is-uri http://google.com
trueTo use as a standard stream,
$ echo -n 'http://google.com' | is-uri
trueNotice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.