Skip to content

Add more methods to the array helper #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add more methods to the array helper #41

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3a34c5
feat: added exists() function to the array helper and tested it
AhmedHdeawy Dec 5, 2024
9d7a08f
feat: added last() function to the array helper with the test cases
AhmedHdeawy Dec 5, 2024
df96d7a
Merge branch 'main' into impr/add-more-array-helper-methods
AhmedHdeawy Dec 7, 2024
aa7b429
fix: fixed lintinig issues by running prettier with write flag
AhmedHdeawy Jan 10, 2025
f21a608
Merge branch 'impr/add-more-array-helper-methods' of github.com:Ahmed…
AhmedHdeawy Jan 10, 2025
4b35c47
Merge branch 'main' into impr/add-more-array-helper-methods
AhmedHdeawy Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions packages/core/lib/utils/array.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,46 @@ export class Arr {

return undefined;
}

static exists<T = any>(arr: T[], key: string | number): boolean {
if (typeof key === 'number' && key >= 0 && key < arr.length) {
return true;
}

if (typeof key === 'string') {
const splitKeys = key.split('.');
if (!splitKeys.length) return false;

if (Arr.isArray(arr[splitKeys[0]])) {
return Arr.exists(arr[splitKeys[0]], splitKeys.slice(1).join('.'));
}

if (Obj.isObj(arr[splitKeys[0]])) {
return Obj.get(arr[splitKeys[0]], splitKeys.slice(1).join('.')) !== undefined;
}
}

return false;
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static exists<T = any>(arr: T[], key: string | number): boolean {
if (typeof key === 'number' && key >= 0 && key < arr.length) {
return true;
}
if (typeof key === 'string') {
const splitKeys = key.split('.');
if (!splitKeys.length) return false;
if (Arr.isArray(arr[splitKeys[0]])) {
return Arr.exists(arr[splitKeys[0]], splitKeys.slice(1).join('.'));
}
if (Obj.isObj(arr[splitKeys[0]])) {
return Obj.get(arr[splitKeys[0]], splitKeys.slice(1).join('.')) !== undefined;
}
}
return false;
}
static exists<T>(arr: T[], key: string | number): boolean {
// If the key is a number, just check if it's a valid index.
if (typeof key === 'number') {
return key >= 0 && key < arr.length;
}
// If the key is a string, treat it as a path like "0.someKey.2"
const splitKeys = key.split('.');
// Early exit if no path given (e.g. empty string)
if (splitKeys.length === 0 || (splitKeys.length === 1 && splitKeys[0] === '')) {
return false;
}
let current: any = arr;
for (let i = 0; i < splitKeys.length; i++) {
let currentKey = splitKeys[i];
// Check if currentKey should be an array index
const isIndex = !isNaN(parseInt(currentKey));
if (Array.isArray(current)) {
if (!isIndex) {
// The path expects a number index, but got a string that isn't a number
return false;
}
const idx = parseInt(currentKey, 10);
if (idx < 0 || idx >= current.length) {
return false;
}
current = current[idx];
} else if (current !== null && typeof current === 'object') {
// For objects, currentKey must be a string property
if (!(currentKey in current)) {
return false;
}
current = current[currentKey];
} else {
// current is neither an array nor an object; no further traversal possible
return false;
}
}
// If we've navigated the entire path without issues, it exists
return true;
}


static last<T = any>(
arr: T[],
predicate?: ((item: T, index: number, array: T[]) => boolean) | null
): T | undefined {
if (!arr || arr.length === 0) {
return undefined;
}

if (!predicate) {
return arr[arr.length - 1];
}

for (let i = arr.length - 1; i >= 0; i--) {
if (predicate(arr[i], i, arr)) {
return arr[i];
}
}

return undefined;
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static last<T = any>(
arr: T[],
predicate?: ((item: T, index: number, array: T[]) => boolean) | null
): T | undefined {
if (!arr || arr.length === 0) {
return undefined;
}
if (!predicate) {
return arr[arr.length - 1];
}
for (let i = arr.length - 1; i >= 0; i--) {
if (predicate(arr[i], i, arr)) {
return arr[i];
}
}
return undefined;
}
static last<T>(arr: T[], predicate?: (item: T, index: number, array: T[]) => boolean): T | undefined {
if (!arr || arr.length === 0) {
return undefined;
}
if (!predicate) {
return arr[arr.length - 1];
}
for (let i = arr.length - 1; i >= 0; i--) {
if (predicate(arr[i], i, arr)) {
return arr[i];
}
}
return undefined;
}

}
36 changes: 36 additions & 0 deletions packages/core/tests/helpers/arrayHelper.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import { Arr } from '../../lib/utils/array';

describe('Array Helper', () => {
beforeEach(async () => { });

it('check key exists', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.exists(arr, 2)).toBeTruthy();
});

it('check key does not exist', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.exists(arr, 6)).toBeFalsy();
});

