# move-sort

> > Switch an array item's index and get a new sorted array.

Latest version **1.1.0** (published 2022-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install move-sort
pnpm add move-sort
yarn add move-sort
bun add move-sort
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-10-02 |
| First published | 2018-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Collin Henderson |
| Maintainers | syropian |

## Links

- npm: https://www.npmjs.com/package/move-sort
- Repository: https://github.com/syropian/move-sort
- Homepage: https://github.com/syropian/move-sort#readme
- Issues: https://github.com/syropian/move-sort/issues
- npm.io page: https://npm.io/package/move-sort

## Recent versions

- 1.1.0 (latest) — 2022-10-02
- 1.0.0 — 2018-04-06

## README

# move-sort [![Tests](https://github.com/syropian/move-sort/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/syropian/move-sort/actions/workflows/test.yml)

> Switch an array item's index and get a new sorted array.

## Install

```
$ npm install move-sort --save
```

**or** include it in a `<script>` tag, hosted by [unpkg](https://unpkg.com).

```js
<script src="//unpkg.com/move-sort" />
```

## Usage

```ts
import moveSort from 'move-sort'

const items = ['a', 'b', 'c', 'd', 'e']
const sortedItems = moveSort(items, 4, 0)

console.log(sortedItems) // returns ["e", "a", "b", "c", "d"]
```

**Note:** `move-sort` always returns a new array, and does not mutate the original array you pass into it.

## API

### moveSort(items, startIndex, endIndex)

#### items

Type: `T extends any[]`

The original array you want to generate a sorted array for.

#### startIndex

Type: `number`

The index of the inital element in the array you want to move.

#### endIndex

Type: `number`

The target index of the inital element in the array you want to move it to.

### Index constraints

The start and end index arguments are clamped to the bounds of the `items` array. Indexes less than `0` will become `0` and indexes greater than `(items.length - 1)` will become `(items.length - 1)`.

## Development

```bash
# To run the tests
$ pnpm test
# or
$ pnpm run test:watch

# To publish the dist files
$ pnpm run build
```

## License

MIT © [Collin Henderson](https://github.com/syropian)

---
_Source: https://npm.io/package/move-sort · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._