Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monkeymars/pipa-fns
a pipe function is a utility function that allows you to compose a series of functions together, where the output of one function becomes the input of the next function.
https://github.com/monkeymars/pipa-fns
function-composition pipe-function
Last synced: 3 days ago
JSON representation
a pipe function is a utility function that allows you to compose a series of functions together, where the output of one function becomes the input of the next function.
- Host: GitHub
- URL: https://github.com/monkeymars/pipa-fns
- Owner: monkeymars
- Created: 2023-08-10T16:57:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-15T02:18:12.000Z (over 1 year ago)
- Last Synced: 2024-12-13T21:37:41.694Z (12 days ago)
- Topics: function-composition, pipe-function
- Language: TypeScript
- Homepage:
- Size: 16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Function: pipa-fns
[](https://github.com/monkeymars/pipa-fns/actions/workflows/node-ci.yml)
[](https://github.com/monkeymars/pipa-fns/actions/workflows/codeql.yml)
The **pipa** - _pipe function_, is a utility function that allows you to compose a series of functions together, where the output of one function becomes the input of the next function. It takes in an array of functions and returns a new function that can be invoked with an argument. The functions can be synchronous or asynchronous, and the output can be a value or a promise.
#### Installation
To use the pipe function, you need to have Node.js installed on your machine. You can then install it as a dependency in your project using npm or yarn.
##### Using npm:
```bash
npm install --save pipa-fns
```
##### Using yarn:
```bash
yarn add pipa-fns
```
## Usage
To use the pipe function, you need to import it into your code.
```javascript
import pipa from 'pipa-fns';
```
#### **Example 1**: Composing synchronous functions
```javascript
const addOne = (num: number) => num + 1;
const multiplyByTwo = (num: number) => num * 2;
const subtractThree = (num: number) => num - 3;
const pipedFn = await pipa(addOne, multiplyByTwo, subtractThree);
const result = await pipedFn(5);
console.log(result); // Output: 6
```
In this example, we define three synchronous functions: add, multiply, and subtract. We then use the pipe function to compose these functions together. The calculate function is the result of the composition, and we can invoke it with an argument (3 in this case) to get the final result.
#### **Example 2**: Composing asynchronous functions
```javascript
const fetchData = async (url) => {
const response = await fetch(url);
const data = await response.json();
return data;
};
const processData = (data) => {
// process the data
return data;
};
const displayData = (data) => {
// display the data
return data;
};
const fetchAndProcessData = await pipa(fetchData, processData, displayData);
const response = await fetchAndProcessData('https://dummyjson.com/products');
console.log(response); // dummy products
```
In this example, we have three functions: fetchData, processData, and displayData. The fetchData function is asynchronous and fetches data from a given URL. The processData function processes the fetched data, and the displayData function displays the processed data. We use the pipe function to compose these functions together, creating the fetchAndProcessData function. We can then invoke fetchAndProcessData with a URL to fetch, process, and display the data.
Note: Make sure to handle any errors that may occur during the execution of asynchronous functions.
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)