Skip to content

Rotate an array by a given number of steps

License

Notifications You must be signed in to change notification settings

sindresorhus/to-rotated

Repository files navigation

to-rotated

Rotate an array by a given number of steps

Array rotation shifts the elements left or right by a certain number of steps. Elements that move past the end reappear at the beginning. For example, rotating [1, 2, 3, 4, 5] by 2 steps to the right results in [4, 5, 1, 2, 3].

Install

npm install to-rotated

Usage

import toRotated from 'to-rotated';

console.log(toRotated([1, 2, 3, 4, 5], 2));
//=> [4, 5, 1, 2, 3]

console.log(toRotated([1, 2, 3, 4, 5], -2));
//=> [3, 4, 5, 1, 2]

API

toRotated(array, steps)

Returns a new array that is rotated by the given number of steps.