it('should return last element matching predicate', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.last(arr, x => x < 4)).toBe(3);
expect(Arr.last(arr)).toBe(5);
});

it('should return the last object that matches the predicate', () => {
const users = [
{ name: 'Alice', age: 25 },
{ name: 'Bob', age: 30 },
{ name: 'Charlie', age: 35 },
{ name: 'David', age: 30 }
];
const lastUserUnder35 = Arr.last(users, user => user.age < 35);
expect(lastUserUnder35).toEqual({ name: 'David', age: 30 });
});

it('should return undefined for empty array', () => {
expect(Arr.last([])).toBeUndefined();
});
});
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
describe('Array Helper', () => {
beforeEach(async () => { });
it('check key exists', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.exists(arr, 2)).toBeTruthy();
});
it('check key does not exist', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.exists(arr, 6)).toBeFalsy();
});
it('should return last element matching predicate', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.last(arr, x => x < 4)).toBe(3);
expect(Arr.last(arr)).toBe(5);
});
it('should return the last object that matches the predicate', () => {
const users = [
{ name: 'Alice', age: 25 },
{ name: 'Bob', age: 30 },
{ name: 'Charlie', age: 35 },
{ name: 'David', age: 30 }
];
const lastUserUnder35 = Arr.last(users, user => user.age < 35);
expect(lastUserUnder35).toEqual({ name: 'David', age: 30 });
});
it('should return undefined for empty array', () => {
expect(Arr.last([])).toBeUndefined();
});
});
describe('Arr Utility Class', () => {
describe('Arr.exists', () => {
const sampleArray = [1, 2, { name: 'Alice', friends: ['Bob', 'Carol'] }];
const arr = [1, 2, 3, 4, 5];
it('check key exists', () => {
expect(Arr.exists(arr, 2)).toBeTruthy();
});
it('check key does not exist', () => {
expect(Arr.exists(arr, 6)).toBeFalsy();
});
it('should return true for a valid index (0)', () => {
expect(Arr.exists(sampleArray, 0)).toBe(true);
});
it('should return true for a nested property ("2.name")', () => {
expect(Arr.exists(sampleArray, '2.name')).toBe(true);
});
it('should return true for a deeper nested array property ("2.friends.1")', () => {
expect(Arr.exists(sampleArray, '2.friends.1')).toBe(true);
});
it('should return false for a non-existent property ("2.age")', () => {
expect(Arr.exists(sampleArray, '2.age')).toBe(false);
});
});
describe('Arr.last', () => {
it('should return last element matching predicate', () => {
const arr = [1, 2, 3, 4, 5];
expect(Arr.last(arr, x => x < 4)).toBe(3);
expect(Arr.last(arr)).toBe(5);
});
it('should return the last object that matches the predicate', () => {
const users = [
{ name: 'Alice', age: 25 },
{ name: 'Bob', age: 30 },
{ name: 'Charlie', age: 35 },
{ name: 'David', age: 30 },
];
const lastUserUnder35 = Arr.last(users, user => user.age < 35);
expect(lastUserUnder35).toEqual({ name: 'David', age: 30 });
});
it('should return undefined for empty array', () => {
expect(Arr.last([])).toBeUndefined();
});
});
});

Loading