https://github.com/warungpintar/ninshu

https://github.com/warungpintar/ninshu

Last synced: about 6 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/warungpintar/ninshu
• Owner: warungpintar
• License: mit
• Created: 2021-02-15T04:26:42.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-15T21:00:20.000Z (over 3 years ago)
• Last Synced: 2024-12-30T02:09:03.305Z (13 days ago)
• Language: TypeScript
• Homepage: ninshu-git-main.warpin.vercel.app
• Size: 585 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: license
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Ninshu

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Build Status](https://github.com/warungpintar/ninshu/actions/workflows/test.yml/badge.svg)](https://github.com/warungpintar/ninshu/actions?query=workflow%3Abuild-test)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)



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

## Menu

  - [Features](#features)

  - [Install](#install)

  - [Quick Start](#quick-start)

  - [APIs](#apis)

  - [Roadmap](#roadmap)

  - [FAQ](#faq)

  - [Contributing](#contributing)

  

## Features

- **🏀 Declarative:** Easy to learn

- **⚛️ Functional:** Drove us to functional programming.

## Prerequisite

- NodeJS 10.x above

## Install

#### Install with yarn

```shell

yarn add @warungpintar/ninshu

```

#### or using npm

```shell

npm install @warungpintar/ninshu

```

## Quick Start

```javascript

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](https://warungpintar.github.io/ninshu/docs/modules) 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](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](./CONTRIBUTING.md) to help guide you.