JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2324551
  • Score
    100M100P100Q192807F

URI validation functions

Package Exports

  • valid-url

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 (valid-url) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

URI validation functions

Build Status

Synopsis

Common url validation methods

    var validUrl = require('valid-url');
  
    if (validUrl.isUri(suspect)){
        console.log('Looks like an URI');
    } else {
        console.log('Not a URI');
    }

Replicates the functionality of Richard Sonnen sonnen@richardsonnen.com perl module : http://search.cpan.org/~sonnen/Data-Validate-URI-0.01/lib/Data/Validate/URI.pm full code here into a nodejs module. Initially translated practically line by line from perl. Subsequently rewritten to leverage url. It passes all the original tests.

Description

(copied from original perl module)

This module collects common URI validation routines to make input validation, and untainting easier and more readable. All functions return an untainted value if the test passes, and undef if it fails. This means that you should always check for a defined status explicitly. Don't assume the return will be true. The value to test is always the first (and often only) argument. There are a number of other URI validation modules out there as well (see below.) This one focuses on being fast, lightweight, and relatively 'real-world'. i.e. it's good if you want to check user input, and don't need to parse out the URI/URL into chunks. Right now the module focuses on HTTP URIs, since they're arguably the most common. If you have a specialized scheme you'd like to have supported, let me know.

Installation

npm install valid-url

Methods

isUri(value)
accepts value as string to be checked as any protocol url
returns undefined if is not url, returns RFC 3986 url if valid

isHttpUri(value, allowHttps)
accepts value as string to be checked as HTTP url, allowHttps as boolean to include https urls (optional)
returns undefined if is not url, returns RFC 3986 url if valid

isHttpsUri(value)
accepts value as string to be checked as HTTPS url
returns undefined if is not url, returns RFC 3986 url if valid

isWebUri(value)
accepts value as string to be checked as HTTP or HTTPS url
returns undefined if is not url, returns RFC 3986 url if valid