1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<!--
@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.
-->
# lowercase
> Convert a string to lowercase.
<section class="intro">
</section>
<!-- /.intro -->
<section class="usage">
## Usage
```javascript
var lowercase = require( '@stdlib/string/lowercase' );
```
#### lowercase( str )
Converts a `string` to lowercase.
```javascript
var str = lowercase( 'bEEp' );
// returns 'beep'
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```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 ''
```
</section>
<!-- /.examples -->
* * *
<section class="cli">
## CLI
<section class="usage">
### Usage
```text
Usage: lowercase [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
</section>
<!-- /.usage -->
<section class="examples">
### Examples
```bash
$ lowercase bEEp
beep
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'bEEp' | lowercase
beep
```
</section>
<!-- /.examples -->
</section>
<!-- /.cli -->
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
<section class="related">
* * *
## See Also
- <span class="package-name">[`@stdlib/string/uncapitalize`][@stdlib/string/uncapitalize]</span><span class="delimiter">: </span><span class="description">uncapitalize the first character of a string.</span>
- <span class="package-name">[`@stdlib/string/uppercase`][@stdlib/string/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
</section>
<!-- /.related -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
<!-- <related-links> -->
[@stdlib/string/uncapitalize]: https://github.com/stdlib-js/string/tree/main/uncapitalize
[@stdlib/string/uppercase]: https://github.com/stdlib-js/string/tree/main/uppercase
<!-- </related-links> -->
</section>
<!-- /.links -->
|
