@stdlib/assert/is-absolute-http-uri/lib/main.js

Standard assertion utilities.

/**
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var isURI = require( './../../is-uri' );


// VARIABLES //

var RE_HTTPS = /^https?:\/\//;


// MAIN //

/**
* Tests whether a value is an absolute HTTP(S) URI.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether a value is an absolute URI
*
* @example
* var bool = isAbsoluteHttpURI( 'https://example.com' );
* // returns true
*
* @example
* var bool = isAbsoluteHttpURI( 'https://example.com/docs#heading' );
* // returns true
*
* @example
* var bool = isAbsoluteHttpURI( 'ftp://example.com' );
* // returns false
*
* @example
* var bool = isAbsoluteHttpURI( '/dashboard' );
* // returns false
*
* @example
* var bool = isAbsoluteHttpURI( './png.json' );
* // returns false
*
* @example
* var bool = isAbsoluteHttpURI( null );
* // returns false
*/
function isAbsoluteHttpURI( value ) {
	return isURI( value ) && RE_HTTPS.test( value );
}


// EXPORTS //

module.exports = isAbsoluteHttpURI;