time-to-botec

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

README.md (4240B)

      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 # Symbol
     22 
     23 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
     24 
     25 > Symbol namespace.
     26 
     27 <section class="installation">
     28 
     29 ## Installation
     30 
     31 ```bash
     32 npm install @stdlib/symbol
     33 ```
     34 
     35 </section>
     36 
     37 <section class="usage">
     38 
     39 ## Usage
     40 
     41 ```javascript
     42 var ns = require( '@stdlib/symbol' );
     43 ```
     44 
     45 #### ns
     46 
     47 Symbol namespace.
     48 
     49 ```javascript
     50 var o = ns;
     51 // returns {...}
     52 ```
     53 
     54 The namespace contains the following:
     55 
     56 <!-- <toc pattern="*"> -->
     57 
     58 <div class="namespace-toc">
     59 
     60 -   <span class="signature">[`AsyncIteratorSymbol`][@stdlib/symbol/async-iterator]</span><span class="delimiter">: </span><span class="description">async iterator symbol which specifies the default async iterator for an object.</span>
     61 -   <span class="signature">[`Symbol( [description] )`][@stdlib/symbol/ctor]</span><span class="delimiter">: </span><span class="description">symbol factory.</span>
     62 -   <span class="signature">[`IteratorSymbol`][@stdlib/symbol/iterator]</span><span class="delimiter">: </span><span class="description">iterator symbol which specifies the default iterator for an object.</span>
     63 
     64 </div>
     65 
     66 <!-- </toc> -->
     67 
     68 </section>
     69 
     70 <!-- /.usage -->
     71 
     72 <section class="examples">
     73 
     74 ## Examples
     75 
     76 <!-- TODO: better examples -->
     77 
     78 <!-- eslint no-undef: "error" -->
     79 
     80 ```javascript
     81 var objectKeys = require( '@stdlib/utils/keys' );
     82 var ns = require( '@stdlib/symbol' );
     83 
     84 console.log( objectKeys( ns ) );
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.examples -->
     90 
     91 
     92 <section class="main-repo" >
     93 
     94 * * *
     95 
     96 ## Notice
     97 
     98 This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
     99 
    100 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
    101 
    102 #### Community
    103 
    104 [![Chat][chat-image]][chat-url]
    105 
    106 ---
    107 
    108 ## License
    109 
    110 See [LICENSE][stdlib-license].
    111 
    112 
    113 ## Copyright
    114 
    115 Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
    116 
    117 </section>
    118 
    119 <!-- /.stdlib -->
    120 
    121 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    122 
    123 <section class="links">
    124 
    125 [npm-image]: http://img.shields.io/npm/v/@stdlib/symbol.svg
    126 [npm-url]: https://npmjs.org/package/@stdlib/symbol
    127 
    128 [test-image]: https://github.com/stdlib-js/symbol/actions/workflows/test.yml/badge.svg
    129 [test-url]: https://github.com/stdlib-js/symbol/actions/workflows/test.yml
    130 
    131 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/symbol/main.svg
    132 [coverage-url]: https://codecov.io/github/stdlib-js/symbol?branch=main
    133 
    134 [dependencies-image]: https://img.shields.io/david/stdlib-js/symbol.svg
    135 [dependencies-url]: https://david-dm.org/stdlib-js/symbol/main
    136 
    137 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
    138 [chat-url]: https://gitter.im/stdlib-js/stdlib/
    139 
    140 [stdlib]: https://github.com/stdlib-js/stdlib
    141 
    142 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
    143 
    144 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/symbol/main/LICENSE
    145 
    146 <!-- <toc-links> -->
    147 
    148 [@stdlib/symbol/async-iterator]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/async-iterator
    149 
    150 [@stdlib/symbol/ctor]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/ctor
    151 
    152 [@stdlib/symbol/iterator]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/iterator
    153 
    154 <!-- </toc-links> -->
    155 
    156 </section>
    157 
    158 <!-- /.links -->