51 lines
1.2 KiB
JavaScript
51 lines
1.2 KiB
JavaScript
/**
|
|
* @license Apache-2.0
|
|
*
|
|
* Copyright (c) 2018 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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
|
|
var format = require( './../../format' );
|
|
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Converts a string to lowercase.
|
|
*
|
|
* @param {string} str - string to convert
|
|
* @throws {TypeError} must provide a string
|
|
* @returns {string} lowercase string
|
|
*
|
|
* @example
|
|
* var str = lowercase( 'bEEp' );
|
|
* // returns 'beep'
|
|
*/
|
|
function lowercase( str ) {
|
|
if ( !isString( str ) ) {
|
|
throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
|
|
}
|
|
return str.toLowerCase();
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = lowercase;
|