Init

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.yml]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 21
+          - 20
+          - 18
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish Package to Npmjs
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+      - run: npm i
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm i
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,131 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Palash Mondal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,88 @@
+# array-reverser
+
+> Seamlessly reverse arrays or segments with ease
+
+`array-reverser` is a lightweight, easy-to-use npm package designed to reverse arrays or specific portions of arrays with precision and efficiency. Whether you need to invert the entire array or just a segment, `array-reverser` handles it effortlessly.
+
+## Features
+
+- **Flexible:** Reverse entire arrays or specify start and end indices for partial reversal.
+- **Type-Safe:** Written in TypeScript, providing type safety for TypeScript projects.
+- **Error Handling:** Robust error handling for invalid inputs and parameters.
+- **Immutability:** Ensures immutability by returning a new array instance, preserving the original array.
+- **Easy to Use:** Simple, intuitive API that integrates seamlessly into any project.
+
+## Install
+
+```sh
+npm install array-reverser
+```
+
+Or with yarn:
+
+```sh
+yarn add array-reverser
+```
+
+## Usage
+
+Import `array-reverser` into your project:
+
+```typescript
+import arrayReverser from "array-reverser";
+```
+
+Reverse an entire array:
+
+```typescript
+const array = [1, 2, 3, 4, 5];
+const reversedArray = arrayReverser(array);
+console.log(reversedArray);
+//=> [5, 4, 3, 2, 1]
+```
+
+Reverse a segment of an array:
+
+```typescript
+const array = [1, 2, 3, 4, 5];
+const reversedArray = arrayReverser(array, 1, 4);
+console.log(reversedArray);
+//=> [1, 4, 3, 2, 5]
+```
+
+Return a new array instance and preserve the original array:
+
+```typescript
+const array = [1, 2, 3, 4, 5];
+const reversedArray = arrayReverser(array);
+
+reversedArray[0] = 10; // Mutate the reversed array
+console.log(array[0]); //=> 1
+```
+
+## API
+
+### arrayReverser(array, start?, end?)
+
+#### array
+
+Type: `Array`<br>
+The array to reverse.
+
+#### start
+
+Type: `number`<br>
+Default: `0`
+
+The index at which to start reversing the array. If not provided, the array will be reversed from the beginning. This index is inclusive and will be included in the reversed array.
+
+#### end
+
+Type: `number`<br>
+Default: `array.length`
+
+The index at which to stop reversing the array. This index is exclusive and will not be included in the reversed array. If not provided, defaults to `arr.length`, and the element at the `end` index is included in the reversal and the array will be reversed from the `start` index to the end of the array.
+
+## License
+
+MIT © [Palash Mondal](https://github.com/palashmon)

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+	preset: "ts-jest",
+	testEnvironment: "node",
+};

package.json

@@ -0,0 +1,43 @@
+{
+	"name": "array-reverser",
+	"version": "0.0.0",
+	"description": "Seamlessly reverse arrays or segments with ease",
+	"author": "Palash Mondal",
+	"license": "MIT",
+	"repository": "palashmon/array-reverser",
+	"sideEffects": false,
+	"engines": {
+		"node": ">=18"
+	},
+	"main": "./dist/index.js",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsup",
+		"test": "jest"
+	},
+	"keywords": [
+		"array",
+		"reverse",
+		"invert",
+		"segment",
+		"slice",
+		"portion",
+		"partial",
+		"reversal",
+		"utility",
+		"javascript",
+		"typescript"
+	],
+	"devDependencies": {
+		"@types/jest": "^29.5.12",
+		"jest": "^29.7.0",
+		"ts-jest": "^29.1.2",
+		"ts-node": "^10.9.2",
+		"tsup": "^8.0.2",
+		"typescript": "^5.4.3"
+	}
+}

src/index.ts

@@ -0,0 +1,24 @@
+function isArray(arr: any): arr is any[] {
+	return Array.isArray(arr);
+}
+
+export default function arrayReverser<T>(
+	arr: T[],
+	start: number = 0,
+	end: number = arr.length
+): T[] {
+	if (!isArray(arr)) {
+		throw new Error("Input is not an array.");
+	}
+
+	if (start < 0 || start > arr.length || end < start || end > arr.length) {
+		throw new Error("Invalid start or end index.");
+	}
+
+	const reversedArray = arr
+		.slice(0, start)
+		.concat(arr.slice(start, end).reverse())
+		.concat(arr.slice(end));
+
+	return reversedArray;
+}