diff --git a/docs/api/v2.0.0/en/-built-in-.constructor.html b/docs/api/v2.0.0/en/-built-in-.constructor.html index ba0c6c1..0def32f 100644 --- a/docs/api/v2.0.0/en/-built-in-.constructor.html +++ b/docs/api/v2.0.0/en/-built-in-.constructor.html @@ -8,7 +8,7 @@

Array

Documentation

Module
(built-in)
Platforms
  • ECMAScript
Authors
Authors
    Maintainers
      + + + \ No newline at end of file diff --git a/docs/api/v2.0.0/en/folktale.concurrency.task.fromnodeback.html b/docs/api/v2.0.0/en/folktale.concurrency.task.fromnodeback.html index 2adbcc1..452f82a 100644 --- a/docs/api/v2.0.0/en/folktale.concurrency.task.fromnodeback.html +++ b/docs/api/v2.0.0/en/folktale.concurrency.task.fromnodeback.html @@ -8,7 +8,7 @@

      fromNodeback

      A convenience method for the folktale/conversions/nodeback-to-task module.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      fromNodeback(aNodeback)
      forall s, e:
      diff --git a/docs/api/v2.0.0/en/folktale.concurrency.task.frompromised.html b/docs/api/v2.0.0/en/folktale.concurrency.task.frompromised.html
      index c8a4f16..0cfc99d 100644
      --- a/docs/api/v2.0.0/en/folktale.concurrency.task.frompromised.html
      +++ b/docs/api/v2.0.0/en/folktale.concurrency.task.frompromised.html
      @@ -8,7 +8,7 @@
         
         
           
           

      fromPromised

      Converts a Promise-yielding function to a Task-yielding function.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      fromPromised(aPromiseFn)
      forall e, v:
      diff --git a/docs/api/v2.0.0/en/folktale.concurrency.task.html b/docs/api/v2.0.0/en/folktale.concurrency.task.html
      index 1d2d359..1c5d9cd 100644
      --- a/docs/api/v2.0.0/en/folktale.concurrency.task.html
      +++ b/docs/api/v2.0.0/en/folktale.concurrency.task.html
      @@ -8,7 +8,7 @@
         
         
           
           

      module folktale/concurrency/task

      A data structure that models asynchronous actions, supporting safe cancellation and automatic resource handling.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Documentation

      A data structure that models asynchronous actions, supporting safe cancellation and automatic resource handling.

      @@ -274,6 +274,7 @@

      Choosing the first of N tasks

      Experimental
      task(computation)

      Constructs a Task and associates a computation to it. The computation is executed every time the Task is ran, and should provide the result of the task: a success or failure along with its value.

      Experimental

      Converting from function with Node-style callback

      fromNodeback(aNodeback)

      A convenience method for the folktale/conversions/nodeback-to-task module.

      Experimental

      Converting from other types

      fromPromised(aPromiseFn)

      Converts a Promise-yielding function to a Task-yielding function.

      +
      Experimental

      Sequencing tasks

      do: taskDo(generator)

      Allows using a direct style of programming (similar to async/await for Promises) to sequence Tasks. The function must return a Task.

      Experimental

      Types

      _Task: Task(computation)

      Tasks model asynchronous processes with automatic resource handling. They are generally constructed with the task function.

      Experimental
      _TaskExecution()

      Represents the execution of a Task, with methods to cancel it, react to its results, and retrieve its eventual value. TaskExecution objects aren't created @@ -285,6 +286,7 @@

      Choosing the first of N tasks

      task: require('./task'), waitAny: require('./wait-any'), waitAll: require('./wait-all'), + do: require('./do'), _Task: Task, _TaskExecution: require('./_task-execution'), @@ -315,7 +317,7 @@

      Choosing the first of N tasks

    • Running tasks

    • Combining tasks concurrently

    • Error handling

      -
    • Properties
    • Source Code
    • Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      +
    • Properties
    • Source Code
    • Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      + + + \ No newline at end of file diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.filter.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.filter.html new file mode 100644 index 0000000..9760567 --- /dev/null +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.filter.html @@ -0,0 +1,53 @@ + + + + + filter + + + + + +

      filter

      If the Maybe is a Just, passes its value to the predicate. If the predicate +returns true, then the Maybe is returned unchanged. In every other case, +a Nothing gets returned.

      +
      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a: (Maybe a).((a) => Boolean) => Maybe a

      Documentation

      If the Maybe is a Just, passes its value to the predicate. If the predicate +returns true, then the Maybe is returned unchanged. In every other case, +a Nothing gets returned.

      +

      Example:

      +
      const Maybe = require('folktale/maybe');
      +
      +// This line evaluates to true.
      +Maybe.Just.hasInstance(Maybe.Just(3).filter(n => n === 3));
      +
      +// These lines evaluates to false.
      +Maybe.Just.hasInstance(Maybe.Just(2).filter(n => n === 3));
      +Maybe.Just.hasInstance(Maybe.Nothing().filter(n => n !== 3));
      +Maybe.Just.hasInstance(Maybe.Nothing().filter(n => n === 3));
      +

      Properties

      Source Code

      Defined in source/maybe/maybe.js at line 57, column 18
      {
      +    /*~*/
      +    Nothing: function filter(predicate) {
      +      assertFunction('Maybe.Nothing#filter', predicate);
      +      return this;
      +    },
      +
      +    /*~*/
      +    Just: function filter(predicate) {
      +      assertFunction('Maybe.Just#filter', predicate);
      +      return predicate(this.value) ? this : Nothing();
      +    }
      +  }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/maybe/maybe
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      + + + + \ No newline at end of file diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.fold-1.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.fold-1.html index d4c9c82..085c8be 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.fold-1.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.fold-1.html @@ -8,7 +8,7 @@

      fold

      Applies a function to each variant of the Maybe structure.

      Signature

      forall a, b: (Maybe a).(() => b, (a) => b) => b

      Documentation

      Applies a function to each variant of the Maybe structure.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.fold.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.fold.html index d4c9c82..085c8be 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.fold.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.fold.html @@ -8,7 +8,7 @@

      fold

      Applies a function to each variant of the Maybe structure.

      Signature

      forall a, b: (Maybe a).(() => b, (a) => b) => b

      Documentation

      Applies a function to each variant of the Maybe structure.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.get.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.get.html index 3b7fc65..00e42ce 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.get.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.get.html @@ -8,7 +8,7 @@

      get

      This method has been renamed to unsafeGet().

      Deprecated since 2.0.0

      We want to discourage the use of partial functions, and having short names @@ -16,7 +16,7 @@ problems.

      For more details see https://github.com/origamitower/folktale/issues/42

      Signature

      get()
      forall a: (Maybe a).() => a :: (throws TypeError)

      Documentation

      This method has been renamed to unsafeGet().

      -

      Properties

      Source Code

      Defined in source/maybe/maybe.js at line 249, column 21
      'get'() {
      +

      Properties

      Source Code

      Defined in source/maybe/maybe.js at line 268, column 21
      'get'() {
           warnDeprecation('`.get()` is deprecated, and has been renamed to `.unsafeGet()`.');
           return this.unsafeGet();
         }
      Stability
      deprecated
      Licence
      MIT
      Module
      folktale/maybe/maybe
      On This Page
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse-1.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse-1.html index 6f027db..17d7668 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse-1.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse-1.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Maybe structure, if it exists (i.e.: is a Just), otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse.html index 6f027db..17d7668 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.getorelse.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Maybe structure, if it exists (i.e.: is a Just), otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect-1.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect-1.html index 9ee26a4..ce55731 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect-1.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect-1.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Nothing variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Nothing variant.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect.html index fb03905..bb7bf83 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.inspect.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Just variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Just variant.

      diff --git a/docs/api/v2.0.0/en/folktale.maybe.maybe.just.html b/docs/api/v2.0.0/en/folktale.maybe.maybe.just.html index caed043..8a60c59 100644 --- a/docs/api/v2.0.0/en/folktale.maybe.maybe.just.html +++ b/docs/api/v2.0.0/en/folktale.maybe.maybe.just.html @@ -8,7 +8,7 @@

      Just

      Constructs a Maybe value that represents a successful value (a Just).

      Signature

      Just(value)
      forall a: (a) => Maybe a

      Documentation

      Constructs a Maybe value that represents a successful value (a Just).

      @@ -26,11 +26,15 @@
      prototype

      The container for instance methods for Just variants of the Maybe structure.

      get tag

      The tag for this variant, unique among the Maybe variants.

      get type

      The type for this variant, unique among Folktale data structures (and ideally unique among all unions in your application, as its used for type checking).

      -

      Instance (prototype) properties

      Comparing and testing

      equals(value)

      Performs a deep-comparison of two Maybe values for equality. See adt/union/derivations/equality for details.

      +

      Instance (prototype) properties

      Combining

      concat()

      Combines two maybes such that if they both have values (are a Just) their values +are concatenated. Maybe values are expected to be Fantasy Land 1.x semigroups and +implement a concat method.

      +

      Comparing and testing

      equals(value)

      Performs a deep-comparison of two Maybe values for equality. See adt/union/derivations/equality for details.

      Experimental
      hasInstance(value)

      Tests if an arbitrary value is a Maybe instance.

      Inherited
      get isJust

      True if the value is a Just instance.

      -
      Deprecated

      Constructing

      of(value)

      Constructs a Maybe value that represents a successful value (a Just).

      -
      Inherited

      Constructing funtion

      empty()
      Inherited

      Converting to other types

      toResult(fallbackValue)

      A convenience method for the folktale/conversions/maybe-to-result module.

      +
      Deprecated

      Constructing

      empty()

      Constructs a Maybe containing no value (a Nothing).

      +
      Inherited
      of(value)

      Constructs a Maybe value that represents a successful value (a Just).

      +
      Inherited

      Converting to other types

      toResult(fallbackValue)

      A convenience method for the folktale/conversions/maybe-to-result module.

      ExperimentalInherited
      toValidation(fallbackValue)

      A convenience method for the folktale/conversions/maybe-to-validation module.

      ExperimentalInherited

      Data fields

      get value

      The value contained in a Just instance of the Maybe structure.

      Abstract

      Debugging

      inspect: toString()

      A textual representation for Maybe instances.

      @@ -43,6 +47,7 @@
      fantasy-land/ap(that)

      Part of the Applicative instance for Fantasy Land 2.x+. See the apply method for details.

      fantasy-land/chain(transformation)

      Part of the Monad instance for Fantasy Land 2.x+. See the chain method for details.

      fantasy-land/concat(that)

      Part of the Semigroup instance for Fantasy Land 2.x+. See the concat method for details.

      +
      fantasy-land/empty()

      Part of the Monoid instance for Fantasy Land 2.x+. See the empty method for details.

      fantasy-land/equals(that)

      Part of the Setoid instance for Fantasy Land 2.x+. See the equals method for details.

      fantasy-land/map(transformation)

      Part of the Functor instance for Fantasy Land 2.x+. See the map method for details.

      fantasy-land/of(value)

      Part of the Applicative instance for Fantasy Land 2.x+. See the of method for details.

      @@ -64,14 +69,17 @@
      chain()

      Transforms an entire Maybe structure with the provided function. As with .map(), the transformation is only applied if the value is a Just, but unlike .map() the transformation is expected to return a new Maybe value.

      -
      map()

      Transforms the value inside a Maybe structure with an unary function. Only +

      filter()

      If the Maybe is a Just, passes its value to the predicate. If the predicate +returns true, then the Maybe is returned unchanged. In every other case, +a Nothing gets returned.

      +
      Experimental
      map()

      Transforms the value inside a Maybe structure with an unary function. Only transforms values that are successful (Just), and constructs a new Maybe as a result.

      Variants

      Just(value)

      Constructs a Maybe value that represents a successful value (a Just).

      Inherited
      Nothing()

      Constructs a Maybe value that represents a failure (a Nothing).

      -
      Inherited

      Source Code

      Just(value) {
      +
      Inherited

      Source Code

      Just(value) {
           return { value };
      -  }
      Stability
      stable
      Licence
      MIT
      Module
      folktale/maybe/maybe
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      + }
      Stability
      stable
      Licence
      MIT
      Module
      folktale/maybe/maybe
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      + + + \ No newline at end of file diff --git a/docs/api/v2.0.0/en/folktale.result.result.filter.html b/docs/api/v2.0.0/en/folktale.result.result.filter.html new file mode 100644 index 0000000..d3ccf62 --- /dev/null +++ b/docs/api/v2.0.0/en/folktale.result.result.filter.html @@ -0,0 +1,53 @@ + + + + + filter + + + + + +

      filter

      If the Result is a Ok, passes its value to the predicate. If the predicate +returns true, then the Result is returned unchanged. In every other case, +an Error gets returned.

      +
      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a: (Maybe a).((a) => Boolean) => Maybe a

      Documentation

      If the Result is a Ok, passes its value to the predicate. If the predicate +returns true, then the Result is returned unchanged. In every other case, +an Error gets returned.

      +

      Example:

      +
      const Result = require('folktale/result');
      +
      +// This line evaluates to true.
      +Result.Ok.hasInstance(Result.Ok(3).filter(n => n === 3));
      +
      +// These lines evaluates to false.
      +Result.Ok.hasInstance(Result.Ok(2).filter(n => n === 3));
      +Result.Ok.hasInstance(Result.Error(3).filter(n => n !== 3));
      +Result.Ok.hasInstance(Result.Error(3).filter(n => n === 3));
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 75, column 19
      {
      +    /*~*/
      +    Error: function filter(predicate) {
      +      assertFunction('Result.Error#filter', predicate);
      +      return this;
      +    },
      +
      +    /*~*/
      +    Ok: function filter(predicate) {
      +      assertFunction('Result.Ok#filter', predicate);
      +      return predicate(this.value) ? this : Error();
      +    }
      +  }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/result/result
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      + + + + \ No newline at end of file diff --git a/docs/api/v2.0.0/en/folktale.result.result.fold-1.html b/docs/api/v2.0.0/en/folktale.result.result.fold-1.html index 25e792d..d14591e 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.fold-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.fold-1.html @@ -8,7 +8,7 @@

      fold

      Applies a function to each case of a Result.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.fold.html b/docs/api/v2.0.0/en/folktale.result.result.fold.html
      index 25e792d..d14591e 100644
      --- a/docs/api/v2.0.0/en/folktale.result.result.fold.html
      +++ b/docs/api/v2.0.0/en/folktale.result.result.fold.html
      @@ -8,7 +8,7 @@
         
         
           
           

      fold

      Applies a function to each case of a Result.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.get.html b/docs/api/v2.0.0/en/folktale.result.result.get.html
      index ffba213..3b3d0aa 100644
      --- a/docs/api/v2.0.0/en/folktale.result.result.get.html
      +++ b/docs/api/v2.0.0/en/folktale.result.result.get.html
      @@ -8,7 +8,7 @@
         
         
           
           

      get

      This method has been renamed to unsafeGet().

      Deprecated since 2.0.0

      We want to discourage the use of partial functions, and having short names @@ -16,7 +16,7 @@ problems.

      For more details see https://github.com/origamitower/folktale/issues/42

      Signature

      get()
      forall a, b: (Result a b).() => b :: (throws TypeError)

      Documentation

      This method has been renamed to unsafeGet().

      -

      Properties

      Source Code

      Defined in source/result/result.js at line 307, column 22
      'get'() {
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 327, column 22
      'get'() {
           warnDeprecation('`.get()` is deprecated, and has been renamed to `.unsafeGet()`.');
           return this.unsafeGet();
         }
      Stability
      deprecated
      Licence
      MIT
      Module
      folktale/result/result
      On This Page
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.getorelse-1.html b/docs/api/v2.0.0/en/folktale.result.result.getorelse-1.html index dd57a02..ffb53fc 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.getorelse-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.getorelse-1.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Result structure, if it exists (i.e.: is an Ok), otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.getorelse.html b/docs/api/v2.0.0/en/folktale.result.result.getorelse.html index dd57a02..ffb53fc 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.getorelse.html +++ b/docs/api/v2.0.0/en/folktale.result.result.getorelse.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Result structure, if it exists (i.e.: is an Ok), otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.inspect-1.html b/docs/api/v2.0.0/en/folktale.result.result.inspect-1.html index 22abb83..6da076a 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.inspect-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.inspect-1.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Ok variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Ok variant.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.inspect.html b/docs/api/v2.0.0/en/folktale.result.result.inspect.html index 6afddef..72dc1be 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.inspect.html +++ b/docs/api/v2.0.0/en/folktale.result.result.inspect.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Error variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Error variant.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.map-1.html b/docs/api/v2.0.0/en/folktale.result.result.map-1.html index c00b973..ba829ba 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.map-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.map-1.html @@ -8,7 +8,7 @@

      map

      Transforms the value inside of a Result structure with an unary function without changing the context of the computation. That is, Error values continue to be diff --git a/docs/api/v2.0.0/en/folktale.result.result.map.html b/docs/api/v2.0.0/en/folktale.result.result.map.html index c00b973..ba829ba 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.map.html +++ b/docs/api/v2.0.0/en/folktale.result.result.map.html @@ -8,7 +8,7 @@

      map

      Transforms the value inside of a Result structure with an unary function without changing the context of the computation. That is, Error values continue to be diff --git a/docs/api/v2.0.0/en/folktale.result.result.maperror-1.html b/docs/api/v2.0.0/en/folktale.result.result.maperror-1.html index 2671d40..4f5c8e9 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.maperror-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.maperror-1.html @@ -8,7 +8,7 @@

      mapError

      Transforms the value inside an Error without changing the context of the computation.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.maperror.html b/docs/api/v2.0.0/en/folktale.result.result.maperror.html index 2671d40..4f5c8e9 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.maperror.html +++ b/docs/api/v2.0.0/en/folktale.result.result.maperror.html @@ -8,7 +8,7 @@

      mapError

      Transforms the value inside an Error without changing the context of the computation.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.merge.html b/docs/api/v2.0.0/en/folktale.result.result.merge.html index 4f2bb9e..2cfd7d6 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.merge.html +++ b/docs/api/v2.0.0/en/folktale.result.result.merge.html @@ -8,7 +8,7 @@

      merge

      Returns the value inside of the Result structure, regardless of its state.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      merge()
      forall a, b: (Result a b).() => a or b

      Documentation

      Returns the value inside of the Result structure, regardless of its state.

      @@ -20,7 +20,7 @@

      Example:

      Result.Error(1).merge(); // ==> 1 -

      Properties

      Source Code

      Defined in source/result/result.js at line 307, column 22
      merge() {
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 327, column 22
      merge() {
           return this.value;
         }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/result/result
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.of.html b/docs/api/v2.0.0/en/folktale.result.result.of.html index 9f2d66b..733f409 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.of.html +++ b/docs/api/v2.0.0/en/folktale.result.result.of.html @@ -8,7 +8,7 @@

      of

      Constructs a Result holding an Ok value.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      of(value)
      forall a, b: (b) => Result a b

      Documentation

      Constructs a Result holding an Ok value.

      @@ -17,7 +17,7 @@

      Example:

      Result.of(1); // ==> Result.Ok(1) -

      Properties

      Source Code

      Defined in source/result/result.js at line 307, column 22
      of(value) {
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 327, column 22
      of(value) {
           return Ok(value);
         }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/result/result
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.orelse-1.html b/docs/api/v2.0.0/en/folktale.result.result.orelse-1.html index ea17c73..dbe24c0 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.orelse-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.orelse-1.html @@ -8,7 +8,7 @@

      orElse

      Allows recovering from Error values with a handler function.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.orelse.html b/docs/api/v2.0.0/en/folktale.result.result.orelse.html
      index ea17c73..dbe24c0 100644
      --- a/docs/api/v2.0.0/en/folktale.result.result.orelse.html
      +++ b/docs/api/v2.0.0/en/folktale.result.result.orelse.html
      @@ -8,7 +8,7 @@
         
         
           
           

      orElse

      Allows recovering from Error values with a handler function.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.swap-1.html b/docs/api/v2.0.0/en/folktale.result.result.swap-1.html
      index 021134e..264e29e 100644
      --- a/docs/api/v2.0.0/en/folktale.result.result.swap-1.html
      +++ b/docs/api/v2.0.0/en/folktale.result.result.swap-1.html
      @@ -8,7 +8,7 @@
         
         
           
           

      swap

      Inverts the context of a Result value such that Errors are transformed into Oks, and Oks are transformed into Errors. Does not touch the value inside of the diff --git a/docs/api/v2.0.0/en/folktale.result.result.swap.html b/docs/api/v2.0.0/en/folktale.result.result.swap.html index 021134e..264e29e 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.swap.html +++ b/docs/api/v2.0.0/en/folktale.result.result.swap.html @@ -8,7 +8,7 @@

      swap

      Inverts the context of a Result value such that Errors are transformed into Oks, and Oks are transformed into Errors. Does not touch the value inside of the diff --git a/docs/api/v2.0.0/en/folktale.result.result.tomaybe.html b/docs/api/v2.0.0/en/folktale.result.result.tomaybe.html index c75bb91..7046987 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.tomaybe.html +++ b/docs/api/v2.0.0/en/folktale.result.result.tomaybe.html @@ -8,7 +8,7 @@

      toMaybe

      Transforms a Result into a Maybe. Error values are lost in the process.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toMaybe()
      forall a, b: (Result a b).() => Maybe b

      Documentation

      Transforms a Result into a Maybe. Error values are lost in the process.

      @@ -21,7 +21,7 @@

      Example:

      Result.Error(1).toMaybe(); // ==> Maybe.Nothing() -

      Properties

      Source Code

      Defined in source/result/result.js at line 307, column 22
      toMaybe() {
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 327, column 22
      toMaybe() {
           return require('folktale/conversions/result-to-maybe')(this);
         }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/result/result
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.tovalidation.html b/docs/api/v2.0.0/en/folktale.result.result.tovalidation.html index ef76667..19a7eb0 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.tovalidation.html +++ b/docs/api/v2.0.0/en/folktale.result.result.tovalidation.html @@ -8,7 +8,7 @@

      toValidation

      Transforms a Result into a Validation.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toValidation()
      forall a, b: (Result a b).() => Validation a b

      Documentation

      Transforms a Result into a Validation.

      @@ -23,7 +23,7 @@

      Example:

      Result.Error(1).toValidation(); // ==> Validation.Failure(1) -

      Properties

      Source Code

      Defined in source/result/result.js at line 307, column 22
      toValidation() {
      +

      Properties

      Source Code

      Defined in source/result/result.js at line 327, column 22
      toValidation() {
           return require('folktale/conversions/result-to-validation')(this);
         }
      Stability
      experimental
      Licence
      MIT
      Module
      folktale/result/result
      Authors
      Copyright
      (c) 2013-2017 Quildreen Motta, and CONTRIBUTORS
      Authors
      • Quildreen Motta
      Maintainers
      • Quildreen Motta <queen@robotlolita.me> (http://robotlolita.me/)
      diff --git a/docs/api/v2.0.0/en/folktale.result.result.unsafeget-1.html b/docs/api/v2.0.0/en/folktale.result.result.unsafeget-1.html index 35729e2..b437c31 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.unsafeget-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.unsafeget-1.html @@ -8,7 +8,7 @@

      unsafeGet

      Extracts the value from a Result structure.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b: (Result a b).() => b :: throws TypeError

      Documentation

      Extracts the value from a Result structure.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.unsafeget.html b/docs/api/v2.0.0/en/folktale.result.result.unsafeget.html index 35729e2..b437c31 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.unsafeget.html +++ b/docs/api/v2.0.0/en/folktale.result.result.unsafeget.html @@ -8,7 +8,7 @@

      unsafeGet

      Extracts the value from a Result structure.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      forall a, b: (Result a b).() => b :: throws TypeError

      Documentation

      Extracts the value from a Result structure.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.value-1.html b/docs/api/v2.0.0/en/folktale.result.result.value-1.html index 766e800..9946ad3 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.value-1.html +++ b/docs/api/v2.0.0/en/folktale.result.result.value-1.html @@ -8,7 +8,7 @@

      value

      The value contained in an Ok instance of the Result structure.

      Signature

      get value()
      forall a, b: get (Result a b) => b

      Documentation

      The value contained in an Ok instance of the Result structure.

      diff --git a/docs/api/v2.0.0/en/folktale.result.result.value.html b/docs/api/v2.0.0/en/folktale.result.result.value.html index f7278ee..deb3052 100644 --- a/docs/api/v2.0.0/en/folktale.result.result.value.html +++ b/docs/api/v2.0.0/en/folktale.result.result.value.html @@ -8,7 +8,7 @@

      value

      The value contained in an Error instance of the Result structure.

      Signature

      get value()
      forall a, b: get (Result a b) => a

      Documentation

      The value contained in an Error instance of the Result structure.

      diff --git a/docs/api/v2.0.0/en/folktale.result.try.try.html b/docs/api/v2.0.0/en/folktale.result.try.try.html index 6d7fa0c..533e403 100644 --- a/docs/api/v2.0.0/en/folktale.result.try.try.html +++ b/docs/api/v2.0.0/en/folktale.result.try.try.html @@ -8,7 +8,7 @@

      _try

      Runs a function that may raise an exception, trapping it. Returns an Ok with the return value of the function, if it has finished successfully, or an Error diff --git a/docs/api/v2.0.0/en/folktale.validation.collect.collect.html b/docs/api/v2.0.0/en/folktale.validation.collect.collect.html index 6ce3586..82b671a 100644 --- a/docs/api/v2.0.0/en/folktale.validation.collect.collect.html +++ b/docs/api/v2.0.0/en/folktale.validation.collect.collect.html @@ -8,7 +8,7 @@

      collect

      Combines all validation values from an array of them.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      collect(validations)
      forall a, b: (Array (Validation a b)) => Validation a b
      diff --git a/docs/api/v2.0.0/en/folktale.validation.frommaybe.html b/docs/api/v2.0.0/en/folktale.validation.frommaybe.html
      index 6a1fe9e..4b1e364 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.frommaybe.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.frommaybe.html
      @@ -8,7 +8,7 @@
         
         
           
           

      fromMaybe

      A convenience method for the folktale/conversions/maybe-to-validation module.

      Signature

      fromMaybe(aMaybe, fallbackValue)
      forall a, b: (Maybe b, a) => Validation a b

      Documentation

      A convenience method for the folktale/conversions/maybe-to-validation module.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.fromnullable.html b/docs/api/v2.0.0/en/folktale.validation.fromnullable.html index d7a286c..8e8e57b 100644 --- a/docs/api/v2.0.0/en/folktale.validation.fromnullable.html +++ b/docs/api/v2.0.0/en/folktale.validation.fromnullable.html @@ -8,7 +8,7 @@

      fromNullable

      A convenience method for the folktale/conversions/nullable-to-validation module.

      Signature

      fromNullable(aNullable, fallbackValue)
      forall a, b: (a or None, b) => Validation b a

      Documentation

      A convenience method for the folktale/conversions/nullable-to-validation module.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.fromresult.html b/docs/api/v2.0.0/en/folktale.validation.fromresult.html index 86f3a2e..c7f0642 100644 --- a/docs/api/v2.0.0/en/folktale.validation.fromresult.html +++ b/docs/api/v2.0.0/en/folktale.validation.fromresult.html @@ -8,7 +8,7 @@

      fromResult

      A convenience method for the folktale/conversions/result-to-validation module.

      Signature

      fromResult(aResult)
      forall a, b: (Result a b) => Validation a b

      Documentation

      A convenience method for the folktale/conversions/result-to-validation module.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.html b/docs/api/v2.0.0/en/folktale.validation.html index f0308e0..5afc784 100644 --- a/docs/api/v2.0.0/en/folktale.validation.html +++ b/docs/api/v2.0.0/en/folktale.validation.html @@ -8,7 +8,7 @@

      module folktale/validation

      A data structure that typically models form validations, and other scenarios where you want to aggregate all failures, rather than short-circuit if an error diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.1.html b/docs/api/v2.0.0/en/folktale.validation.validation.1.html index c5375f7..19a0cd4 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.1.html @@ -8,7 +8,7 @@

      Success

      Constructs a Validation whose value represents a success.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      Success(value)
      forall a, b: (b) => Validation a b

      Documentation

      Constructs a Validation whose value represents a success.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.apply-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.apply-1.html index 3f583bc..141a826 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.apply-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.apply-1.html @@ -8,7 +8,7 @@

      apply

      If successes, applies the function in one Validation to another. Otherwise concatenate the failures.

      Signature

      forall a, b, c: (Validation (b) => c).(Validation a b) => Validation a c

      Documentation

      If successes, applies the function in one Validation to another. Otherwise concatenate the failures.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.apply.html b/docs/api/v2.0.0/en/folktale.validation.validation.apply.html index 3f583bc..141a826 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.apply.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.apply.html @@ -8,7 +8,7 @@

      apply

      If successes, applies the function in one Validation to another. Otherwise concatenate the failures.

      Signature

      forall a, b, c: (Validation (b) => c).(Validation a b) => Validation a c

      Documentation

      If successes, applies the function in one Validation to another. Otherwise concatenate the failures.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.bimap-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.bimap-1.html index 7d54d93..787f04a 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.bimap-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.bimap-1.html @@ -8,7 +8,7 @@

      bimap

      Transforms each side of a Validation with a function, without changing the status of the validation. That is, failures will still be failures, successes will still be successes.

      Signature

      forall a, b, c, d:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.bimap.html b/docs/api/v2.0.0/en/folktale.validation.validation.bimap.html
      index 7d54d93..787f04a 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.bimap.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.bimap.html
      @@ -8,7 +8,7 @@
         
         
           
           

      bimap

      Transforms each side of a Validation with a function, without changing the status of the validation. That is, failures will still be failures, successes will still be successes.

      Signature

      forall a, b, c, d:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.concat-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.concat-1.html
      index a4ffd0e..e4f62a3 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.concat-1.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.concat-1.html
      @@ -8,7 +8,7 @@
         
         
           
           

      concat

      Combines two validations together such that failures are aggregated.

      Signature

      forall a, b:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.concat.html b/docs/api/v2.0.0/en/folktale.validation.validation.concat.html
      index a4ffd0e..e4f62a3 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.concat.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.concat.html
      @@ -8,7 +8,7 @@
         
         
           
           

      concat

      Combines two validations together such that failures are aggregated.

      Signature

      forall a, b:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.failure.html b/docs/api/v2.0.0/en/folktale.validation.validation.failure.html
      index d48bf92..b48b846 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.failure.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.failure.html
      @@ -8,7 +8,7 @@
         
         
           
           

      Failure

      Constructs a Validation whose value represents a failure.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      Failure(value)
      forall a, b: (a) => Validation a b

      Documentation

      Constructs a Validation whose value represents a failure.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.fold-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.fold-1.html index dc95eed..5fd97e3 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.fold-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.fold-1.html @@ -8,7 +8,7 @@

      fold

      Applies a function to each case of a Validation.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.fold.html b/docs/api/v2.0.0/en/folktale.validation.validation.fold.html
      index dc95eed..5fd97e3 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.fold.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.fold.html
      @@ -8,7 +8,7 @@
         
         
           
           

      fold

      Applies a function to each case of a Validation.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.get.html b/docs/api/v2.0.0/en/folktale.validation.validation.get.html
      index 63eea86..9017757 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.get.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.get.html
      @@ -8,7 +8,7 @@
         
         
           
           

      get

      This method has been renamed to unsafeGet().

      Deprecated since 2.0.0

      We want to discourage the use of partial functions, and having short names diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.getorelse-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.getorelse-1.html index 9e8a98f..84cbcf1 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.getorelse-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.getorelse-1.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Validation structure, if it's a Success, otherwise returns the provided default value.

      Signature

      forall a, b: (Validation a b).(b) => b

      Documentation

      Extracts the value of a Validation structure, if it's a Success, otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.getorelse.html b/docs/api/v2.0.0/en/folktale.validation.validation.getorelse.html index 9e8a98f..84cbcf1 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.getorelse.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.getorelse.html @@ -8,7 +8,7 @@

      getOrElse

      Extracts the value of a Validation structure, if it's a Success, otherwise returns the provided default value.

      Signature

      forall a, b: (Validation a b).(b) => b

      Documentation

      Extracts the value of a Validation structure, if it's a Success, otherwise returns the provided default value.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.inspect-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.inspect-1.html index 0ead86f..9d2d756 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.inspect-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.inspect-1.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Success variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Success variant.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.inspect.html b/docs/api/v2.0.0/en/folktale.validation.validation.inspect.html index 7dea5be..64a3484 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.inspect.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.inspect.html @@ -8,7 +8,7 @@

      toString

      A textual representation of the Failure variant.

      This feature is experimental!

      This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.

      Signature

      toString()
      () => String

      Documentation

      A textual representation of the Failure variant.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.map-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.map-1.html index 185b904..fc29a4b 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.map-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.map-1.html @@ -8,7 +8,7 @@

      map

      Transforms the successful value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      Signature

      forall a, b, c: (Validation a b).((b) => c) => Validation a c

      Documentation

      Transforms the successful value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.map.html b/docs/api/v2.0.0/en/folktale.validation.validation.map.html index 185b904..fc29a4b 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.map.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.map.html @@ -8,7 +8,7 @@

      map

      Transforms the successful value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      Signature

      forall a, b, c: (Validation a b).((b) => c) => Validation a c

      Documentation

      Transforms the successful value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure-1.html index e8106fd..eb538c1 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure-1.html @@ -8,7 +8,7 @@

      mapFailure

      Transforms the failure value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure.html b/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure.html
      index e8106fd..eb538c1 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.mapfailure.html
      @@ -8,7 +8,7 @@
         
         
           
           

      mapFailure

      Transforms the failure value inside a Validation structure with an unary function without changing the status of the validation. That is, Success values continue to be Success values, Failure values continue to be Failure values.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.merge.html b/docs/api/v2.0.0/en/folktale.validation.validation.merge.html
      index e4fd801..3802fd1 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.merge.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.merge.html
      @@ -8,7 +8,7 @@
         
         
           
           

      merge

      Returns the value inside of the Validation structure, regardless of its state.

      Signature

      merge()
      forall a, b: (Validation a b).() => a or b

      Documentation

      Returns the value inside of the Validation structure, regardless of its state.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.of.html b/docs/api/v2.0.0/en/folktale.validation.validation.of.html index 7ef237b..98976e8 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.of.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.of.html @@ -8,7 +8,7 @@

      of

      Constructs a Validation holding a Success value.

      Signature

      of(value)
      forall a, b: (b) => Validation a b

      Documentation

      Constructs a Validation holding a Success value.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.orelse-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.orelse-1.html index 72268a7..88b7074 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.orelse-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.orelse-1.html @@ -8,7 +8,7 @@

      orElse

      Allows recovering from Failure values with a handler function.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.orelse.html b/docs/api/v2.0.0/en/folktale.validation.validation.orelse.html
      index 72268a7..88b7074 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.orelse.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.orelse.html
      @@ -8,7 +8,7 @@
         
         
           
           

      orElse

      Allows recovering from Failure values with a handler function.

      Signature

      forall a, b, c:
      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.swap-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.swap-1.html
      index 81a2037..d10b519 100644
      --- a/docs/api/v2.0.0/en/folktale.validation.validation.swap-1.html
      +++ b/docs/api/v2.0.0/en/folktale.validation.validation.swap-1.html
      @@ -8,7 +8,7 @@
         
         
           
           

      swap

      Inverts the status of a Validation, such that Failures become Successes, and vice-versa.

      Signature

      forall a, b: (Validation a b).() => Validation b a

      Documentation

      Inverts the status of a Validation, such that Failures become Successes, and vice-versa.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.swap.html b/docs/api/v2.0.0/en/folktale.validation.validation.swap.html index 81a2037..d10b519 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.swap.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.swap.html @@ -8,7 +8,7 @@

      swap

      Inverts the status of a Validation, such that Failures become Successes, and vice-versa.

      Signature

      forall a, b: (Validation a b).() => Validation b a

      Documentation

      Inverts the status of a Validation, such that Failures become Successes, and vice-versa.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.tomaybe.html b/docs/api/v2.0.0/en/folktale.validation.validation.tomaybe.html index f8256c5..6c1a8f3 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.tomaybe.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.tomaybe.html @@ -8,7 +8,7 @@

      toMaybe

      Transforms a Validation into a Maybe. Failure values are lost in the process.

      Signature

      toMaybe()
      forall a, b: (Validation a b).() => Maybe b

      Documentation

      Transforms a Validation into a Maybe. Failure values are lost in the process.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.toresult.html b/docs/api/v2.0.0/en/folktale.validation.validation.toresult.html index a8b8247..4ad5be9 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.toresult.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.toresult.html @@ -8,7 +8,7 @@

      toResult

      Transforms a Validation into a Reseult.

      Signature

      toResult()
      forall a, b: (Validation a b).() => Result a b

      Documentation

      Transforms a Validation into a Reseult.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget-1.html index 76d522f..5e1bccd 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget-1.html @@ -8,7 +8,7 @@

      unsafeGet

      Extracts the value from a Validation structure.

      Signature

      forall a, b: (Validation a b).() => b :: throws TypeError

      Documentation

      Extracts the value from a Validation structure.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget.html b/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget.html index 76d522f..5e1bccd 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.unsafeget.html @@ -8,7 +8,7 @@

      unsafeGet

      Extracts the value from a Validation structure.

      Signature

      forall a, b: (Validation a b).() => b :: throws TypeError

      Documentation

      Extracts the value from a Validation structure.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.value-1.html b/docs/api/v2.0.0/en/folktale.validation.validation.value-1.html index ed8f76a..0dfe6d6 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.value-1.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.value-1.html @@ -8,7 +8,7 @@

      value

      The value contained in an Success instance of the Validation structure.

      Signature

      get value()
      forall a, b: get (Validation a b) => b

      Documentation

      The value contained in an Success instance of the Validation structure.

      diff --git a/docs/api/v2.0.0/en/folktale.validation.validation.value.html b/docs/api/v2.0.0/en/folktale.validation.validation.value.html index 05e474a..5c92239 100644 --- a/docs/api/v2.0.0/en/folktale.validation.validation.value.html +++ b/docs/api/v2.0.0/en/folktale.validation.validation.value.html @@ -8,7 +8,7 @@

      value

      The value contained in an Failure instance of the Validation structure.

      Signature

      get value()
      forall a, b: get (Validation a b) => a

      Documentation

      The value contained in an Failure instance of the Validation structure.