Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhershman1/kyanite
A small purely functional library of curried functions, with great piping possibilities!
https://github.com/dhershman1/kyanite
functional-js javascript library light modular pure utility
Last synced: 7 days ago
JSON representation
A small purely functional library of curried functions, with great piping possibilities!
- Host: GitHub
- URL: https://github.com/dhershman1/kyanite
- Owner: dhershman1
- License: mit
- Created: 2018-05-29T15:57:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T00:50:43.000Z (2 months ago)
- Last Synced: 2024-12-13T09:37:53.308Z (11 days ago)
- Topics: functional-js, javascript, library, light, modular, pure, utility
- Language: JavaScript
- Homepage: https://kyanite.dusty.codes/
- Size: 3.44 MB
- Stars: 26
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A light weight functional JavaScript library that only depends on itself.
## Why The Name Kyanite?
Because I think mineral names are cool
## Contents
- [View the Changelog](https://github.com/dhershman1/kyanite/blob/master/CHANGELOG.md)
- [View the Documentation](https://kyanite.dusty.codes)
- [Philosophy](#philosophy)
- [Key Features](#key-features)
- [How To](#how-to)
- [Testing](#testing)
- [Credit](#credit)
## Philosophy
The goal for Kyanite is to be stripped down, light weight, and intuitive. The idea is to be performant and easy to use in a functional setting, making it simple to build reusable functions in your code base with powerful and organized algorithmic pipes. Ultimately, Kyanite’s continued growth and improvement will support the growth and improvement of the JavaScript community
## Key Features
- Purely Functional - This was a main focus for the project. I wanted it to be an easy to use, functional system while also being completely pure by making use of piping and transducers to boost performance.
- Single type utility functions - Theoretically, all of the functionality is based around accepting a single data type, doing what it does, and giving you back a result, thus making it reliable, stable, and lightweight.
- Everything is curried! Setup static in one spot and then pass the rest of the dynamic data in later.
- Data last ideology
## How To
> **Note:** As of `v2.0.0` the module should be imported as just `K` instead of `kyanite`
> The unminified version of the library is no longer available as of 2.0.0
With a CDN
```html
K.isEmpty({})
```
Or installing with `npm i kyanite` and then:
Standard module system
```js
// This will use the module path in the package.json (src/index.js)
import * as K from 'kyanite'
```
Common JS
```js
// For the prod minified version
const K = require('kyanite')
```
## Testing
Kyanite follows the [tap](http://testanything.org/) setup using the [tape](https://github.com/substack/tape) testing suite.
To run the tests:
- `git clone` the repo
- `cd` into the repo folder
- Run `npm i`
- Run `npm t`
## Credit
A lot of the if not most of the inspiration for this library came from 2 libraries I follow closely, Primarily most of it stems from:
- [foreword](https://github.com/abstract-tools/foreword) by [Abstract Tools](https://github.com/abstract-tools) which is a very nice and easy to use library developed by a close friend and mentor. This is where a lot of functionality ideas came from I can't recommend it enough.
- [Ramdajs](http://ramdajs.com/) by [Ramda](https://github.com/ramda) a beautiful and feature packed library where the original idea started