isURI

Test if a value is a URI.

Usage

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 false

Notes

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 false

CLI

Usage

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/'.

Notes

  • 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.

Examples

$ 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