time-to-botec

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

index.js (2435B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2021 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /*
     22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
     23 */
     24 
     25 // MODULES //
     26 
     27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
     28 
     29 
     30 // MAIN //
     31 
     32 /**
     33 * Top-level namespace.
     34 *
     35 * @namespace ns
     36 */
     37 var ns = {};
     38 
     39 /**
     40 * @name allocUnsafe
     41 * @memberof ns
     42 * @readonly
     43 * @type {Function}
     44 * @see {@link module:@stdlib/buffer/alloc-unsafe}
     45 */
     46 setReadOnly( ns, 'allocUnsafe', require( './../alloc-unsafe' ) );
     47 
     48 /**
     49 * @name Buffer
     50 * @memberof ns
     51 * @readonly
     52 * @type {Function}
     53 * @see {@link module:@stdlib/buffer/ctor}
     54 */
     55 setReadOnly( ns, 'Buffer', require( './../ctor' ) );
     56 
     57 /**
     58 * @name array2buffer
     59 * @memberof ns
     60 * @readonly
     61 * @type {Function}
     62 * @see {@link module:@stdlib/buffer/from-arraybuffer}
     63 */
     64 setReadOnly( ns, 'array2buffer', require( './../from-array' ) );
     65 
     66 /**
     67 * @name arraybuffer2buffer
     68 * @memberof ns
     69 * @readonly
     70 * @type {Function}
     71 * @see {@link module:@stdlib/buffer/from-arraybuffer}
     72 */
     73 setReadOnly( ns, 'arraybuffer2buffer', require( './../from-arraybuffer' ) );
     74 
     75 /**
     76 * @name copyBuffer
     77 * @memberof ns
     78 * @readonly
     79 * @type {Function}
     80 * @see {@link module:@stdlib/buffer/from-buffer}
     81 */
     82 setReadOnly( ns, 'copyBuffer', require( './../from-buffer' ) );
     83 
     84 /**
     85 * @name string2buffer
     86 * @memberof ns
     87 * @readonly
     88 * @type {Function}
     89 * @see {@link module:@stdlib/buffer/from-string}
     90 */
     91 setReadOnly( ns, 'string2buffer', require( './../from-string' ) );
     92 
     93 /**
     94 * @name reviver
     95 * @memberof ns
     96 * @readonly
     97 * @type {Function}
     98 * @see {@link module:@stdlib/buffer/reviver}
     99 */
    100 setReadOnly( ns, 'reviver', require( './../reviver' ) );
    101 
    102 /**
    103 * @name toJSON
    104 * @memberof ns
    105 * @readonly
    106 * @type {Function}
    107 * @see {@link module:@stdlib/buffer/to-json}
    108 */
    109 setReadOnly( ns, 'toJSON', require( './../to-json' ) );
    110 
    111 
    112 // EXPORTS //
    113 
    114 module.exports = ns;