# lowercase [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] > Convert a string to lowercase.

## Installation ```bash npm install @stdlib/string-lowercase ```

## Usage ```javascript var lowercase = require( '@stdlib/string-lowercase' ); ``` #### lowercase( str ) Converts a `string` to lowercase. ```javascript var str = lowercase( 'bEEp' ); // returns 'beep' ```

## Examples ```javascript var lowercase = require( '@stdlib/string-lowercase' ); var str; str = lowercase( 'Beep' ); // returns 'beep' str = lowercase( 'BeEp' ); // returns 'beep' str = lowercase( 'Beep BOOP' ); // returns 'beep boop' str = lowercase( '$**_Beep_BoOp_**$' ); // returns '$**_beep_boop_**$' str = lowercase( '' ); // returns '' ```

* * *

## CLI

## Installation To use the module as a general utility, install the module globally ```bash npm install -g @stdlib/string-lowercase ```

### Usage ```text Usage: lowercase [options] [] Options: -h, --help Print this message. -V, --version Print the package version. ```

### Examples ```bash $ lowercase bEEp beep ``` To use as a [standard stream][standard-streams], ```bash $ echo -n 'bEEp' | lowercase beep ```

* * * ## See Also - [`@stdlib/string/uncapitalize`][@stdlib/string/uncapitalize]: uncapitalize the first character of a string. - [`@stdlib/string/uppercase`][@stdlib/string/uppercase]: convert a string to uppercase.

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/string-lowercase.svg [npm-url]: https://npmjs.org/package/@stdlib/string-lowercase [test-image]: https://github.com/stdlib-js/string-lowercase/actions/workflows/test.yml/badge.svg?branch=v0.0.9 [test-url]: https://github.com/stdlib-js/string-lowercase/actions/workflows/test.yml?query=branch:v0.0.9 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-lowercase/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/string-lowercase?branch=main [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://gitter.im/stdlib-js/stdlib/ [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/string-lowercase/tree/deno [umd-url]: https://github.com/stdlib-js/string-lowercase/tree/umd [esm-url]: https://github.com/stdlib-js/string-lowercase/tree/esm [branches-url]: https://github.com/stdlib-js/string-lowercase/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-lowercase/main/LICENSE [standard-streams]: https://en.wikipedia.org/wiki/Standard_streams [@stdlib/string/uncapitalize]: https://www.npmjs.com/package/@stdlib/string-uncapitalize [@stdlib/string/uppercase]: https://www.npmjs.com/package/@stdlib/string-uppercase