array-mid v1.1.0

array-mid

Get middle element in an N-element array (either left, right, or both elements if N is even)

Installation

npm install array-mid

Usage

const mid = require('array-mid');

mid([1, 2, 3, 4, 5]);
//=> [3]

// array with an odd number of elements
let seven = [1, 2, 3, 4, 5, 6, 7];
mid(seven);
//=> [4]
mid(seven, 3, 'left');
//=> [1, 2, 3, 4]
mid(seven, 3, 'right');
//=> [4, 5, 6, 7]

// Error thrown here: mid(seven, 2)
// Cannot return an even number of elements n from position="center" of an odd-lengthed array.


// array with an even number of elements
let six = [1, 2, 3, 4, 5, 6];

// Note: for even-lengthed arrays, mid() returns two elements by default (even with n = 1)
mid(six);  
//=> [3, 4]

mid(six, 3, 'left');
//=> [1, 2, 3]
mid(six, 3, 'right');
//=> [4, 5, 6]

// Error thrown here: mid(six, 3)
// Cannot return an odd number of elements n > 1 from position="center" of an even-lengthed array

Background

Based on array-first.