time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (3006B)

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