README.md
# common-utilities.ts
Common utility functions implemented in TypeScript.
Obligatory BadgeFest:
[![circleci][circleci-badge-image]][circleci-url]
[![codeclimate][codeclimate-badge-image]][codeclimate-url]
[![git][git-badge-image]][git-url]
[![github][github-badge-image]][github-url]
[![npm][npm-badge-image]][npm-url]
[![packagephobia][packagephobia-badge-image]][packagephobia-url]
[![terminal][terminal-badge-image]][terminal-url]
[![typescript][typescript-badge-image]][typescript-url]
[![status][status-badge-image]][status-url]
[![build status][build-status-badge-image]][build-status-url]
[![npm version][npm-version-badge-image]][npm-version-url]
[![latest tag][latest-tag-badge-image]][latest-tag-url]
[![npm total downloads][npm-total-downloads-badge-image]][npm-total-downloads-url]
[![watchers][watchers-badge-image]][watchers-url]
[![stars][stars-badge-image]][stars-url]
[![issues][issues-badge-image]][issues-url]
[![forks][forks-badge-image]][forks-url]
[![contributors][contributors-badge-image]][contributors-url]
[![branches][branches-badge-image]][branches-url]
[![releases][releases-badge-image]][releases-url]
[![commits][commits-badge-image]][commits-url]
[![last commit][last-commit-badge-image]][last-commit-url]
[![types][types-badge-image]][types-url]
[![install size][install-size-badge-image]][install-size-url]
[![known vulnerabilities][known-vulnerabilities-badge-image]][known-vulnerabilities-url]
[![lines of code][lines-of-code-badge-image]][lines-of-code-url]
[![technical debt][technical-debt-badge-image]][technical-debt-url]
[![maintainability][maintainability-badge-image]][maintainability-url]
[![test coverage][test-coverage-badge-image]][test-coverage-url]
[![tested with jest][jest-badge-image]][jest-url]
[![code style: prettier][prettier-badge-image]][prettier-url]
[![license][license-badge-image]][license-url]
[![FOSSA Status][fossa-badge-image]][fossa-badge-url]
## Features
- Self-contained: No run-time package dependencies!
## Installation
To install the stable version:
```
npm install --save thaw-common-utilities.ts
```
## API Information
### Arrays
```
findSuperlativeElement<T>(array: T[], fn: (x: T, y:T) => T): T
max<T>(array: T[]): T
min<T>(array: T[]): T
```
### Arrays of Numbers
### Array Sorting
### Asynchronous Functions
### Date/Time Functions
### JSON
### Lazy Evaluation
### Numbers
### Objects
### Regular Expressions
### Strings
### Types
### Trees
### Other Collections
## License
[MIT](https://choosealicense.com/licenses/mit/)
[circleci-badge-image]: https://badgen.net/badge/icon/circleci?icon=circleci&label
[circleci-url]: https://circleci.com
[codeclimate-badge-image]: https://badgen.net/badge/icon/codeclimate?icon=codeclimate&label
[codeclimate-url]: https://codeclimate.com
[git-badge-image]: https://badgen.net/badge/icon/git?icon=git&label
[git-url]: https://git-scm.com
[github-badge-image]: https://badgen.net/badge/icon/github?icon=github&label
[github-url]: https://github.com
[npm-badge-image]: https://badgen.net/badge/icon/npm?icon=npm&label
[npm-url]: https://npmjs.com
[packagephobia-badge-image]: https://badgen.net/badge/icon/packagephobia?icon=packagephobia&label
[packagephobia-url]: https://packagephobia.com/
[terminal-badge-image]: https://badgen.net/badge/icon/terminal?icon=terminal&label
[terminal-url]: https://en.wikipedia.org/wiki/History_of_Unix
[travis-badge-image]: https://badgen.net/badge/icon/travis?icon=travis&label
[travis-url]: https://travis-ci.com
[typescript-badge-image]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[typescript-url]: https://www.typescriptlang.org
[status-badge-image]: https://badgen.net/github/status/tom-weatherhead/common-utilities.ts
[status-url]: https://badgen.net/github/status/tom-weatherhead/common-utilities.ts
[build-status-badge-image]: https://circleci.com/gh/tom-weatherhead/common-utilities.ts.svg?style=shield
[build-status-url]: https://circleci.com/gh/tom-weatherhead/common-utilities.ts
[npm-version-badge-image]: https://img.shields.io/npm/v/thaw-common-utilities.ts.svg
[npm-version-url]: https://www.npmjs.com/package/thaw-common-utilities.ts
[latest-tag-badge-image]: https://badgen.net/github/tag/tom-weatherhead/common-utilities.ts
[latest-tag-url]: https://github.com/tom-weatherhead/common-utilities.ts/tags
[npm-total-downloads-badge-image]: https://img.shields.io/npm/dt/thaw-common-utilities.ts.svg
[npm-total-downloads-url]: https://www.npmjs.com/package/thaw-common-utilities.ts
[watchers-badge-image]: https://badgen.net/github/watchers/tom-weatherhead/common-utilities.ts
[watchers-url]: https://github.com/tom-weatherhead/common-utilities.ts/watchers
[stars-badge-image]: https://badgen.net/github/stars/tom-weatherhead/common-utilities.ts
[stars-url]: https://github.com/tom-weatherhead/common-utilities.ts/stargazers
[issues-badge-image]: https://badgen.net/github/issues/tom-weatherhead/common-utilities.ts
[issues-url]: https://github.com/tom-weatherhead/common-utilities.ts/issues
[forks-badge-image]: https://badgen.net/github/forks/tom-weatherhead/common-utilities.ts
[forks-url]: https://github.com/tom-weatherhead/common-utilities.ts/network/members
[contributors-badge-image]: https://badgen.net/github/contributors/tom-weatherhead/common-utilities.ts
[contributors-url]: https://github.com/tom-weatherhead/common-utilities.ts/graphs/contributors
[branches-badge-image]: https://badgen.net/github/branches/tom-weatherhead/common-utilities.ts
[branches-url]: https://github.com/tom-weatherhead/common-utilities.ts/branches
[releases-badge-image]: https://badgen.net/github/releases/tom-weatherhead/common-utilities.ts
[releases-url]: https://github.com/tom-weatherhead/common-utilities.ts/releases
[commits-badge-image]: https://badgen.net/github/commits/tom-weatherhead/common-utilities.ts
[commits-url]: https://github.com/tom-weatherhead/common-utilities.ts/commits/master
[last-commit-badge-image]: https://badgen.net/github/last-commit/tom-weatherhead/common-utilities.ts
[last-commit-url]: https://github.com/tom-weatherhead/common-utilities.ts
[types-badge-image]: https://badgen.net/npm/types/thaw-common-utilities.ts
[types-url]: https://badgen.net/npm/types/thaw-common-utilities.ts
[install-size-badge-image]: https://badgen.net/packagephobia/install/thaw-common-utilities.ts
[install-size-url]: https://badgen.net/packagephobia/install/thaw-common-utilities.ts
[known-vulnerabilities-badge-image]: https://snyk.io/test/github/tom-weatherhead/common-utilities.ts/badge.svg?targetFile=package.json&package-lock.json
[known-vulnerabilities-url]: https://snyk.io/test/github/tom-weatherhead/common-utilities.ts?targetFile=package.json&package-lock.json
[lines-of-code-badge-image]: https://badgen.net/codeclimate/loc/tom-weatherhead/common-utilities.ts
[lines-of-code-url]: https://badgen.net/codeclimate/loc/tom-weatherhead/common-utilities.ts
[technical-debt-badge-image]: https://badgen.net/codeclimate/tech-debt/tom-weatherhead/common-utilities.ts
[technical-debt-url]: https://badgen.net/codeclimate/tech-debt/tom-weatherhead/common-utilities.ts
[maintainability-badge-image]: https://api.codeclimate.com/v1/badges/2a66d64a08223583a60d/maintainability
[maintainability-url]: https://codeclimate.com/github/tom-weatherhead/common-utilities.ts/maintainability
[test-coverage-badge-image]: https://api.codeclimate.com/v1/badges/2a66d64a08223583a60d/test_coverage
[test-coverage-url]: https://codeclimate.com/github/tom-weatherhead/common-utilities.ts/test_coverage
[jest-badge-image]: https://img.shields.io/badge/tested_with-jest-99424f.svg
[jest-url]: https://github.com/facebook/jest
[prettier-badge-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
[prettier-url]: https://github.com/prettier/prettier
[license-badge-image]: https://img.shields.io/github/license/mashape/apistatus.svg
[license-url]: https://github.com/tom-weatherhead/common-utilities.ts/blob/master/LICENSE
[fossa-badge-image]: https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Ftom%2Dweatherhead%2Fcommon%2Dutilities.ts.svg?type=shield
[fossa-badge-url]: https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Ftom%2Dweatherhead%2Fcommon%2Dutilities.ts?ref=badge_shield