@ekz/option 2.0.0 → 2.0.1

package/README.md

@@ -1,242 +1,23 @@
-# Description
+# @ekz/option
 
-Simply get rid of all nulls in your code.
+Option/Maybe type for TypeScript — a port of Scala's `Option`.
 
-This is a TypeScript port of Scala's `Option` type.
+**Documentation:** [https://docs.ekz.io/option/](https://docs.ekz.io/option/)
 
-# Examples
+## Install
 
-```javascript
-// @flow
-
-let valueA = Option.of(null).map(x => x + 2).getOrElse(() => 0);
-// valueA = 0
-
-let valueB = Some('any object').flatMap(x => Some(`${x}!!!`)).getOrUndefined();
-// valueB = 'any object!!!'
-
-let valueC = Some(null).flatMap(() => Option.of(2)).map(x => x * 3).getOrElse(() => 0);
-// valueC = 6
-
-let valueD = Some(1).mapNullable(() => null).getOrReturn(-1);
-// valueD = -1
-
-Some(1).equals(Some(1))
-// true
-
-None.equals(None)
-// true
-
-Some('abc').equals(None)
-// false
-
-None.isDefined; // false
-Some(1).isDefined; // true
-Some(1).isEmpty; // false
-Some(null).isEmpty; // false! Option<null> is valid!
-
-Some('foo').get(); // 'foo'
-None.get(); // throws an error, use getOrElse or getOrUndefined instead
-
-Some(3).filter(x => x % 2 === 0); // None
-
-Some('bar').forEach(x => {
-    console.log(`my value: ${x}`);
-});
+```bash
+npm install @ekz/option
 ```
 
-# API
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
-*   [Option](#option)
-    *   [Parameters](#parameters)
-    *   [get](#get)
-    *   [isEmpty](#isempty)
-    *   [isDefined](#isdefined)
-    *   [map](#map)
-        *   [Parameters](#parameters-1)
-    *   [mapNullable](#mapnullable)
-        *   [Parameters](#parameters-2)
-    *   [flatMap](#flatmap)
-        *   [Parameters](#parameters-3)
-    *   [forEach](#foreach)
-        *   [Parameters](#parameters-4)
-    *   [filter](#filter)
-        *   [Parameters](#parameters-5)
-    *   [getOrElse](#getorelse)
-        *   [Parameters](#parameters-6)
-    *   [getOrReturn](#getorreturn)
-        *   [Parameters](#parameters-7)
-    *   [getOrUndefined](#getorundefined)
-    *   [equals](#equals)
-        *   [Parameters](#parameters-8)
-    *   [toJSON](#tojson)
-    *   [of](#of)
-        *   [Parameters](#parameters-9)
-    *   [None](#none)
-    *   [Some](#some)
-*   [None](#none-1)
-*   [Some](#some-1)
-    *   [Parameters](#parameters-10)
-
-## Option
-
-Represents optional values. Instances of Option are either an instance of Some or the object None.
-
-### Parameters
-
-*   `$privateToken` **any**&#x20;
-
-### get
-
-Returns the option's value.
-
-Type: function (): A
-
-### isEmpty
-
-Returns true if the option is None, false otherwise.
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-### isDefined
-
-Returns true if the option is an instance of Some, false otherwise.
-
-Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
-
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
-
-### map
-
-Returns a Some containing the result of applying f to this Option's value if this Option is nonempty.
-
-#### Parameters
-
-*   `f` **function (A): B**&#x20;
-
-Returns **[Option](#option)\<B>**&#x20;
-
-### mapNullable
-
-Like map, but if resulting value is null, then returns None.
-
-#### Parameters
-
-*   `f` **function (A): B?**&#x20;
-
-Returns **[Option](#option)\<B>**&#x20;
-
-### flatMap
-
-Returns the result of applying f to this Option's value if this Option is nonempty. Returns None if this Option is empty. Slightly different from map in that f is expected to return an Option (which could be None).
-
-#### Parameters
-
-*   `f` **function (A): [Option](#option)\<B>**&#x20;
-
-Returns **[Option](#option)\<B>**&#x20;
-
-### forEach
-
-Apply the given procedure f to the option's value, if it is nonempty.
+## Quick example
 
-#### Parameters
+```typescript
+import { Option, Some, None } from '@ekz/option';
 
-*   `f` **function (A): any**&#x20;
+const label = Option.of(maybeName).map((n) => n.trim()).getOrElse(() => 'Anonymous');
 
-Returns **void**&#x20;
-
-### filter
-
-Returns this Option if it is nonempty and applying the predicate to this Option's value returns true.
-
-#### Parameters
-
-*   `predicate` **function (A): [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
-
-Returns **[Option](#option)\<A>**&#x20;
-
-### getOrElse
-
-Returns the option's value if the option is nonempty, otherwise return the result of evaluating other.
-
-#### Parameters
-
-*   `other` **function (): B**&#x20;
-
-Returns **(A | B)**&#x20;
-
-### getOrReturn
-
-Returns the option's value if the option is nonempty, otherwise return other.
-
-#### Parameters
-
-*   `other` **B**&#x20;
-
-Returns **(A | B)**&#x20;
-
-### getOrUndefined
-
-Returns the option's value if the option is nonempty, otherwise returns undefined.
-
-Returns **(A | void)**&#x20;
-
-### equals
-
-Compares the option's value with other option's value and returns true when they match. None always matches other None.
-
-#### Parameters
-
-*   `other` **[Option](#option)\<B>**&#x20;
-
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
-
-### toJSON
-
-Returns value if present, null otherwise. If value contains a method `toJSON`,
-returns the result of method call.
-
-Returns **any**&#x20;
-
-### of
-
-An Option factory which creates Some(x) if the argument is not null, and None if it is null.
-
-#### Parameters
-
-*   `value` **V??**&#x20;
-
-Returns **[Option](#option)\<V>**&#x20;
-
-### None
-
-The empty None object
-
-Type: [Option](#option)\<any>
-
-### Some
-
-Creates Some(x). Note that Some(null) is valid.
-
-Type: function (value: A): [Option](#option)\<A>
-
-## None
-
-The empty None object.
-
-Type: [Option](#option)\<any>
-
-## Some
-
-Creates Some(x). Note that Some(null) is valid.
-
-### Parameters
-
-*   `value` **A**&#x20;
+Some(1).flatMap((n) => (n > 0 ? Some(n) : None)); // Some(1)
+```
 
-Returns **[Option](#option)\<A>**&#x20;
+See the [docs](https://docs.ekz.io/option/) for constructors, transformations, and safe unwrapping.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@ekz/option",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "MIT",
   "description": "Option/Maybe type for TypeScript",
+  "homepage": "https://docs.ekz.io/option/",
   "repository": {
     "type": "git",
     "url": "https://github.com/erkez/ekz.git",
@@ -29,11 +30,11 @@
   ],
   "devDependencies": {
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "clean": "rm -rf lib/* || true",
-    "lint": "npx eslint --ext .ts ./src/main/web",
+    "lint": "npx eslint ./src/main/web",
     "lint:fix": "yarn lint --fix",
     "compile": "run-p \"compile:*\"",
     "compile:esm": "tsc -p ./src/main/web --outDir ./lib/esm",