Implement new combinator, add documentation and, rename insideOut to evert

Author: sebastienfilion

.github/document.sh

@@ -0,0 +1,5 @@
+export FL_TITLE="Functional"
+export FL_DESCRIPTION="Common Functional Programming Algebraic data types for JavaScript that is compatible with most modern browsers and Deno."
+export FL_VERSION="v1.3.0"
+
+deno run --allow-all --unstable ../@functional:generate-documentation/cli.js document "$FL_TITLE" "$FL_DESCRIPTION" $FL_VERSION ./.github/readme-fragment-usage.md ./library/*.js ./.github/readme-fragment-typescript.md ./.github/readme-fragment-license.md

.github/fl-logo.svg

@@ -0,0 +1,9 @@
+## License
+
+Copyright © 2020 - Sebastien Filion
+
+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.

.github/readme-fragment-license.md

@@ -0,0 +1,23 @@
+## TypeScript
+
+You can import any types or the factories through `mod.ts`.
+
+```ts
+import {
+  Either,
+  IO,
+  Maybe,
+  Pair,
+  Task,
+  factorizeType,
+  factorySumType
+} from "https://deno.land/x/[email protected]/mod.ts";
+```
+
+Or, you can import individual sub-module with the appropriate TypeScript hint in Deno.
+
+```ts
+// @deno-types="https://deno.land/x/[email protected]/library/Either.d.ts"
+import Either from "https://deno.land/x/[email protected]/library/Either.js";
+```
+ 

.github/readme-fragment-typescript.md

@@ -0,0 +1,63 @@
+## Usage
+
+This example uses the [Ramda library](https://ramdajs.com) - for simplification - but you should be able to use any library that implements
+the [Fantasy-land specifications](https://github.com/fantasyland/fantasy-land).
+
+```js
+import { compose, converge, curry, map, prop } from "https://deno.land/x/[email protected]/mod.ts";
+import Either from "https://deno.land/x/[email protected]/library/Either.js";
+import Task from "https://deno.land/x/[email protected]/library/Task.js";
+
+const fetchUser = userID => Task.wrap(_ => fetch(`${URL}/users/${userID}`).then(response => response.json()));
+
+const sayHello = compose(
+  map(
+    converge(
+      curry((username, email) => `Hello ${username} (${email})!`),
+      [
+        prop("username"),
+        prop("email")
+      ]
+    )
+  ),
+  fetchUser
+);
+
+// Calling `sayHello` results in an instance of `Task` keeping the function pure.
+assert(Task.is(sayHello(userID)));
+
+// Finally, calling `Task#run` will call `fetch` and return a promise
+sayHello(userID).run()
+  .then(container => {
+    // The returned value should be an instance of `Either.Right` or `Either.Left`
+    assert(Either.Right.is(container));
+    // Forcing to coerce the container to string will show that the final value is our message.
+    assert(container.toString(), `Either.Right("Hello johndoe ([email protected])!")`);
+  });
+
+// await sayHello(userID).run() === Either.Right(String)
+```
+
+### Using the bundle
+
+As a convenience, when using Functional in the browser, you can use the **unminified** bundled copy.
+
+```js
+import { compose, converge, lift, map, prop } from "https://deno.land/x/[email protected]/mod.ts";
+import { Either, Task } from "https://deno.land/x/[email protected]/functional.js";
+
+const fetchUser = userID => Task.wrap(_ => fetch(`${URL}/users/${userID}`).then(response => response.json()));
+
+const sayHello = compose(
+  map(
+    converge(
+      curry((username, email) => `Hello ${username} (${email})!`),
+      [
+        prop("username"),
+        prop("email")
+      ]
+    )
+  ),
+  fetchUser
+);
+```