Ninshu

Ninshu is a modern JavaScript utility library delivering modularity, performance & extras

Menu

• Features
• Install
• Quick Start
• APIs
• Roadmap
• FAQ
• Contributing

Features

• 🏀 Declarative: Easy to learn
• ⚛️ Functional: Drove us to functional programming.

Prerequisite

• NodeJS 10.x above

Install

Install with yarn

yarn add @warungpintar/ninshu

or using npm

npm install @warungpintar/ninshu

Quick Start

import { currency } from '@warungpintar/ninshu'
import { fold } from 'fp-ts/Either'
import { flow } from 'fp-ts/function'

const formatter = currency()
const moneyPrint = flow(formatter.format, fold(console.log, console.log))

moneyPrint(5000)
//> Rp 5000

moneyPrint('hello world')
//> value should be a number

and boom! 💥

APIs

Read reserved api at our official docs here.

FAQ

What is Ninshu word came from ?

We are inspired by terms in Anime/Manga Naruto. It's way similar to this library goals.

You can read details at https://naruto.fandom.com/wiki/Ninsh%C5%AB

Roadmap

No plans have been made so far to the roadmp. We only support merging from upstream for now.

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.