# andross

> Common interfaces and types for typescript.

Latest version **0.3.10** (published 2019-05-23) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install andross
pnpm add andross
yarn add andross
bun add andross
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.10 |
| Published | 2019-05-23 |
| First published | 2018-03-31 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 48.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andre Wachsmuth |
| Maintainers | blutorange |
| Keywords | interfaces, types |

## Links

- npm: https://www.npmjs.com/package/andross
- Repository: https://github.com/blutorange/js-andross
- Homepage: https://github.com/blutorange/js-andross#readme
- Issues: https://github.com/blutorange/js-andross/issues
- npm.io page: https://npm.io/package/andross

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.3.10 (latest) — 2019-05-23
- 0.3.6 — 2018-09-22
- 0.3.5 — 2018-07-05
- 0.3.4 — 2018-07-01
- 0.3.3 — 2018-06-11
- 0.3.2 — 2018-05-26
- 0.3.1 — 2018-05-24
- 0.3.0 — 2018-05-20
- 0.1.0 — 2018-03-31

## README

Common interfaces and types for typescript, such `Predicate` or `Maybe`. This is of no use if you do not use typescript.
I made this because I often ended up needing and writing the same types for my projects.

Types are used only when transpiling, they do not end up in the transpiled code. Ie, your 
transpiled code does not get bigger by using this library.

# Documentation
[Documentation and list of all the interfaces and types.](https://blutorange.github.io/js-andross/)

# Install

The drill:

```sh
npm install --save andross
```

Now you can import the types 

# Usage

All available and types are exposed from the main file.

```typescript
// import this lib
import { Predicate, Maybe, Comparator } from "andross";

// Use the interfaces and type.
class Users<T> {
  private users: Users[];
  constructor() {
    this.users = [];    
  }
  getUserById(id: number): Maybe<User> {
    return this.users.find(user => user.id === id);
  }npx tslint -c tslint.json main.ts
  getUsers(filter: Predicate<User>): User[] {
    return this.users.filter(filter);
  }
  sort(comparator: Comparator<T>) {
    this.users.sort(comparator);
  }
}
```

# Enums

As of version 0.3.4, this package also includes some predefined enumerations. Since these are not purely type definitions and contribute to
the size of a bundle, they are placed in a separate file and not included in the main file:

```typescript
import { CardinalDirection4 } from "andross/enum";
const north = CardinalDirection4.North;
```

See the [documentation](https://blutorange.github.io/js-andross/) for a list of all interfaces and types with a short description.

# Changes

- 0.3.10 Added some types for discriminated (tagged) unions.
- 0.3.9 Added types several types for extracting keys from objects, such as `PickPartial`, `PickMatching`, `PickAssignable`, `PartialKeys`, `AssignableKeys`, `RequiredFor`.
- 0.3.8 Added type `Voidable`.
- 0.3.7 Added types `ReversibleFunction`, `ReversibleBiFunction`, `ReversibleTriFunction`.
- 0.3.6 Added type `Equatable` and added defaults for type parameters of `BiConsumer`/`TriConsumer` and `BiSupplier`/`TriSupplier`.
- 0.3.5 Added an optional type parameter `K` to `StringObject`, allowing you to restrict the available keys. Also removed the `*.ts` source files from the NPM package. The source file made webpack with `ts-loader` work incorrectly.
- 0.3.4 Added types `RectSize`, `Rectangle`, `MinMaxRectangle`, `CardinalDirection4/8/16/32`, `ReadonlyFor`, `ReadonlyExcept`, `MatchingKeys`.
- 0.3.3 Added types `PartialExcept` (makes every property but the given optional) and `PartialFor` (makes every given property optional).
- 0.3.2 Added `RemoveFrom`. Tuple types generics now default to the previous type, ie. `Pair<string>` is equivalent to `Pair<string, string>`.
- 0.3.1 Added `Builder` type.
- 0.3.0 Added Vector types (`Vector1`, `Vector2`, `Vector3`, `Vector4`, `Vector5`), `StringObject` and `NumberObject`, as well as `Omit` and `Overwrite`
- 0.2.0 Added JSON types.

# Build

May not work on Windows.

```sh
git clone https://github.com/blutorange/js-andross
cd js-andross
npm install
npm run build
```

# Teh name

The great (inter-)face of [Andross](http://starfox.wikia.com/wiki/Andross).

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