@ekz/option 1.2.5 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 Simply get rid of all nulls in your code.
 
-This is a clone of Scala's Option class to be used with flow.js.
+This is a TypeScript port of Scala's `Option` type.
 
 # Examples
 

package/package.json

@@ -1,47 +1,44 @@
 {
   "name": "@ekz/option",
-  "version": "1.2.5",
-  "packageManager": "yarn@4.3.1",
-  "description": "Option/Maybe type to be used with flow.js",
-  "types": "index.d.ts",
-  "keywords": [
-    "option",
-    "maybe",
-    "flow",
-    "scala",
-    "type-safe"
-  ],
-  "author": {
-    "name": "Alan Heitkotter",
-    "email": "heitkotter@gmail.com"
-  },
+  "version": "2.0.0",
+  "license": "MIT",
+  "description": "Option/Maybe type for TypeScript",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/erkez/flow-option.git"
+    "url": "https://github.com/erkez/ekz.git",
+    "directory": "option"
   },
-  "bugs": {
-    "url": "https://github.com/erkez/flow-option/issues"
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
-  "homepage": "https://github.com/erkez/flow-option#readme",
-  "main": "lib/index.js",
-  "license": "MIT",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "esnext": "lib/esnext/index.js",
+  "typings": "lib/esm/index.d.ts",
   "files": [
-    "index.d.ts",
     "lib",
     "README.md",
     "LICENSE"
   ],
+  "keywords": [
+    "option",
+    "maybe",
+    "scala",
+    "type-safe"
+  ],
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-flow": "^6.23.0",
-    "documentation": "^14.0.3",
-    "flow-bin": "^0.241.0",
-    "flow-copy-source": "^2.0.9"
+    "npm-run-all": "^4.1.5",
+    "typescript": "^5.9.3"
   },
   "scripts": {
-    "build": "babel src/ -d lib/ && flow-copy-source -v src lib",
-    "docs": "documentation readme src/index.js --section=API",
-    "prepublish": "yarn run docs && yarn run build"
+    "clean": "rm -rf lib/* || true",
+    "lint": "npx eslint --ext .ts ./src/main/web",
+    "lint:fix": "yarn lint --fix",
+    "compile": "run-p \"compile:*\"",
+    "compile:esm": "tsc -p ./src/main/web --outDir ./lib/esm",
+    "compile:cjs": "tsc -p ./src/main/web -m commonjs --verbatimModuleSyntax false --outDir ./lib/cjs",
+    "compile:esnext": "tsc -p ./src/main/web -t esnext --outDir ./lib/esnext",
+    "prepublish": "yarn clean && yarn lint && yarn compile"
   }
-}
+}

package/index.d.ts

@@ -1,29 +0,0 @@
-declare module '@ekz/option' {
-
-    export class Option<A> {
-        private constructor();
-        get(): A;
-        readonly isEmpty: boolean;
-        readonly isDefined: boolean;
-        map<B>(f: (value: A) => B): Option<B>;
-        mapNullable<B>(f: (value: A) => B | null | void | undefined): Option<B>;
-        flatMap<B>(f: (value: A) => Option<B>): Option<B>;
-        forEach(f: (value: A) => any): void;
-        filter(predicate: (value: A) => boolean): Option<A>;
-        getOrElse<B>(other: () => B): A | B;
-        getOrReturn<B>(other: B): A | B;
-        getOrUndefined(): A | undefined;
-        equals<B>(other: Option<B>): boolean;
-        toJSON(): unknown;
-
-        static of<V>(value?: V | null | void | undefined): Option<V>;
-
-        static None: Option<never>;
-        static Some<A>(value: A): Option<A>;
-    }
-
-    export const None: Option<never>;
-
-    export function Some<A>(value: A): Option<A>;
-
-}

package/lib/index.js

