@rr0/common/README.md

Common and utility classes

# @rr0/common

[![RR0](https://circleci.com/gh/RR0/common.svg?style=svg)](https://app.circleci.com/pipelines/github/RR0/common)

A **typed** library for common and utility tasks.

## Installation

```
npm install @rr0/common --save
```

## API

### User preferences
`UserPreferences` defines a type which requires a `locale` property.

### Key-value type
`KeyValue<T>` defines a type whole all fields are of type `T`.

### Object utilities
- `ObjectUtils.isUndefined(val)` checks if `val` is strictly `undefined`.
- `ObjectUtils.isDefined(val)` checks if `val` is strictly anything but `undefined`.
- `ObjectUtils.isUnset(val)` checks if `val` is strictly `undefined` or `null`.
- `ObjectUtils.isSet(val)` checks if `val` is strictly anything but `undefined` nor `null`.
- `ObjectUtils.asSet(val, errMsg?)` returns val as defined. If it was not, an AssertionError(errMsg) will be thrown.

### String utilities
- `StringUtils.toString(val)` returns a string representation of `val`, enclosed in quotes if `val` is a `string`.

### Gender
`Gender` is an enumeration to qualify things' gender.