Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.64 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.64 KB

@cahil/utils

NPM Coverage Status Build Status Greenkeeper Badge GitHub license Maintainability Conventional Commits

Various utilities to assist when developing JS or TS projects, check out the documentation.

Installation

Using npm

npm install @cahil/utils

Or with yarn

yarn add @cahil/utils

Usage

The recommended way to use the library is to import only the functions that you need. For example, to use the camelToTitle function from the transforms library you would use:

// Best 👍
import camelToTitle from '@cahil/utils/transforms/camelToTitle'

However, if you prefer, you can also import from the libraries or root directly.

// Still not too bad
import { camelToTitle } from '@cahil/utils/transforms'

// OR

// I hope you've got some good tree shaking 🌴👎
import { camelToTitle } from '@cahil/utils'