All files main.js

100% Statements 74/74
100% Branches 6/6
100% Functions 1/1
100% Lines 74/74

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 751x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 41x 41x 41x 41x 29x 29x 16x 16x 41x 12x 12x 25x 41x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var full = require( '@stdlib/array/full' );
var join = require( '@stdlib/array/base/join' );
var dtypes = require( '@stdlib/array/dtypes' );
var defaults = require( '@stdlib/array/defaults' );
var format = require( '@stdlib/string/format' );
 
 
// VARIABLES //
 
var DTYPES = dtypes( 'boolean_and_generic' );
var isValidDType = contains( DTYPES );
var DEFAULT_DTYPE = defaults.get( 'dtypes.boolean' );
 
 
// MAIN //
 
/**
* Creates an array filled with true values and having a specified length.
*
* @param {NonNegativeInteger} length - array length
* @param {string} [dtype="bool"] - data type
* @throws {TypeError} first argument must be a nonnegative integer
* @throws {TypeError} second argument must be a supported data type
* @returns {(BooleanArray|Array)} array or typed array
*
* @example
* var arr = trues( 2 );
* // returns <BooleanArray>[ true, true ]
*
* @example
* var arr = trues( 2, 'generic' );
* // returns [ true, true ]
*/
function trues( length ) {
	var dtype;
 
	if ( arguments.length > 1 ) {
		dtype = arguments[ 1 ];
		if ( !isValidDType( dtype ) ) {
			throw new TypeError( format( 'invalid argument. Second argument must be one of the following: "%s". Value: `%s`.', join( DTYPES, '", "' ), dtype ) );
		}
	} else {
		dtype = DEFAULT_DTYPE;
	}
	return full( length, true, dtype );
}
 
 
// EXPORTS //
 
module.exports = trues;