Release v1.0.0

.gitignore

@@ -0,0 +1,130 @@
+# 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.*

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gustavo Becelli
+
+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,108 @@
+# OOptional - Optional type for your OOP needs
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+OOptional is a TypeScript library that provides an optional type that fits nicely with Object Oriented Programming. It provides a way to handle optional values without resorting to null or undefined.
+
+## Installation
+
+To install the library, you can use npm:
+
+```sh
+npm install ooptional
+```
+
+## Usage
+
+### Importing
+
+```ts
+import { Optional, Option } from "ooptional";
+```
+
+### Creating an Optional
+
+```ts
+const optional: Optional<string> = Optional.ofNullable("Hello, world!");
+
+// or
+const some: Some<string> = Optional.some("Hello, world!");
+const someAsOptional: Optional<string> = Optional.some("Hello, world!");
+
+// or
+
+const none: None<string> = Optional.none();
+const noneAsOptional: Optional<string> = Optional.none();
+```
+
+### Checking if an Optional has a value
+
+```ts
+const optional: Optional<string> = Optional.ofNullable("Hello, world!");
+
+if (optional.isSome()) {
+  console.log(
+    `$It automatically inferred the type as Some<string> and can access the value using the get() method: ${optional.get()}`
+  );
+} else {
+  console.log("It is None");
+}
+```
+
+### Option class
+
+The `Option` class has the following methods:
+
+- `isNone()`: Returns false as this is the `Some` variant of `Option`.
+- `isSome()`: Returns true as this is the `Some` variant of `Option`.
+- `unwrap(error?: string | Error)`: Returns the value if it exists, otherwise throws the provided error.
+- `getOrElse(defaultValue: T)`: Returns the value if it exists, otherwise returns the default value.
+- `orElse(value: Optional<T>)`: Returns the current `Some` instance.
+- `map<U>(f: (value: T) => U)`: Applies a function to the contained value and returns a new `Optional` instance with the result.
+- `mapAsync<U>(f: (value: T) => Promise<U>)`: Applies an asynchronous function to the contained value and returns a new `Optional` instance with the result.
+- `filter(predicate: (value: T) => boolean)`: Applies a predicate to the contained value and returns an `Optional` instance depending on the predicate result.
+- `filterAsync(predicate: (value: T) => Promise<boolean>)`: Applies an asynchronous predicate to the contained value and returns an `Optional` instance depending on the predicate result.
+- `equals(other: Optional<T>, comparator?: (a: T, b: T) => boolean)`: Checks if the current `Optional` instance is equal to another one.
+
+### Some class
+
+The `Some` class is one of the variants of `Option`. It represents a value that exists. It has similar methods to `None`, but they behave differently as they have a value to work with.
+
+- `get()`: Returns the value if it exists, otherwise throws an error.
+- All the methods from `Option`.
+
+### None class
+
+The `None` class is the other variant of `Option`. It represents an absence of value. It has similar methods to `Some`, but they behave differently as they don't have a value to work with.
+
+- All the methods from `Option`.
+
+# Contributing
+
+## Building
+
+To build the project, run the following command:
+
+```sh
+pnpm run build
+```
+
+## Testing
+
+To run the tests, use the following command:
+
+```sh
+pnpm run test
+```
+
+## Linting
+
+To lint the code, run the following command:
+
+```sh
+pnpm run lint
+```
+
+## License
+
+This project is licensed under the MIT License.