time-to-botec

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

README.md (1999B)

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