About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Test if a value is a URI.
npm install @stdlib/assert-is-uri
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch (see README). - If you are using Deno, visit the
deno
branch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch (see README). - To use as a general utility for the command line, install the corresponding CLI package globally.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var isURI = require( '@stdlib/assert-is-uri' );
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 false
- 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.
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:[email protected]' );
// 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 false
To use as a general utility, install the CLI package globally
npm install -g @stdlib/assert-is-uri-cli
Usage: is-uri [options] [<uri>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
-
If the split separator is a regular expression, ensure that the
split
option is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'beEp booP\nhttp://google.com' | is-uri --split /\r?\n/ # Escaped... $ echo -n $'beEp booP\nhttp://google.com' | is-uri --split /\\r?\\n/
-
The implementation ignores trailing delimiters.
$ is-uri http://google.com
true
To use as a standard stream,
$ echo -n 'http://google.com' | is-uri
true
By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split
option.
$ echo -n 'beep\thttps://google.com' | is-uri --split '\t'
false
true
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.