diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 928e3dc6..5ad46a19 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE4uOBQApu0wNAgAAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42SwUrEMBBA/yXnYlFEpDfBPQiisuJJPAzt7Da0TcJkilvFf5fott22cep13rx3yOT1UzEeWGVqi41lvAWGZwZuvUqUAy5VptC0jU/n/KzkplaJqrQpVHb9lQylG9+ZPCyOibwG79GnA5ra5xen/kZzibSUf+eSeQ8f3dILU8l6dKytgXpp9kSywd+dvNWuNXlwfBrmU+/qcqK9mAJ32mARtwcsRAqyLmaHuaDhgQlyfiLrkLiLFWYrQkwXaFjHKz0T9NruN0SWYnrPBL2BCh+sWZ5wrMxWVmJrpX9kHBDreOGI1uWt3pcsFH64lNF5dTyexuj/nG4IKS7Jvv95o5EuEm/f9LnFTF0EAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 66d159da..78e45ae7 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAEz2MMQqAMBAE/7J1sNDK/MAP2IiFmBUOkovEoIL4dwmK5ewscyHFY4MdRgNRxxP2ws60SVRY1FVTtTBYhN6VG3QKhMEcQ6BmjJ/rOeeY/tDOlOm6N1imVVZ6URa67wdtjdlXdgAAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE71d25LbuBH9F86rPBYuvM2bq7JJbcrr3VonmweVa4uRqBmuNaRCUuN1XP73FEiC7Aa7RYqa6GnGUqMPgHPQDfSQ8DevLL5U3sPmm/c5y3feQ6BXXp48p96D95x8Tn8+1lmRJwdv5Z3Kg/fg7U/51nxUvYVf3z/Vz8Zme0iqKq28B8/7vupd+r4Keq+//15/PaZz/N2hT/p2AGPlHZMyzWuns/eo56AjeGwfinxieMDitUbourxzP5wxTmjuDmTolJBR36XRODvnb2cNT6714Cp9PtZfz/u5szb0EIi+IoRiP+G+MZjt2xeyd70t8qouT9u6KCcwsOUAVle7N1n15lhmL0mdTkCLtRwk95IcTukEqrVZiIemcZ8d6nRqmL3RMqqek+MEQGuxzPv+kNQ/TSIMVstQHtN6AqG1WOY92/9SppWxPY8B7WYjnY07Ezj3/W9vxFTQ6V0QrTm5F+UPh+qa3tz3Hi7vlB3Q/22qus51/3ojrumlHSinoGqmgqoFCsKBdw5lrdGMEfMoH4r6KcsfJ4EGu8VIp8NEzrvrja6Zs79NxhBodw3SP57K4sssLGu5DC39zyk5VFN53hotw9gm1dS0dSbL/B/L4piWk7sVYLYMpy7+/vHnDxMovdFsjAHg1/S5qNO/JHXysU7q00BLmp+eq7fu12c3c2KIgh+K+l31Od3NcXcHjOkRjDpJYr4vkh1c++cgB9trEP+aZIeZY+xNr8H7eNpu03Q3ExJaXzvKU5nOHmZre/U4q1lavBtsL0cEx5h31dd8a6xGa63/Zv5BJnfVT/u6y6eEP/SKQTo4mmeADhNyn4WT7j5m+eNhnMUJMGB7FeI8rOUoaVkW5TTMYDYfZ+7h0IG6/HRIgaP9coUjOwPcWxGYRZ1u62b881GzvE5LqjDg4AK7paPFqf9Q5Om/svrpQ/plxoK+I+xfpx9FXidZXs3qA7ZdKOZskuOMj5MzvM+KaYPZYhw3kbNIU1l8JtacQb2/MtBk1Q/zQg00XI5FVtLGSGeLaZM4dNnJQRnXnS7CqJo08tscJGx6Rdr5qShnJbnObiHSY1qztVMHDJsux3t3OFwAia2XR42yTGZo0Zq9Suxlyg0O6EQVaBIlOR7TfHJB91bLeftQ5G38+TWtTofxwXbM3bjFq8wrVZR1wM9VZef4n7XUgd1CJKaE7eBM1LAnUcp0d9pOjqa3WjyWaRV2Nlcg/Jjv0j/nwFjDhVin466V5Vmg3mohyrbIt8nkSuqtlmavopzE6GyWR4cZ4eAaBT8XLzMU3FktjaRELdUNo2cqqdPHvJe0nMxB1mjpGPJJhNZksZaep7dArc18BFgC+SGrn4iQ2H48v/hxSPdjSQInd8bgTJG/6wanx+zx6bz7xmKx/z+KLH8/NQJgtBTj18lxQKuZKHNLDhCGqzecBUIH/VmEz9yBnEeaSf5SLPdoODWu3mSJCB7TehJgsFmCkFXTIhtsFo5hGgIYLcGgtpzQ/bn95qTnSQYGm4UI0/MDjJZgHMvCVPknR4LtrkCaHpFjuAQrOR4P43QKQazFopWxn17b+2tW3n7GyttfOD/gEbPa/P21KRMRj4INX57/Yx3I/O+T/44n23w4P+tvy5TatfdO7noDerhNFy7PZMD/xXVzBxJlmn+fssOO2AwNeIPFtVh0GW1AuuTJLQfHjdb04XqAAiazaMISeEqy/BxD3fezPAO1H5OyzsgHKbtvXuMBSujqzv5j4tkla2Y7+Cqg/XNAb+SNgaUF1jcGVhY4uDGwtsDRjYH9/umu9Y2Rgx751vIKe+Rb6yvqkW8tsLhHvrXCxLoPI7eWmBgi2K01JvoYJm8tMtFHMblIZaN8h7eQI/Tm61fMfIO/O/TJvBzY2qKev3JHLsiLN+jM/Fx5g87Mz5836Mz8nHqDzlyQZ2/Qmwty7w16c0E+vkFvLsjRN+jNBXn7FpHvglx+i+5ckN9v0Z0Lcv4tunPBPuB8d8CjdLs0rzPwRM/QG/vV+Z3A4CqpfqwIN+bjuS52ZXEkXJiP5/fin/ku3Wc5eB4Kdqb/dq7DQ/HI1cPsV3NdpX/WZbKtf3Gf8B88OhavsQmjXN65H05sxVxzdyD0ZjPbfu4sspRSBjZ4lQ3n2OOd89nUphNbO2P4/mnlZc0zCA/fvJe0rLIi9x48ea/uY2/l7bP0sDPvJbcdXXnb4vnZ+P3UffdbaoqIxqI1ebv2Vpv1Svv3fqg/fVptbIvmi+aDxkx4q41YCX0vRYzMBDKT3mojKW8SmSnOm0Jm2lttFOVNIzPfW200ZeYjs8BbbXzKLEBmobfaBCul7/0oQmYhMou81SZcqfBerAUyi5BZ7K020Uqv73UQILMYT6+Z7ZhyJxweGiJIwgSmwuzDNkJQ2AKzIRo6SNoEJsTsphgZYEqEmXqhyAFhVsyWiHGJeRFm/gXJs8DUmH0NB47ZEYYFQYpCYILM5mQjAlLamCHZMBSSls5iaRiKSEvMkGwYiklLzJDZJmwkqQ+JKZKGBylIS0yRyfUbSS9rzJE0REhyyUrMkTRESE2pU2KOpCFC+qQl5kgZIiTJkcIcKUOEJDlSmCPVRDSSI+XENEOEJDlSmCPVxDWSI4U5Uj47SwpzpAJ2lhTmSBkiFMm7whwpQ4QieVeYI2WIUCTvCnOk11x41ZgibXhQ5HLXmCJteFDkItaYIm14UKRAtJN5GopIgWhMkTY8KFIgGlOkDQ+KFIjGFGnDgyYFojFF2vCgSTI1pkgbHjRJpsYU+YYITZLpY458wSVBH1PkGx40naMxRb7hQZNk+pgi3/CgSTJ9Z3/QbBBIMn1MkW940CSZPqbID9kc42OK/IYiknYfU+QbHnySdh9TFLDbhQAzFBgefFIfAaYokNxOJcAMBYYGnxRSgBkKDA0+KaQAMxQYGnxSH4GziWt2cfQ2DjMUGBp8Uh8BZigwNPikPgLMUBCze6oAMxQaHnxSSSGmKGwoIvURYopCQ0RA6iPEHIWGiICkPcQchYaIgGQzxByFhoiAZDPEHIWGiIDMWqGz124222TWCjFHoSEiINkMMUehISIg2QwxRxGbiyJMUSTYAUWYokiyA4owRVFDESmQCFMUNRSRAokwRZHhISQFEmGKIsNDSAokwhRFIRdqIudA1JyISCVFmKHI0BCSSoowQ7HhISTjQowpiptURMaFGFMUGx5CUkkxpig2PISkkmJMUWx4CEkyY0xR3FBEkhljimLDQ0SSGWOKYkNERJIZY47iiFN87Bxbm3MrSWbsnlzX3Cag/QqaGiYikvj2O2jb5CP6uLd2zq9rw0ZEH+PWzgl2zR9h184Zdu3zps4hds2fYtfOMXYd8qbOOXYd8abOQXYd86YOYU1FgTYdFRv4so9bbWjLDbSpQ5dgyz/CrTecKTi4FQfBs+WWHM7UHNyig+DZcqsOTW0hIgOLcOsOgqfLKTwIydPlVB6E5OmSbnGIp8upPQjJ0+UUH4Tk6XKqD0LydDnlByF5upz6g5A8XU4BQkh+cTkVCCF5tpwShFA8W04NQiieLacIIRTPlnJreU0sJJOWcOoQoqk2RGTaEk4lQjT1hohMXMKpRYim4hDTRUqnGiGamkNMJi/h1CNEU3WImUKlw5niOXNKEqKpPMR0WnKqEkLzpHVliaZA/5KWddq9LGhK7bbm/837vaveC/u3hG+e8B6+fV95qv0hdPcz6H6u7Qdr3/7SfxXaXyL7S9z9Itb2F2F/kfYXi9RDCeu5BxXWs7AOpXUorUNpHUrrUFqH0jqU1qG0DqXtqrSelfWsrGdlPStro5uvvg9/0DD/MtPfvDo3TKsfD/Masm3Mq2pDmwBwESquTfem89BMAyg/4psdEFgYDK1iybWqzGUWQ6MoAmpRmm11Gv7wODSO17BxwDb+mm93zRUdQ1MFmrKw/cPioL8SDDJm2rV3lA2NJACTHFj3nDWA0mB0a25Cm3tQvmT1U55+GQ0SMKI5+u3LskBpoFkQ8s2GB/eB4oDgWoHrbg1E3c+YE5S9TWU0ihCMgp297j0FMH1A+zE3ivaP4qBRDBXlM63S7pVLMGwFxs02a+/tAOsMLDOuTXehHgivoIuSI7W/+QhMI+ii4pTbvUwLBgakG3Ia7P5kPVybB5aohBPKUb/vrlkDSwYIqY2iTLPm2jLQDsQTxfXX3g8AeAdaaWUa8I1xsPTBvAacPE2j1h62BPwHnADMZbbNy3JAATDscZmgeX0ctIFZuctBAaeCx7RODoeiv0UEKBasRZ/r8mNat++OAhkB0UbcJD2mdV7k7d1gZXcBBpgtMGr/TM/JbgM1+Wfgu/dQQU4D0xZxCeYxrV/a12+AoBQM3hxJwxNCoGUIVwy3wLO9O8UhaBfzzY72SligDbRG2ZbjyYGrhpvV4Z4wEIp8ENG5dYb3CQpgaU54WZW019EA5kE7nyMwq5L28iuABwSr+XbjkA5497m4lVVEfNaABc3pO6tGKwsMMGLJq+yNewAPSFtzgblt2FzWBVqClai5zJpVlNLgloZvOVYaQIw49s2b96PZgfsRbpCm4QgyAMsp5Og4NG9ggrUL+hlzqhn1EUxK2B0qIi5ijHlUQDdsgm2bVd3ljqAxEIHiCCEkIMEKtqcddgNu2j8XOE9r4MDnZHsoHtP28UCwoYCJjO2y+U8Q8iKncgGYLi70mNZUU8Aut7SdVA23k93+N7D7Yb7vx1FsB52OOI6fk+N44YBwFHEqfk6Oo/zlg2kOODHmRT0KnBKo2R6I2Y20+X8bACaA5BoQrIAhckmoKNPmyjAQiWB+tkf6rrs+x0zrxt1ZgUAhuZlqW9btBdygLQjeklNjUeb22nPQEkyW4IgtyvyEiwgCxEPJabh/cxcENgi35tZr13CkwgigCsHp1zwPegTPtIJVBMnSbLfb+wtGawcIMp5oO14/YNwxRy517pFg/UhO/vYGMbAEwEIPuGkum7uRzTHZXv4KcMFUSU7H9t4ngAuEGHKTNM6RYHbC7rgfcTJuk88o0Gh4CGbbNhckAWAwTSG36NsbusAYwUINOBGOZ1SBDrK1umq4tBtwAQDV2ZYV5hBkDfYA0MSSUXYMQdOYk11d/FEVqNQkYVLkYq+9uw3MKIzYXLMR42BWbMC11dE1Kb1PK++YHdNDlqfew+bT9+//A47+EqekagAA"; \ No newline at end of file diff --git a/docs/classes/AsyncData.html b/docs/classes/AsyncData.html new file mode 100644 index 00000000..0f76e8ae --- /dev/null +++ b/docs/classes/AsyncData.html @@ -0,0 +1,87 @@ +
Private
constructorPrivate
Readonly
internalProtected
statusThis returns true
if the predicate
returns true
for every element of data.
It is synonymous with every
+an error if no response has been received
+This returns true
if the predicate
returns true
for any element of data.
It is synonymous with some
+an error if no response has been received
+Private
cloneThis returns true
if the predicate
returns true
for every element of data.
It is synonymous with all
+an error if no response has been received
+Private
getCheck the status of the data request
+Private
isThis returns true
if the predicate
returns true
for any element of data.
It is synonymous with any
+an error if no response has been received
+Sorts the elements of data, according to compareFn
Note that this does not sort the elements in place
+Optional
compareFn: ((a, b) => number)The comparison function to be applied to the data elements. See Array.sort documentation for more detail
+an error if no response has been received
+Static
erroredStatic
loadedCreate an instance of this type that indicates that some data has been returned by the request.
+NB: There is nothing here that asserts that the request is complete. This factory method can +be called multiple times to indicate loading data in progress.
+Static
loadedStatic
loadingStatic
notThe Either<R,L>
type represents 2 possible values of 2 possible types.
A common use case it to use this to represent the outcome of a function that could
+be an error or a value: const result: Either<ErrorType, ValueType>
. Convention has
+ErrorType
as the left-value and ValueType
as the right-value.
The type will only ever be single-valued, but it will always be single-valued
+Private
Readonly
leftPrivate
Readonly
rightRuns the provided function if the left value is populated
+Runs the provided function if the right value is populated
+Maps the Either<L,R>
object to a simple object of type T
.
Each of the mapping functions must return the same type, so that this Either
object can
+be mapped.
Only one of the functions will be called, so no side-effects should be relied upon.
+Map the left-value of one type to a different value of another type.
+If this object is right-valued, then this doesn't change that, but it does
+change the overall type of the Either
object
Map the right-value of one type to a different value of another type.
+If this object is leftt-valued, then this doesn't change that, but it does
+change the overall type of the Either
object
Much like {@link mapLeft}
, this converts an Either
from one type to another.
The difference here is that the mapping function returns an Either
of its own, rather
+than just a left-value. This allows you to chain a series of Either
s together, only operating
+if you are getting left-valued Either
s
Much like {@link mapRight}
, this converts an Either
from one type to another.
The difference here is that the mapping function returns an Either
of its own, rather
+than just a right-value. This allows you to chain a series of Either
s together, only operating
+if you are getting right-valued Either
s
Static
joinStatic
joinStatic
leftStatic
rightRepresents a value that is initialized in a lazy manner, i.e. not until it is needed
+Private
constructorPrivate
builderPrivate
valueStatic
createAn implementation of https://docs.oracle.com/javase/8/docs/api/java/util/fp/Optional.html
+Private
constructorPrivate
Readonly
valueIf the Optional is non-empty, pass the value to a consuming function.
+The consumer
should not return a value. If it does, this value is ignored.
See JSON.stringify
+Static
emptyStatic
ofThe various states that an async request for data can be in
+A response has been received and it indicated an error
+synonym for Failed
A request has been sent, but no response has been received
+No request has been sent yet
+A response has been received and it was successful
+synonym for Succeeded
This does the same as drop, but is typed to return undefined (rather than void)
+Take a function that requires a value of T
and return a version that takes Optional<T>
NB: If an empty Optional
is passed to the new function, a NoSuchElementException
+ will be thrown
Takes a function,fn
and a list of arguments args
, and returns a new function g
which, when called,
+returns the result of fn
called with args
followed by whatever arguments are provided to g
Takes a function,fn
and a list of arguments args
, and returns a new function g
which, when called,
+returns the result of fn
called with whatever arguments are provided to g
+followed by args
This class represents data from a remote source that takes time to load.
+It can be single-valued or an array of values. The caller is expected to +know which it is
+