props.js (1797B)
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 // MODULES // 22 23 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 24 var setReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' ); 25 var dtypes2signatures = require( '@stdlib/ndarray/base/dtypes2signatures' ); 26 var dtypes = require( './types.json' ); 27 var meta = require( './meta.json' ); 28 29 30 // FUNCTIONS // 31 32 /** 33 * Returns a list of array interface type signatures. 34 * 35 * @private 36 * @returns {StringArray} list of signatures 37 */ 38 function types() { 39 return dtypes2signatures( dtypes, meta.nin, meta.nout ); 40 } 41 42 43 // MAIN // 44 45 /** 46 * Defines properties which expose function meta data. 47 * 48 * @private 49 * @param {Function} fcn - function on which to define properties 50 */ 51 function setProps( fcn ) { 52 // Define the number of input arguments: 53 setReadOnly( fcn, 'nargs', meta.nargs ); 54 55 // Define the number of input arrays: 56 setReadOnly( fcn, 'nin', meta.nin ); 57 58 // Define the number of output arrays: 59 setReadOnly( fcn, 'nout', meta.nout ); 60 61 // Define a read-only accessor for listing a function's supported array data types: 62 setReadOnlyAccessor( fcn, 'types', types ); 63 } 64 65 66 // EXPORTS // 67 68 module.exports = setProps;