# object-awesome

> A cooler way to work with objects.

Latest version **0.0.1** (published 2023-12-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install object-awesome
pnpm add object-awesome
yarn add object-awesome
bun add object-awesome
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-12-14 |
| First published | 2023-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=8.3.0 |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emanuel Martins |
| Maintainers | ezms |
| Keywords | typescript, javascript, typescript-utils, utils, util, ts-utils, java |

## Links

- npm: https://www.npmjs.com/package/object-awesome
- npm.io page: https://npm.io/package/object-awesome

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2023-12-14
- 0.0.0 — 2023-12-14

## README

# Object Awesome ✨

#### A cooler way to work with objects.

object-awesome is a tool to speed up software development and make the code more readable for us developers. It provides a set of classes and utility methods that can be called anywhere in the code.

## Find what you need 😉

-   [Contribution guide]()
-   [Documentation](#doc)
-   [Install guide](#install)

## <a name="install"></a>Installation 🔧

Add locally to your project folder: <br/>
_You can also install it globally but it's not recommended._

```bash
    # Using npm
    npm install object-awesome
    # Or yarn
    yarn add object-awesome
    # Or pnpm
    pnpm add object-awesome
```

## <a name="doc"></a>Documentation 📚

List to explain the methods and usages:<br/>

### List

| Method / Function        | Return    | Description                                                                                                                                              |
| ------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| addAll                   | `void`    | Receives a list of the given type and adds all elements to the list.                                                                                     |
| addIgnoringNulls         | `void`    | Gets a thing of the specified type and throws it into the list if the thing ain't null.                                                                  |
| addManyIgnoringNulls     | `void`    | Gets a list and tosses them into the array if the element ain't null.                                                                                    |
| checkForNullsAndAddAllTo | `void`    | Receives a list of elements and checks if there is any null element in the list; if there is, raises a type error, otherwise adds them all to the array. |
| hasNullValues            | `boolean` | Checks if the list contains a null element.                                                                                                              |
| replace                  | `void`    | Replace the element with a different value.                                                                                                              |
| clear                    | `void`    | Removes all elements from the array.                                                                                                                     |
| take                     | `T`       | Get an element by index.                                                                                                                                 |
| isEmpty                  | `boolean` | Checks if the list is definitely empty.                                                                                                                  |

### Objects

| Method / Function | Return    | Description                                                                          |
| ----------------- | --------- | ------------------------------------------------------------------------------------ |
| nonNull           | `boolean` | Receives an object and checks if it is not null or undefined.                        |
| isNull            | `boolean` | Receives an object and checks if it is null and undefined.                           |
| requireNonNull    | `boolean` | Receives a sequence of objects and throws an error if an object is null.             |
| equals            | `boolean` | Receives two objects and checks if they are both exactly the same.                   |
| strictEquals      | `boolean` | Receives two objects and checks if they are both exactly the same and also not null. |
| clone             | `any`     | Return a copy of given object.                                                       |

<br/><hr/>
Made with 💜 by Emanuel Martins © 2023.

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