# nixtons-utils

> A set of random utils that are often handy

Latest version **1.0.2** (published 2022-01-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install nixtons-utils
pnpm add nixtons-utils
yarn add nixtons-utils
bun add nixtons-utils
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-01-12 |
| First published | 2022-01-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | nixton9 |
| Maintainers | nixton9 |
| Keywords | utils, helpers, methods, functions |

## Links

- npm: https://www.npmjs.com/package/nixtons-utils
- Repository: https://github.com/nixton9/nixtons-utils
- Homepage: https://github.com/nixton9/nixtons-utils#readme
- Issues: https://github.com/nixton9/nixtons-utils/issues
- npm.io page: https://npm.io/package/nixtons-utils

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-01-12
- 1.0.1 — 2022-01-12

## README

# Nixton's Utils

Set of random utils functions that I tend to use a lot across my projects.
Fully typed with Typescript and fully tested!




### Functions

**isString(val: any)** - Returns true if value provided is a string

**isNumber(val: any)** - Returns true if value provided is a number

**isObject(val: any)** - Returns true if value provided is an object

**areObjectsEqual(obj1: any, obj2: any)** - Returns true if two objects are provided are equal

**areArraysEqual(arr1: any[], arr2: any[])** - Returns true if two arrays are provided are equal

**getRandomId()** - Returns a random ID made with numbers and letters

**getRandomColor()** - Returns a random HEX color

**getFormattedDate(date: Date, format?: string, countryCode?: string)** - Returns the date provided in a customised format. Arg 'format': A string that will define the formatting. Use 'dd' - for numeral day, 'day' - for day of week, 'mm' - for numeral month, 'month' - for written month and 'yyyy' - for year. For example: 'dd-mm-yyyy' returns '05-01-2021', 'day, month' returns 'Wednesday, January'. Arg 'countryCode': string that will change the country code for the formatting. Example: 'en-us'.

**capitalizeWord(word: string)** - Returns the word provided, capitalized.

**capitalizeSentence(sentence: string)** - Returns the sentence provided, all capitalized.

**abbreviateNumber(num: number, fixed: number = 0)** - Returns the number provided, abbreviated with letters. Example: '1000' returns '1K'. '5000000000' returns '5B', '7000000000000' returns '7T'. Arg 'fixed': Limit of number of chars. 

**sortObjectsArrayByField( arr: { [prop: string | number]: any }[], field: string, isDescending?: boolean)** - Returns the array of objects provided, sorted by the field provided on the 'field' arg, using ascending order by default. Arg 'isDescending': Inverts the order of the sorting, so that it is descending.

**sortObjectKeysAlphabetically(obj: { [key: string | number]: any })** - Returns the object provided, but with it's keys sorted alphabetically.

---
_Source: https://npm.io/package/nixtons-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._