Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ksxgithub/deno-compose
pipe, pipeline, and compose functions with 64 overloads per function.
https://github.com/ksxgithub/deno-compose
codegen compose deno functional-programming javascript overloading pipe pipeline pregeneraged typescript
Last synced: 22 days ago
JSON representation
pipe, pipeline, and compose functions with 64 overloads per function.
- Host: GitHub
- URL: https://github.com/ksxgithub/deno-compose
- Owner: KSXGitHub
- License: mit
- Created: 2020-04-06T12:45:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-26T04:03:38.000Z (about 2 years ago)
- Last Synced: 2024-10-05T06:03:34.014Z (about 1 month ago)
- Topics: codegen, compose, deno, functional-programming, javascript, overloading, pipe, pipeline, pregeneraged, typescript
- Language: TypeScript
- Homepage: https://deno.land/x/compose
- Size: 32.2 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Overload Definition of Pipe and Compose
`pipe`, `pipeline`, and `compose` functions with 64 overloads per function.
## What's the point?
This package not only provides simple `pipe`, `pipeline`, and `compose` implementation, it also provides 64 TypeScript overloads for each function. [See [index.d.ts](./index.d.ts)]
## Usage
### Import as module
**URLs to import from:** _(replace `:VERSION` with suitable version, which are git tags)_
* GitHub User Content: `https://raw.githubusercontent.com/KSXGitHub/deno-compose/:VERSION/index.js`
* GitHub Pages: `https://ksxgithub.github.io/deno-compose/index.js` (always master branch)
* Deno Third-Party Modules: `https://deno.land/x/compose@:VERSION/index.js`
**Code Example:**
```typescript
import {
pipe,
pipeline,
compose,
pipeUnary,
pipelineUnary,
composeUnary,
} from 'https://deno.land/x/[email protected]/index.js'
```
### APIs
#### `pipe`
**Signature:** `pipe (value, ...functions) → result`
```typescript
const y = pipe(x0, f1, f2, f3)
```
is equivalent to
```typescript
const x1 = f1(x0)
const x2 = f2(x1)
const y = f3(x2)
```
or
```typescript
const y = f3(f2(f1(x0)))
```
#### `pipeline`
**Signature:** `pipeline (...functions) → function`
```typescript
const fn = pipeline(f0, f1, f2, f3)
```
is equivalent to
```typescript
const fn = (...args) => f3(f2(f1(f0(...args))))
```
#### `compose`
**Signature:** `compose (...functions) → function`
```typescript
const fn = compose(f3, f2, f1, f0)
```
is equivalent to
```typescript
const fn = (...args) => f3(f2(f1(f0(...args))))
```
#### `pipelineUnary`
**Signature:** `pipeline (...functions) → function`
```typescript
const fn = pipe(f0, f1, f2, f3)
```
is equivalent to
```typescript
const fn = x => f3(f2(f1(f0(x))))
```
#### `composeUnary`
**Signature:** `compose (...functions) → function`
```typescript
const fn = compose(f3, f2, f1, f0)
```
is equivalent to
```typescript
const fn = x => f3(f2(f1(f0(x))))
```
#### `composeRight`
It is just an alias of [`pipeline`](#pipeline)
#### `composeUnaryRight`
It is just an alias of [`pipelineUnary`](#pipelineunary)
### Example
```typescript
// pipe
const y0 = pipe(x, f1, f2, f3, f4)
// pipeline
const g1 = pipeline(f0, f1, f2, f3, f4)
const y1 = g1(...args)
// compose
const g2 = compose(f4, f3, f2, f1, f0)
const y2 = g2(...args)
```
## Development
### Code Style
This project is formatted according to [sane-fmt](https://github.com/KSXGitHub/sane-fmt/).
## License
[MIT](https://git.io/JvNN2) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)