UNPKG

lodash-fantasy

Version:

Fantasy Land compatible types built with lodash.

1,695 lines (732 loc) 44.2 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Lodash Fantasy</title> <meta name="description" content="Fantasy Land compatible types built with lodash." /> <meta property="og:title" content=""/> <meta property="og:type" content="website"/> <meta property="og:image" content=""/> <meta property="og:url" content=""/> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <script src="scripts/jquery.min.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> <script> var config = {"monospaceLinks":true,"cleverLinks":false,"applicationName":"lodash-fantasy","collapseSymbols":false,"default":{"outputSourceFiles":true},"linenums":true,"meta":{"description":"Fantasy Land compatible types built with lodash.","title":"Lodash Fantasy"},"openGraph":{"type":"website"}}; </script> </head> <body> <div id="wrap" class="clearfix"> <div class="navigation"> <h3 class="applicationName"><a href="index.html">lodash-fantasy</a></h3> <div class="search"> <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> </div> <ul class="list"> <li class="item" data-name="Either"> <span class="title"> <a href="Either.html">Either</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li data-name="Either.all"><a href="Either.html#.all">all</a></li> <li data-name="Either.any"><a href="Either.html#.any">any</a></li> <li data-name="Either.each"><a href="Either.html#.each">each</a></li> <li data-name="Either.equals"><a href="Either.html#.equals">equals</a></li> <li data-name="Either.filter"><a href="Either.html#.filter">filter</a></li> <li data-name="Either.from"><a href="Either.html#.from">from</a></li> <li data-name="Either.isEither"><a href="Either.html#.isEither">isEither</a></li> <li data-name="Either.isLeft"><a href="Either.html#.isLeft">isLeft</a></li> <li data-name="Either.isRight"><a href="Either.html#.isRight">isRight</a></li> <li data-name="Either.Left"><a href="Either.html#.Left">Left</a></li> <li data-name="Either.map"><a href="Either.html#.map">map</a></li> <li data-name="Either.mapIn"><a href="Either.html#.mapIn">mapIn</a></li> <li data-name="Either.of"><a href="Either.html#.of">of</a></li> <li data-name="Either.reduce"><a href="Either.html#.reduce">reduce</a></li> <li data-name="Either.Right"><a href="Either.html#.Right">Right</a></li> <li data-name="Either.toMaybe"><a href="Either.html#.toMaybe">toMaybe</a></li> <li data-name="Either.toPromise"><a href="Either.html#.toPromise">toPromise</a></li> <li data-name="Either.toValidation"><a href="Either.html#.toValidation">toValidation</a></li> <li data-name="Either.try"><a href="Either.html#.try">try</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Either#ap"><a href="Either.html#ap">ap</a></li> <li data-name="Either#bimap"><a href="Either.html#bimap">bimap</a></li> <li data-name="Either#chain"><a href="Either.html#chain">chain</a></li> <li data-name="Either#equals"><a href="Either.html#equals">equals</a></li> <li data-name="Either#extend"><a href="Either.html#extend">extend</a></li> <li data-name="Either#get"><a href="Either.html#get">get</a></li> <li data-name="Either#ifLeft"><a href="Either.html#ifLeft">ifLeft</a></li> <li data-name="Either#ifRight"><a href="Either.html#ifRight">ifRight</a></li> <li data-name="Either#isLeft"><a href="Either.html#isLeft">isLeft</a></li> <li data-name="Either#isRight"><a href="Either.html#isRight">isRight</a></li> <li data-name="Either#map"><a href="Either.html#map">map</a></li> <li data-name="Either#of"><a href="Either.html#of">of</a></li> <li data-name="Either#orElse"><a href="Either.html#orElse">orElse</a></li> <li data-name="Either#orElseGet"><a href="Either.html#orElseGet">orElseGet</a></li> <li data-name="Either#orElseThrow"><a href="Either.html#orElseThrow">orElseThrow</a></li> <li data-name="Either#toMaybe"><a href="Either.html#toMaybe">toMaybe</a></li> <li data-name="Either#toPromise"><a href="Either.html#toPromise">toPromise</a></li> <li data-name="Either#toString"><a href="Either.html#toString">toString</a></li> <li data-name="Either#toValidation"><a href="Either.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Failure"> <span class="title"> <a href="Failure.html">Failure</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Failure.from"><a href="Failure.html#.from">from</a></li> <li data-name="Failure#ap"><a href="Failure.html#ap">ap</a></li> <li data-name="Failure#bimap"><a href="Failure.html#bimap">bimap</a></li> <li data-name="Failure#chain"><a href="Failure.html#chain">chain</a></li> <li data-name="Failure#concat"><a href="Failure.html#concat">concat</a></li> <li data-name="Failure#equals"><a href="Failure.html#equals">equals</a></li> <li data-name="Failure#extend"><a href="Failure.html#extend">extend</a></li> <li data-name="Failure#ifFailure"><a href="Failure.html#ifFailure">ifFailure</a></li> <li data-name="Failure#ifSuccess"><a href="Failure.html#ifSuccess">ifSuccess</a></li> <li data-name="Failure#isFailure"><a href="Failure.html#isFailure">isFailure</a></li> <li data-name="Failure#isSuccess"><a href="Failure.html#isSuccess">isSuccess</a></li> <li data-name="Failure#map"><a href="Failure.html#map">map</a></li> <li data-name="Failure#of"><a href="Failure.html#of">of</a></li> <li data-name="Failure#orElse"><a href="Failure.html#orElse">orElse</a></li> <li data-name="Failure#orElseGet"><a href="Failure.html#orElseGet">orElseGet</a></li> <li data-name="Failure#orElseThrow"><a href="Failure.html#orElseThrow">orElseThrow</a></li> <li data-name="Failure#toEither"><a href="Failure.html#toEither">toEither</a></li> <li data-name="Failure#toMaybe"><a href="Failure.html#toMaybe">toMaybe</a></li> <li data-name="Failure#toPromise"><a href="Failure.html#toPromise">toPromise</a></li> <li data-name="Failure#toString"><a href="Failure.html#toString">toString</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Just"> <span class="title"> <a href="Just.html">Just</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Just.from"><a href="Just.html#.from">from</a></li> <li data-name="Just#ap"><a href="Just.html#ap">ap</a></li> <li data-name="Just#chain"><a href="Just.html#chain">chain</a></li> <li data-name="Just#equals"><a href="Just.html#equals">equals</a></li> <li data-name="Just#extend"><a href="Just.html#extend">extend</a></li> <li data-name="Just#get"><a href="Just.html#get">get</a></li> <li data-name="Just#ifJust"><a href="Just.html#ifJust">ifJust</a></li> <li data-name="Just#ifNothing"><a href="Just.html#ifNothing">ifNothing</a></li> <li data-name="Just#isJust"><a href="Just.html#isJust">isJust</a></li> <li data-name="Just#isNothing"><a href="Just.html#isNothing">isNothing</a></li> <li data-name="Just#map"><a href="Just.html#map">map</a></li> <li data-name="Just#of"><a href="Just.html#of">of</a></li> <li data-name="Just#orElse"><a href="Just.html#orElse">orElse</a></li> <li data-name="Just#orElseGet"><a href="Just.html#orElseGet">orElseGet</a></li> <li data-name="Just#orElseThrow"><a href="Just.html#orElseThrow">orElseThrow</a></li> <li data-name="Just#toEither"><a href="Just.html#toEither">toEither</a></li> <li data-name="Just#toPromise"><a href="Just.html#toPromise">toPromise</a></li> <li data-name="Just#toString"><a href="Just.html#toString">toString</a></li> <li data-name="Just#toValidation"><a href="Just.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Left"> <span class="title"> <a href="Left.html">Left</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Left.from"><a href="Left.html#.from">from</a></li> <li data-name="Left#ap"><a href="Left.html#ap">ap</a></li> <li data-name="Left#bimap"><a href="Left.html#bimap">bimap</a></li> <li data-name="Left#chain"><a href="Left.html#chain">chain</a></li> <li data-name="Left#equals"><a href="Left.html#equals">equals</a></li> <li data-name="Left#extend"><a href="Left.html#extend">extend</a></li> <li data-name="Left#get"><a href="Left.html#get">get</a></li> <li data-name="Left#ifLeft"><a href="Left.html#ifLeft">ifLeft</a></li> <li data-name="Left#ifRight"><a href="Left.html#ifRight">ifRight</a></li> <li data-name="Left#isLeft"><a href="Left.html#isLeft">isLeft</a></li> <li data-name="Left#isRight"><a href="Left.html#isRight">isRight</a></li> <li data-name="Left#map"><a href="Left.html#map">map</a></li> <li data-name="Left#of"><a href="Left.html#of">of</a></li> <li data-name="Left#orElse"><a href="Left.html#orElse">orElse</a></li> <li data-name="Left#orElseGet"><a href="Left.html#orElseGet">orElseGet</a></li> <li data-name="Left#orElseThrow"><a href="Left.html#orElseThrow">orElseThrow</a></li> <li data-name="Left#toMaybe"><a href="Left.html#toMaybe">toMaybe</a></li> <li data-name="Left#toPromise"><a href="Left.html#toPromise">toPromise</a></li> <li data-name="Left#toString"><a href="Left.html#toString">toString</a></li> <li data-name="Left#toValidation"><a href="Left.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Maybe"> <span class="title"> <a href="Maybe.html">Maybe</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li data-name="Maybe.all"><a href="Maybe.html#.all">all</a></li> <li data-name="Maybe.any"><a href="Maybe.html#.any">any</a></li> <li data-name="Maybe.each"><a href="Maybe.html#.each">each</a></li> <li data-name="Maybe.equals"><a href="Maybe.html#.equals">equals</a></li> <li data-name="Maybe.filter"><a href="Maybe.html#.filter">filter</a></li> <li data-name="Maybe.from"><a href="Maybe.html#.from">from</a></li> <li data-name="Maybe.isJust"><a href="Maybe.html#.isJust">isJust</a></li> <li data-name="Maybe.isMaybe"><a href="Maybe.html#.isMaybe">isMaybe</a></li> <li data-name="Maybe.isNothing"><a href="Maybe.html#.isNothing">isNothing</a></li> <li data-name="Maybe.Just"><a href="Maybe.html#.Just">Just</a></li> <li data-name="Maybe.map"><a href="Maybe.html#.map">map</a></li> <li data-name="Maybe.mapIn"><a href="Maybe.html#.mapIn">mapIn</a></li> <li data-name="Maybe.Nothing"><a href="Maybe.html#.Nothing">Nothing</a></li> <li data-name="Maybe.of"><a href="Maybe.html#.of">of</a></li> <li data-name="Maybe.ofNullable"><a href="Maybe.html#.ofNullable">ofNullable</a></li> <li data-name="Maybe.reduce"><a href="Maybe.html#.reduce">reduce</a></li> <li data-name="Maybe.toEither"><a href="Maybe.html#.toEither">toEither</a></li> <li data-name="Maybe.toPromise"><a href="Maybe.html#.toPromise">toPromise</a></li> <li data-name="Maybe.toValidation"><a href="Maybe.html#.toValidation">toValidation</a></li> <li data-name="Maybe.try"><a href="Maybe.html#.try">try</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Maybe#ap"><a href="Maybe.html#ap">ap</a></li> <li data-name="Maybe#chain"><a href="Maybe.html#chain">chain</a></li> <li data-name="Maybe#equals"><a href="Maybe.html#equals">equals</a></li> <li data-name="Maybe#extend"><a href="Maybe.html#extend">extend</a></li> <li data-name="Maybe#get"><a href="Maybe.html#get">get</a></li> <li data-name="Maybe#ifJust"><a href="Maybe.html#ifJust">ifJust</a></li> <li data-name="Maybe#ifNothing"><a href="Maybe.html#ifNothing">ifNothing</a></li> <li data-name="Maybe#isJust"><a href="Maybe.html#isJust">isJust</a></li> <li data-name="Maybe#isNothing"><a href="Maybe.html#isNothing">isNothing</a></li> <li data-name="Maybe#map"><a href="Maybe.html#map">map</a></li> <li data-name="Maybe#of"><a href="Maybe.html#of">of</a></li> <li data-name="Maybe#orElse"><a href="Maybe.html#orElse">orElse</a></li> <li data-name="Maybe#orElseGet"><a href="Maybe.html#orElseGet">orElseGet</a></li> <li data-name="Maybe#orElseThrow"><a href="Maybe.html#orElseThrow">orElseThrow</a></li> <li data-name="Maybe#toEither"><a href="Maybe.html#toEither">toEither</a></li> <li data-name="Maybe#toPromise"><a href="Maybe.html#toPromise">toPromise</a></li> <li data-name="Maybe#toString"><a href="Maybe.html#toString">toString</a></li> <li data-name="Maybe#toValidation"><a href="Maybe.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Nothing"> <span class="title"> <a href="Nothing.html">Nothing</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Nothing.from"><a href="Nothing.html#.from">from</a></li> <li data-name="Nothing#ap"><a href="Nothing.html#ap">ap</a></li> <li data-name="Nothing#chain"><a href="Nothing.html#chain">chain</a></li> <li data-name="Nothing#equals"><a href="Nothing.html#equals">equals</a></li> <li data-name="Nothing#extend"><a href="Nothing.html#extend">extend</a></li> <li data-name="Nothing#get"><a href="Nothing.html#get">get</a></li> <li data-name="Nothing#ifJust"><a href="Nothing.html#ifJust">ifJust</a></li> <li data-name="Nothing#ifNothing"><a href="Nothing.html#ifNothing">ifNothing</a></li> <li data-name="Nothing#isJust"><a href="Nothing.html#isJust">isJust</a></li> <li data-name="Nothing#isNothing"><a href="Nothing.html#isNothing">isNothing</a></li> <li data-name="Nothing#map"><a href="Nothing.html#map">map</a></li> <li data-name="Nothing#of"><a href="Nothing.html#of">of</a></li> <li data-name="Nothing#orElse"><a href="Nothing.html#orElse">orElse</a></li> <li data-name="Nothing#orElseGet"><a href="Nothing.html#orElseGet">orElseGet</a></li> <li data-name="Nothing#orElseThrow"><a href="Nothing.html#orElseThrow">orElseThrow</a></li> <li data-name="Nothing#toEither"><a href="Nothing.html#toEither">toEither</a></li> <li data-name="Nothing#toPromise"><a href="Nothing.html#toPromise">toPromise</a></li> <li data-name="Nothing#toString"><a href="Nothing.html#toString">toString</a></li> <li data-name="Nothing#toValidation"><a href="Nothing.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Right"> <span class="title"> <a href="Right.html">Right</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Right.from"><a href="Right.html#.from">from</a></li> <li data-name="Right#ap"><a href="Right.html#ap">ap</a></li> <li data-name="Right#bimap"><a href="Right.html#bimap">bimap</a></li> <li data-name="Right#chain"><a href="Right.html#chain">chain</a></li> <li data-name="Right#equals"><a href="Right.html#equals">equals</a></li> <li data-name="Right#extend"><a href="Right.html#extend">extend</a></li> <li data-name="Right#get"><a href="Right.html#get">get</a></li> <li data-name="Right#ifLeft"><a href="Right.html#ifLeft">ifLeft</a></li> <li data-name="Right#ifRight"><a href="Right.html#ifRight">ifRight</a></li> <li data-name="Right#isLeft"><a href="Right.html#isLeft">isLeft</a></li> <li data-name="Right#isRight"><a href="Right.html#isRight">isRight</a></li> <li data-name="Right#map"><a href="Right.html#map">map</a></li> <li data-name="Right#of"><a href="Right.html#of">of</a></li> <li data-name="Right#orElse"><a href="Right.html#orElse">orElse</a></li> <li data-name="Right#orElseGet"><a href="Right.html#orElseGet">orElseGet</a></li> <li data-name="Right#orElseThrow"><a href="Right.html#orElseThrow">orElseThrow</a></li> <li data-name="Right#toMaybe"><a href="Right.html#toMaybe">toMaybe</a></li> <li data-name="Right#toPromise"><a href="Right.html#toPromise">toPromise</a></li> <li data-name="Right#toString"><a href="Right.html#toString">toString</a></li> <li data-name="Right#toValidation"><a href="Right.html#toValidation">toValidation</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Success"> <span class="title"> <a href="Success.html">Success</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Success.from"><a href="Success.html#.from">from</a></li> <li data-name="Success#ap"><a href="Success.html#ap">ap</a></li> <li data-name="Success#bimap"><a href="Success.html#bimap">bimap</a></li> <li data-name="Success#chain"><a href="Success.html#chain">chain</a></li> <li data-name="Success#concat"><a href="Success.html#concat">concat</a></li> <li data-name="Success#equals"><a href="Success.html#equals">equals</a></li> <li data-name="Success#extend"><a href="Success.html#extend">extend</a></li> <li data-name="Success#ifFailure"><a href="Success.html#ifFailure">ifFailure</a></li> <li data-name="Success#ifSuccess"><a href="Success.html#ifSuccess">ifSuccess</a></li> <li data-name="Success#isFailure"><a href="Success.html#isFailure">isFailure</a></li> <li data-name="Success#isSuccess"><a href="Success.html#isSuccess">isSuccess</a></li> <li data-name="Success#map"><a href="Success.html#map">map</a></li> <li data-name="Success#of"><a href="Success.html#of">of</a></li> <li data-name="Success#orElse"><a href="Success.html#orElse">orElse</a></li> <li data-name="Success#orElseGet"><a href="Success.html#orElseGet">orElseGet</a></li> <li data-name="Success#orElseThrow"><a href="Success.html#orElseThrow">orElseThrow</a></li> <li data-name="Success#toEither"><a href="Success.html#toEither">toEither</a></li> <li data-name="Success#toMaybe"><a href="Success.html#toMaybe">toMaybe</a></li> <li data-name="Success#toPromise"><a href="Success.html#toPromise">toPromise</a></li> <li data-name="Success#toString"><a href="Success.html#toString">toString</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Validation"> <span class="title"> <a href="Validation.html">Validation</a> </span> <ul class="members itemMembers"> <span class="subtitle">Members</span> <li data-name="Validation.all"><a href="Validation.html#.all">all</a></li> <li data-name="Validation.any"><a href="Validation.html#.any">any</a></li> <li data-name="Validation.concat"><a href="Validation.html#.concat">concat</a></li> <li data-name="Validation.each"><a href="Validation.html#.each">each</a></li> <li data-name="Validation.empty"><a href="Validation.html#.empty">empty</a></li> <li data-name="Validation.equals"><a href="Validation.html#.equals">equals</a></li> <li data-name="Validation.Failure"><a href="Validation.html#.Failure">Failure</a></li> <li data-name="Validation.filter"><a href="Validation.html#.filter">filter</a></li> <li data-name="Validation.from"><a href="Validation.html#.from">from</a></li> <li data-name="Validation.isFailure"><a href="Validation.html#.isFailure">isFailure</a></li> <li data-name="Validation.isSuccess"><a href="Validation.html#.isSuccess">isSuccess</a></li> <li data-name="Validation.isValidation"><a href="Validation.html#.isValidation">isValidation</a></li> <li data-name="Validation.map"><a href="Validation.html#.map">map</a></li> <li data-name="Validation.mapIn"><a href="Validation.html#.mapIn">mapIn</a></li> <li data-name="Validation.of"><a href="Validation.html#.of">of</a></li> <li data-name="Validation.reduce"><a href="Validation.html#.reduce">reduce</a></li> <li data-name="Validation.Success"><a href="Validation.html#.Success">Success</a></li> <li data-name="Validation.toEither"><a href="Validation.html#.toEither">toEither</a></li> <li data-name="Validation.toMaybe"><a href="Validation.html#.toMaybe">toMaybe</a></li> <li data-name="Validation.toPromise"><a href="Validation.html#.toPromise">toPromise</a></li> <li data-name="Validation.try"><a href="Validation.html#.try">try</a></li> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Validation#ap"><a href="Validation.html#ap">ap</a></li> <li data-name="Validation#bimap"><a href="Validation.html#bimap">bimap</a></li> <li data-name="Validation#chain"><a href="Validation.html#chain">chain</a></li> <li data-name="Validation#concat"><a href="Validation.html#concat">concat</a></li> <li data-name="Validation#equals"><a href="Validation.html#equals">equals</a></li> <li data-name="Validation#extend"><a href="Validation.html#extend">extend</a></li> <li data-name="Validation#ifFailure"><a href="Validation.html#ifFailure">ifFailure</a></li> <li data-name="Validation#ifSuccess"><a href="Validation.html#ifSuccess">ifSuccess</a></li> <li data-name="Validation#isFailure"><a href="Validation.html#isFailure">isFailure</a></li> <li data-name="Validation#isSuccess"><a href="Validation.html#isSuccess">isSuccess</a></li> <li data-name="Validation#map"><a href="Validation.html#map">map</a></li> <li data-name="Validation#of"><a href="Validation.html#of">of</a></li> <li data-name="Validation#orElse"><a href="Validation.html#orElse">orElse</a></li> <li data-name="Validation#orElseGet"><a href="Validation.html#orElseGet">orElseGet</a></li> <li data-name="Validation#orElseThrow"><a href="Validation.html#orElseThrow">orElseThrow</a></li> <li data-name="Validation#toEither"><a href="Validation.html#toEither">toEither</a></li> <li data-name="Validation#toMaybe"><a href="Validation.html#toMaybe">toMaybe</a></li> <li data-name="Validation#toPromise"><a href="Validation.html#toPromise">toPromise</a></li> <li data-name="Validation#toString"><a href="Validation.html#toString">toString</a></li> </ul> <ul class="events itemMembers"> </ul> </li> </ul> </div> <div class="main"> <h1 class="page-title" data-filename="global.html">Global</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Type Definitions</h3> <dl> <dt> <div class="nameContainer"> <h4 class="name" id="Callable"> Callable<span class="signature">()</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line3">line 3</a> </div> </div> </dt> <dd> <div class="description"> A <code>function</code> with no arguments or return value. </div> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Chain"> Chain<span class="signature">(value)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Type.&lt;T>}</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line9">line 9</a> </div> </div> </dt> <dd> <div class="description"> A unary <code>function</code> that takes a <code>value</code> and returns a <code>value</code> wrapped in the same type providing the <code>value</code>. </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">T</span> </td> <td class="description last"> Value on which to chain.</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Type.&lt;T> </td> <td class="description last"><code>value</code> wrapped in a <code>Type</code>.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Consumer"> Consumer<span class="signature">(value)</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line18">line 18</a> </div> </div> </dt> <dd> <div class="description"> A function that takes a <code>value</code> and does not return a value. </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">T</span> </td> <td class="description last"> Current value.</td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Extend"> Extend<span class="signature">(instance)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Type.&lt;T>}</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line25">line 25</a> </div> </div> </dt> <dd> <div class="description"> A unary <code>function</code> that takes a <code>Type</code> and returns a <code>value</code> wrapped in the same type. </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>instance</code></td> <td class="type"> <span class="param-type">Type.&lt;T></span> </td> <td class="description last"> Instance of <code>Type</code> on which to extend.</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Type.&lt;T> </td> <td class="description last"><code>value</code> wrapped in a <code>Type</code>.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Predicate"> Predicate<span class="signature">(value)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Boolean}</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line44">line 44</a> </div> </div> </dt> <dd> <div class="description"> A unary function that takes a <code>value</code> and returns the <code>Boolean</code> evaluated result. </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">T</span> </td> <td class="description last"> Value on which to apply assertions.</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Boolean </td> <td class="description last">Whether or not the predicate is affirmed or denied.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Reduction"> Reduction<span class="signature">(accumulator, value)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{A}</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line34">line 34</a> </div> </div> </dt> <dd> <div class="description"> A binary function that takes an <code>accumulator</code> and a <code>value</code> and returns accumulated value. </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>accumulator</code></td> <td class="type"> <span class="param-type">A</span> </td> <td class="description last"> The initial value.</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">T</span> </td> <td class="description last"> Current value.</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> A </td> <td class="description last">The accumulated value.</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="Supplier"> Supplier<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span> </h4> <div class="tag-source"> <a href="index.js.html">index.js</a>, <a href="index.js.html#line52">line 52</a> </div> </div> </dt> <dd> <div class="description"> A nullary <code>function</code> that returns a <code>value</code>. </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> * </td> <td class="description last"></td> </tr> </tbody> </table> </dd> </dl> </article> </section> <footer> Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Thu Oct 20 2016 15:41:06 GMT-0500 (CDT) </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/jaguar.js"></script> </body> </html>