@stdlib/array/base/first/lib/main.js

Arrays.

/**
* @license Apache-2.0
*
* Copyright (c) 2023 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 resolveGetter = require( './../../../base/resolve-getter' );


// MAIN //

/**
* Returns the first element of an array-like object.
*
* @param {Collection} arr - input array
* @returns {*} - first element
*
* @example
* var out = first( [ 1, 2, 3 ] );
* // returns 1
*/
function first( arr ) {
	var get;

	if ( arr.length === 0 ) {
		return;
	}
	// Resolve an accessor for retrieving input array elements:
	get = resolveGetter( arr );

	// Return the first element:
	return get( arr, 0 );
}


// EXPORTS //

module.exports = first;