time-to-botec

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

README.md (1893B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2022 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 # Base String
     22 
     23 > Base (i.e., lower-level) string functions.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var string = require( '@stdlib/string/base' );
     31 ```
     32 
     33 #### string
     34 
     35 Namespace containing "base" (i.e., lower-level) string functions.
     36 
     37 ```javascript
     38 var ns = string;
     39 // returns {...}
     40 ```
     41 
     42 The namespace has the following sub-namespaces:
     43 
     44 <!-- <toc pattern="*"> -->
     45 
     46 <!-- </toc> -->
     47 
     48 </section>
     49 
     50 <!-- /.usage -->
     51 
     52 <!-- Package notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     53 
     54 <section class="notes">
     55 
     56 </section>
     57 
     58 <!-- /.notes -->
     59 
     60 <section class="examples">
     61 
     62 ## Examples
     63 
     64 <!-- TODO: better examples -->
     65 
     66 <!-- eslint no-undef: "error" -->
     67 
     68 ```javascript
     69 var objectKeys = require( '@stdlib/utils/keys' );
     70 var ns = require( '@stdlib/string/base' );
     71 
     72 console.log( objectKeys( ns ) );
     73 ```
     74 
     75 </section>
     76 
     77 <!-- /.examples -->
     78 
     79 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
     80 
     81 <section class="related">
     82 
     83 </section>
     84 
     85 <!-- /.related -->
     86 
     87 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     88 
     89 <section class="links">
     90 
     91 <!-- <toc-links> -->
     92 
     93 <!-- </toc-links> -->
     94 
     95 </section>
     96 
     97 <!-- /.links -->