@@ -1,254 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
-exports.Some = Some;
-
-function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-var PrivateToken = Symbol('Option');
-
-/**
- * Represents optional values. Instances of Option are either an instance of Some or the object None.
- */
-
-var Option = exports.Option = function () {
-    /**
-     * Returns the option's value.
-     */
-    function Option($privateToken) {
-        _classCallCheck(this, Option);
-
-        if ($privateToken !== PrivateToken) {
-            throw new Error('Option cannot be manually instantiated. Use Option.of, Some or None.');
-        }
-    }
-
-    /**
-     * Returns true if the option is an instance of Some, false otherwise.
-     */
-
-
-    /**
-     * Returns true if the option is None, false otherwise.
-     */
-
-
-    _createClass(Option, [{
-        key: 'map',
-
-
-        /**
-         * Returns a Some containing the result of applying f to this Option's value if this Option is nonempty.
-         */
-        value: function map(f) {
-            return this.isEmpty ? None : Some(f(this.get()));
-        }
-
-        /**
-         * Like map, but if resulting value is null, then returns None.
-         */
-
-    }, {
-        key: 'mapNullable',
-        value: function mapNullable(f) {
-            return this.isEmpty ? None : Option.of(f(this.get()));
-        }
-
-        /**
-         * 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).
-         */
-
-    }, {
-        key: 'flatMap',
-        value: function flatMap(f) {
-            return this.isEmpty ? None : f(this.get());
-        }
-
-        /**
-         * Apply the given procedure f to the option's value, if it is nonempty.
-         */
-
-    }, {
-        key: 'forEach',
-        value: function forEach(f) {
-            if (!this.isEmpty) {
-                f(this.get());
-            }
-        }
-
-        /**
-         * Returns this Option if it is nonempty and applying the predicate to this Option's value returns true.
-         */
-
-    }, {
-        key: 'filter',
-        value: function filter(predicate) {
-            return this.isEmpty || predicate(this.get()) ? this : None;
-        }
-
-        /**
-         * Returns the option's value if the option is nonempty, otherwise return the result of evaluating other.
-         */
-
-    }, {
-        key: 'getOrElse',
-        value: function getOrElse(other) {
-            return this.isEmpty ? other() : this.get();
-        }
-
-        /**
-         * Returns the option's value if the option is nonempty, otherwise return other.
-         */
-
-    }, {
-        key: 'getOrReturn',
-        value: function getOrReturn(other) {
-            return this.isEmpty ? other : this.get();
-        }
-
-        /**
-         * Returns the option's value if the option is nonempty, otherwise returns undefined.
-         */
-
-    }, {
-        key: 'getOrUndefined',
-        value: function getOrUndefined() {
-            return this.isEmpty ? undefined : this.get();
-        }
-
-        /**
-         * Compares the option's value with other option's value and returns true when they match. None always matches other None.
-         */
-
-    }, {
-        key: 'equals',
-        value: function equals(other) {
-            return this.isDefined && other.isDefined ? this.get() === other.get() : this === other;
-        }
-
-        /**
-         * Returns value if present, null otherwise. If value contains a method `toJSON`,
-         * returns the result of method call.
-         */
-
-    }, {
-        key: 'toJSON',
-        value: function toJSON() {
-            var value = this.getOrReturn(null);
-
-            if (value != null && typeof value.toJSON === 'function') {
-                // $FlowFixMe
-                return value.toJSON();
-            } else {
-                return value;
-            }
-        }
-
-        /**
-         * An Option factory which creates Some(x) if the argument is not null, and None if it is null.
-         */
-
-    }, {
-        key: 'isDefined',
-        get: function get() {
-            return !this.isEmpty;
-        }
-    }], [{
-        key: 'of',
-        value: function of(value) {
-            return value == null ? None : Some(value);
-        }
-
-        /**
-         * The empty None object
-         */
-
-
-        /**
-         * Creates Some(x). Note that Some(null) is valid.
-         */
-
-    }]);
-
-    return Option;
-}();
-
-var $None = function (_Option) {
-    _inherits($None, _Option);
-
-    function $None() {
-        _classCallCheck(this, $None);
-
-        return _possibleConstructorReturn(this, ($None.__proto__ || Object.getPrototypeOf($None)).apply(this, arguments));
-    }
-
-    _createClass($None, [{
-        key: 'get',
-        value: function get() {
-            throw new Error('No such element');
-        }
-    }, {
-        key: 'isEmpty',
-        get: function get() {
-            return true;
-        }
-    }]);
-
-    return $None;
-}(Option);
-
-/** 
- * The empty None object.
- */
-
-
-var None = exports.None = new $None(PrivateToken);
-
-Option.None = None;
-
-var $Some = function (_Option2) {
-    _inherits($Some, _Option2);
-
-    function $Some(value) {
-        _classCallCheck(this, $Some);
-
-        var _this2 = _possibleConstructorReturn(this, ($Some.__proto__ || Object.getPrototypeOf($Some)).call(this, PrivateToken));
-
-        _this2._value = value;
-        return _this2;
-    }
-
-    _createClass($Some, [{
-        key: 'get',
-        value: function get() {
-            return this._value;
-        }
-    }, {
-        key: 'isEmpty',
-        get: function get() {
-            return false;
-        }
-    }]);
-
-    return $Some;
-}(Option);
-
-/**
- * Creates Some(x). Note that Some(null) is valid.
- */
-
-
-function Some(value) {
-    return new $Some(value);
-}
-
-Option.Some = Some;

