@utilify/array - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

LICENSE

+MIT License
+
+Copyright (c) 2025 Júlio Pattuzzo
+
+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

+# Array Utility Functions
+
+Array utility functions provide a variety of methods for manipulating and transforming arrays. These functions help simplify common operations, such as splitting, flattening, shuffling, and finding differences between arrays, among others.
+
+## Install
+
+To install and use the array utility functions, follow these steps:
+
+```bash
+npm install array-utils
+```
+
+Alternatively, you can use yarn:
+
+```bash
+yarn add array-utils
+```
+
+After installation, you can import the functions into your project in two ways:
+
+### Namespace Import
+
+You can import the entire module as a namespace, which will bundle all functions under a single object:
+
+```typescript
+import * as ArrayUtils from 'array-utils';
+```
+
+Then you can access the functions like this:
+
+```typescript
+ArrayUtils.after(array, 2);
+ArrayUtils.shuffle(array);
+ArrayUtils.union(array1, array2);
+```
+
+### Named Imports
+
+Alternatively, you can import specific functions by name:
+
+```typescript
+import { after, before, chunk, difference, first, flattenArr, getRandom, isIterable, last, rotate, sanitizeArr, shuffle, swap, union, unique } from 'array-utils';
+```
+
+Both methods work, so you can choose the one that best fits your project structure. The **namespace import** is helpful when you want to avoid name conflicts or prefer grouping all utility functions under one object.
+
+## Overview
+
+Here is an overview of the available functions in the array utility package:
+
+### [after](./after.md)
+```typescript
+function after(array: any[], n: number): any[]
+```
+Returns the elements of the array after index `n`.
+
+### [before](./before.md)
+```typescript
+function before(array: any[], n: number): any[]
+```
+Returns the elements of the array before index `n`.
+
+### [chunk](./chunk.md)
+```typescript
+function chunk(array: any[], size: number): any[][]
+```
+Splits the array into smaller chunks of size `size`.
+
+### [difference](./difference.md)
+```typescript
+function difference(array: any[], values: any[]): any[]
+```
+Returns the elements of the array that are not present in the second array.
+
+### [first](./first.md)
+```typescript
+function first(array: any[], n?: number): any[]
+```
+Returns the first `n` elements of the array.
+
+### [flattenArr](./flattenArr.md)
+```typescript
+function flattenArr(array: any[], depth?: number): any[]
+```
+Flattens the array to the specified depth.
+
+### [getRandom](./getRandom.md)
+```typescript
+function getRandom(array: any[]): any
+```
+Returns a random element from the array.
+
+### [isIterable](./isIterable.md)
+```typescript
+function isIterable(obj: any): boolean
+```
+Checks if the object is iterable.
+
+### [last](./last.md)
+```typescript
+function last(array: any[], n?: number): any[]
+```
+Returns the last `n` elements of the array.
+
+### [rotate](./rotate.md)
+```typescript
+function rotate(array: any[], n: number): any[]
+```
+Rotates the elements of the array `n` positions.
+
+### [sanitizeArr](./sanitizeArr.md)
+```typescript
+function sanitizeArr(array: any[], values: any[], replaceValue?: any): any[]
+```
+Removes or replaces the specified values in the array.
+
+### [shuffle](./shuffle.md)
+```typescript
+function shuffle(array: any[]): any[]
+```
+Shuffles the elements of the array.
+
+### [swap](./swap.md)
+```typescript
+function swap(array: any[], index1: number, index2: number): any[]
+```
+Swaps the elements at positions `index1` and `index2`.
+
+### [union](./union.md)
+```typescript
+function union(...arrays: any[][]): any[]
+```
+Returns the union of multiple arrays.
+
+### [unique](./unique.md)
+```typescript
+function unique(array: any[]): any[]
+```
+Returns an array with unique elements.
+
+---

package.json

 {
 	"name": "@utilify/array",
-	"version": "1.0.0",
-	"description": "",
+	"version": "1.0.1",
+	"description": "A collection of utility functions for array manipulation and transformation. Simplifies common operations like chunking, flattening, shuffling, finding differences, and more.",
 	"keywords": [
@@ -17,3 +17,3 @@ "array",
 	"author": "Júlio Pattuzzo [e-mail]",
-	"homepage": "",
+	"homepage": "https://utilify-docs.vercel.app/pt/docs/array/",
 	"license": "MIT",
@@ -20,0 +20,0 @@ "type": "module",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9334

118.08%

Number of package files

6

50%

Number of low quality alerts

2

-33.33%

Number of medium quality alerts

1

-50%

Number of lines in readme file

141

Infinity%

No dependency changes