Skip to content

TomokiMiyauci/fonction

Repository files navigation

logo image

fonction

A modern practical functional library

test GitHub release deno land nest badge deno version node support version bundle size

GitHub (Pre-)Release Date dependencies Status codecov Codacy Badge npm type definitions Commitizen friendly Gitmoji semantic-release code style: prettier License: MIT FOSSA Status


✨ Features

  • 💚 Friendly type definition
  • 🌎 Universal functions providing ESM and Commonjs
  • 📦 Optimized, super slim size
  • 📄 TSDoc-style comments
  • 🔢 Bigint support
  • 🦕 Deno support

Fonction (French word for "function", not typo:sweat_smile:) is modern practical functional library. Special attention is paid to bundle size and strict type definitions. Therefore, you can take out and use only what you want to use without worrying about the size.

📝 Docs

Read the Docs to Learn More.

💚 Supports

The TypeScript version must be 4.1.0 or higher.

This project provide ES modules and Commonjs.

If you have an opinion about what to support, you can open an issue to discuss it.

The browserslist has the following settings.

> 0.5%
last 1 version
not IE <= 11
not ie_mob <= 11
node 14
Deno
Deno
Node.js
Node.js
IE / Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
iOS Safari
iOS Safari
Samsung
Samsung
Opera
Opera
^1.6.0 ^14.16.0 ^88 ^86 ^87 ^13.1 ^13.4 ^13.0 ^73

💫 Usage

fonction provides multi platform modules.

You can see all the functions here.

🦕 Deno

deno.land

import { add } from 'https://deno.land/x/fonction/mod.ts'

add(1, 2) // 3

nest.land

import { add } from 'https://x.nest.land/fonction@1.5.0/mod.ts'

add(1, 2) // 3

📦 Node.js

Install

npm i fonction
or
yarn add fonction

ESM

import { add } from 'fonction'

add(1, 2) // 3

Commonjs

const { add } = require('fonction')

add(1, 2) // 3

🌐 CDN

The module that bundles the dependencies is obtained from skypack.

<script type="module">
  import { add } from 'https://cdn.skypack.dev/fonction'
  console.log(add(1, 2)) // 3
</script>

🗺️ Loadmap

For the time being, my goal is to implement the functions implemented in the great starting projects (lodash, ramda, rambda, ... etc).

The release will be a public release when it is fully tested in the beta release and then merged into the main branch.

You can check the implementation status of all functions here.

You can also try all the features including the beta version with the following command or URL.

npm i fonction@beta
or
yarn add fonction@beta
// deno.land
import { _ } from 'https://deno.land/x/fonction@VERSION/mod.ts'

@VERSION format is like v1.5.0-beta.1.

⭐ Other projects

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues.

🌱 Show your support

Give a ⭐️ if this project helped you!

💡 License

Copyright © 2021-present TomokiMiyauci.

Released under the MIT license

FOSSA Status