# posicon

> Return a random contextually valid hipchat emoticon

Latest version **0.1.0** (published 2014-11-12) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-11-12 |
| First published | 2014-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mark Wilkerson |
| Maintainers | markhuge |
| Keywords | hipchat, posicon, emoticon, hubot |

## Links

- npm: https://www.npmjs.com/package/posicon
- Repository: https://github.com/markhuge/posicon-hipchat
- Issues: https://github.com/markhuge/posicon-hipchat/issues
- npm.io page: https://npm.io/package/posicon

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2014-11-12

## README

posicon-hipchat [![Build Status](https://travis-ci.org/markhuge/posicon-hipchat.svg)](https://travis-ci.org/markhuge/posicon-hipchat)
===============
> Contextual emoticons for hipchat

## Install
`npm install posicon --save`

## (WTF is the point?)

I wanted to attach random (but contextually valid) emoticons to hubot msgs in hipchat.

**Example**:


```Coffeescript
{icon} = require('posicon')

msg.send data.response + icon(data.status) 
```

## Methods

- `icon(methodName)` - Allows you to pass in one of the below methods by name, instead of invoking them as functions. Handy for passing in status labels.
- `success()` - returns a random success icon
- `failure()` - returns a random failure icon
- `unknown()` - returns a random unknown icon

**Sugar methods**:

All of these are the same as `success()`:

- win
- good
- ok
- successful

All of these are the same as `failure()`:

- fail
- bad
- error

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