package/lib/index.js.flow

@@ -1,172 +0,0 @@
-// @flow
-'use strict';
-
-const PrivateToken = Symbol('Option');
-
-/**
- * Represents optional values. Instances of Option are either an instance of Some or the object None.
- */
-export class Option<+A> {
-    /**
-     * Returns the option's value.
-     */
-    +get: () => A;
-
-    /**
-     * Returns true if the option is None, false otherwise.
-     */
-    +isEmpty: boolean;
-
-    constructor($privateToken: typeof PrivateToken) {
-        if ($privateToken !== PrivateToken) {
-            throw new Error('Option cannot be manually instantiated. Use Option.of, Some or None.');
-        }
-    }
-
-    /**
-     * Returns true if the option is an instance of Some, false otherwise.
-     */
-    get isDefined(): boolean {
-        return !this.isEmpty;
-    }
-
-    /**
-     * Returns a Some containing the result of applying f to this Option's value if this Option is nonempty.
-     */
-    map<B>(f: A => B): Option<B> {
-        return this.isEmpty ? None : Some(f(this.get()));
-    }
-
-    /**
-     * Like map, but if resulting value is null, then returns None.
-     */
-    mapNullable<B>(f: A => ?B): Option<B> {
-        return this.isEmpty ? None : Option.of(f(this.get()));
-    }
-
-    /**
-     * 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).
-     */
-    flatMap<B>(f: A => Option<B>): Option<B> {
-        return this.isEmpty ? None : f(this.get());
-    }
-
-    /**
-     * Apply the given procedure f to the option's value, if it is nonempty.
-     */
-    forEach(f: A => any): void {
-        if (!this.isEmpty) {
-            f(this.get());
-        }
-    }
-
-    /**
-     * Returns this Option if it is nonempty and applying the predicate to this Option's value returns true.
-     */
-    filter(predicate: A => boolean): Option<A> {
-        return this.isEmpty || predicate(this.get()) ? this : None;
-    }
-
-    /**
-     * Returns the option's value if the option is nonempty, otherwise return the result of evaluating other.
-     */
-    getOrElse<B>(other: () => B): A | B {
-        return this.isEmpty ? other() : this.get();
-    }
-
-    /**
-     * Returns the option's value if the option is nonempty, otherwise return other.
-     */
-    getOrReturn<B>(other: B): A | B {
-        return this.isEmpty ? other : this.get();
-    }
-
-    /**
-     * Returns the option's value if the option is nonempty, otherwise returns undefined.
-     */
-    getOrUndefined(): A | void {
-        return this.isEmpty ? undefined : this.get();
-    }
-
-    /**
-     * Compares the option's value with other option's value and returns true when they match. None always matches other None.
-     */
-    equals<B>(other: Option<B>): boolean {
-        return this.isDefined && other.isDefined ? this.get() === other.get() : this === other;
-    }
-
-    /**
-     * Returns value if present, null otherwise. If value contains a method `toJSON`,
-     * returns the result of method call.
-     */
-    toJSON(): mixed {
-        let value = this.getOrReturn(null);
-        
-        if (value != null && typeof value.toJSON === 'function') {
-            // $FlowFixMe
-            return value.toJSON();
-        } else {
-            return value;
-        }
-    }
-
-    /**
-     * An Option factory which creates Some(x) if the argument is not null, and None if it is null.
-     */
-    static of<V>(value?: ?V): Option<V> {
-        return value == null ? None : Some(value);
-    }
-
-    /**
-     * The empty None object
-     */
-    static None: Option<empty>;
-
-    /**
-     * Creates Some(x). Note that Some(null) is valid.
-     */
-    static Some: <A>(value: A) => Option<A>;
-}
-
-class $None extends Option<empty> {
-    get() {
-        throw new Error('No such element');
-    }
-
-    get isEmpty(): boolean {
-        return true;
-    }
-}
-
-/** 
- * The empty None object.
- */
-export const None: Option<empty> = new $None(PrivateToken);
-
-Option.None = None;
-
-class $Some<A> extends Option<A> {
-    _value: A;
-
-    constructor(value: A) {
-        super(PrivateToken);
-        this._value = value;
-    }
-
-    get(): A {
-        return this._value;
-    }
-
-    get isEmpty(): boolean {
-        return false;
-    }
-}
-
-/**
- * Creates Some(x). Note that Some(null) is valid.
- */
-export function Some<+A>(value: A): Option<A> {
-    return new $Some(value);
-}
-
-Option.Some = Some;