This is a functional programming library with a focus on point-free coding style and abstracting the complexity of asynchronous programming. This library has no dependencies, so adding it to your project does not introduce a lot of bloat.
npm i -P @sullux/fp-light
# or
yarn add @sullux/fp-lightComing soon!
These docs are in the process of being built. We will be using the common pattern of even numbered releases for LTS, so we are treating this 1.0 release as a beta. While most of this library is relatively stable, some things might change before we get to our first LTS candidate.
The full API includes all exports from this library. While the source code is light, the list of exported function is long. To make it easier to navigate, here are the same exports broken into categories. Some functions will be found in multiple categories. We just wanted to make it as easy as possible for you to quickly find what you're looking for.
- Async
- Bitwise
- Comparison
- Compilable
- Composition
- Convenience Functions
- Environment
- Error
- Foundational
- Mapping
- Side Effect
- Spreadable
- Strings
- Types
- arrays
- compilable
- strings
To document a function in a comment, use the following YML template:
/* #AUTODOC#
module: API
name: <name>
aliases: [<name>]
tags: [<Tag>]
ts: |
declare function <name>(<arg>: <type>): <type>
description: |
<add description here>
examples: |
<add code blocks and explanations here>
specs:
- !spec
name: <name>
fn: !js <name>
tests:
- name: should <do what>
input: [<value>]
output: <value>
*/