ObjectWizard

Description

ObjectWizard is a powerful utility library for JavaScript/TypeScript that provides an extensive set of functions for working with objects. Whether you need to manipulate, search, or perform operations on objects, ObjectWizard has you covered.

Features

• Check object inclusion in an array of objects
• Retrieve the index of an object within an array of objects
• Efficiently compare and manipulate objects
• Simplify object-related tasks with utility functions
• Compatible with JavaScript and TypeScript

Installation

You can install ObjectWizard using npm:

npm install objectwizard

Usage

Import ObjectWizard into your project:

import { includesObject, indexOfObject } from 'objectwizard';

// Example usage
const objectsArray = [{ id: 1, name: 'John' }, { id: 2, name: 'Mary' }];
const object1 = { id: 1, name: 'John' };
const object2 = { id: 3, name: 'Peter' };

console.log(includesObject(objectsArray, object1)); // true
console.log(indexOfObject(objectsArray, object2)); // -1

API Reference

includesObject(objectsArray: Object[], object: Object): boolean

Checks if an object is included in an array of objects.

• objectsArray: The array of objects to search in.
• object: The object to check for inclusion.
• Returns: A boolean indicating whether the object is included in the array.

indexOfObject(objectsArray: Object[], object: Object): number

Retrieves the index of an object within an array of objects.

• objectsArray: The array of objects to search in.
• object: The object to find the index of.
• Returns: The index of the object in the array, or -1 if the object is not found.

Contributing

Contributions are welcome!

License

This project is licensed under the MIT License. See the LICENSE file for more details.