time-to-botec

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

README.md (1231B)


      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 # noop
     22 
     23 > Function which does [nothing][nop].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var noop = require( '@stdlib/utils/noop' );
     31 ```
     32 
     33 #### noop()
     34 
     35 A `function` which does [nothing][nop].
     36 
     37 ```javascript
     38 noop();
     39 // ...does nothing.
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="examples">
     47 
     48 ## Examples
     49 
     50 <!-- eslint no-undef: "error" -->
     51 
     52 ```javascript
     53 var noop = require( '@stdlib/utils/noop' );
     54 
     55 function foo( next ) {
     56     // Do something...
     57 
     58     // Then...
     59     next();
     60 }
     61 
     62 foo( noop );
     63 ```
     64 
     65 </section>
     66 
     67 <!-- /.examples -->
     68 
     69 <section class="links">
     70 
     71 [nop]: https://en.wikipedia.org/wiki/NOP
     72 
     73 </section>
     74 
     75 <!-- /.links -->