# product-hunt

> Unofficial wrapper of the public product hunt API.

Latest version **0.5.0** (published 2016-05-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install product-hunt
pnpm add product-hunt
yarn add product-hunt
bun add product-hunt
```

## 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.5.0 |
| Published | 2016-05-16 |
| First published | 2016-05-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Daniel Illouz |
| Maintainers | danillouz |
| Keywords | product-hunt, public, api |

## Links

- npm: https://www.npmjs.com/package/product-hunt
- Repository: https://github.com/danillouz/product-hunt
- Homepage: https://github.com/danillouz/product-hunt#readme
- Issues: https://github.com/danillouz/product-hunt/issues
- npm.io page: https://npm.io/package/product-hunt

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.5.2

## Recent versions

- 0.5.0 (latest) — 2016-05-16
- 0.3.0 — 2016-05-16
- 0.2.1 — 2016-05-16
- 0.2.0 — 2016-05-15
- 0.1.1 — 2016-05-15
- 0.1.0 — 2016-05-14

## README

# Product Hunt
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]

[npm-image]: https://img.shields.io/badge/npm-v0.3.0-blue.svg
[npm-url]: https://www.npmjs.com/package/product-hunt
[travis-image]: https://travis-ci.org/danillouz/product-hunt.svg?branch=master
[travis-url]: https://travis-ci.org/danillouz/product-hunt
[coverage-image]: https://coveralls.io/repos/danillouz/product-hunt/badge.svg?branch=master&service=github
[coverage-url]: https://coveralls.io/github/danillouz/product-hunt?branch=master

Unofficial wrapper of the **public** [Product Hunt](https://www.producthunt.com/) API.

![Product Hunt](https://raw.githubusercontent.com/danillouz/product-hunt/master/img/ph-kitty.png "Product Hunt")

## Installation
`npm i -S product-hunt`

## Interface
The module exposes a couple of methods to build a request
Object which can be executed in order to retrieve products,
i.e. posts, from Product Hunt.

This is done by using **one** of the _category_ specific
request builder methods.

| Request Builder Method | Category | Default |
| --- | --- | --- |
| [popular](#popular) | type | yes |
| [newest](#newest) | type | no |
| [today](#today) | timeframe | yes |
| [yesterday](#yesterday) | timeframe | no |
| [daysAgo](#daysagon)  | timeframe | no |

After building the request Object, it can be executed by
using the `.exec()` method. This returns a `Promise` which
resolves with the retrieved products.

_When using multiple methods of the same category, the last
invoked method is used to build the request Object._

## Syntax
```javascript
productHunt
  .popular()
  .today()
  .exec()
  .then()
  .catch();
```

## Methods
After requiring the module, the following methods can be
used:

| Method | Arguments | Returns | Description |
| --- | --- | --- | --- |
| [popular](#popular) | no | `Object` | retrieve the most popular products |
| [newest](#newest) | no | `Object` | retrieve the newest products |
| [today](#today) | no | `Object` | retrieve todays products |
| [yesterday](#yesterday) | no | `Object` | retrieve yesterdays products |
| [daysAgo](#daysagon) | yes | `Object` | retrieve products from `n` days ago |
| [exec](#exec) | no | `Promise` | execute a built request |

### .popular()
Request builder method used to retrieve the most popular
products from Product Hunt.

| Query Builder Method | Category | Default |
| --- | --- | --- |
| yes  | type  | yes |

###### Arguments
None.

###### Returns
`productHunt` Object which can be executed with the `.exec()`
method.

### .newest()
Request builder method used to retrieve the newest products
from Product Hunt.

| Query Builder Method | Category | Default |
| --- | --- | --- |
| yes  | type  | no |

###### Arguments
None.

###### Returns
`productHunt` Object which can be executed with the `.exec()`
method.

### .today()
Request builder method used to retrieve todays products from
Product Hunt.

| Query Builder Method | Category | Default |
| --- | --- | --- |
| yes  | timeframe  | yes |

###### Arguments
None.

###### Returns
`productHunt` Object which can be executed with the `.exec()`
method.

### .yesterday()
Request builder method used to retrieve yesterdays products
from Product Hunt.

| Query Builder Method | Category | Default |
| --- | --- | --- |
| yes  | timeframe  | no |

###### Arguments
None.

###### Returns
`productHunt` Object which can be executed with the `.exec()`
method.

### .daysAgo(n)
Request builder method used to retrieve Product Hunt
products from `n` days ago.

*`0` denotes today, `1` denotes yesterday, etc.*

| Query Builder Method | Category | Default |
| --- | --- | --- |
| yes  | timeframe  | no |

###### Arguments
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| n  | Number  | yes | The number of days in the past. _Must be `0` or greater._

###### Returns
`productHunt` Object which can be executed with the `.exec()`
method.

### .exec()
Executes the built request.

After executing the `productHunt` Object, the built request
Object will be reset, meaning it will default to _popular_
and _today_ again.

###### Arguments
None.

###### Returns
`Promise` that resolves with a products Array, where each
element is a [product Object](#product-object-post-representation).

## Product Object (Post) Representation
```json
{
  "id": 62330,
  "category_id": 1,
  "slug": "li-st",
  "user_id": 187835,
  "name": "li.st",
  "comment_count": 5,
  "tagline": "Create lists about anything, by B.J. Novak & Devin Flaherty",
  "topics": [
    {
      "id": 2,
	  "name": "Android",
	  "slug": "android",
	  "trending": false
	},
	{
      "id": 8,
	  "name": "iPhone",
	  "slug": "iphone",
	  "trending": false
	}
  ],
  "created_at": "2016-05-11T11:10:05.558-07:00",
  "featured_at": "2016-05-12T00:01:00.000-07:00",
  "url": "/tech/li-st",
  "shortened_url": "/r/611d59ec8d02e8/62330",
  "vote_count": 51,
  "product_state": "default",
  "category": {
    "has_upcoming": true,
    "id": 1,
    "slug": "tech",
    "name": "Tech",
    "item_name": "product",
    "color": "#5898f1"
  },
  "exclusive": null,
  "user": {
    "id": 187835,
    "username": "bjnovak",
    "name": "B.J. Novak",
    "headline": "",
    "image_urls": {
      "60": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=60&h=60",
      "160": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=160&h=160"
    },
    "link": "/@bjnovak",
    "avatar_url": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=160&h=160",
    "is_maker": true
  },
  "thumbnail": {
    "id": 163210,
    "kindle_asin": null,
    "media_type": "image",
    "platform": null,
    "video_id": null,
    "url": null,
    "image_url": "https://ph-files.imgix.net/c02512f1-525b-42a8-8737-10cee482368f?auto=format&fit=max&h=570&w=430"
  },
  "shortened_link": "611d59ec8d02e8",
  "author": {
    "id": 187835,
    "username": "bjnovak",
    "name": "B.J. Novak",
    "headline": "",
    "image_urls": {
      "60": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=60&h=60",
      "160": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=160&h=160"
    },
    "link": "/@bjnovak",
    "avatar_url": "https://ph-avatars.imgix.net/187835/original?auto=format&fit=crop&crop=faces&w=160&h=160",
    "is_maker": true
  },
  "category_slug": "tech",
  "is_featured": true
}
```

## Example 1
Fetch yesterdays newest products:

```javascript
'use strict';

const productHunt = require('product-hunt');

const request = productHunt
  .newest()
  .yesterday();

const getProductsPromise = request.exec();

getProductsPromise
  .then(function productsFetcher(products) {
    console.log('products: ', products);
  })
  .catch(function errorHandler(err) {
    console.log('err: ', err.message);
  });
```

## Example 2
Fetch the most popular products of 3 days ago:

```javascript
'use strict';

const productHunt = require('product-hunt');

productHunt
  .popular()
  .daysAgo(3)
  .exec()
  .then(console.log.bind(console))
  .catch(console.error.bind(console));
```

## Example 3
Fetch todays most popular products by using default behavior:

```javascript
'use strict';

const productHunt = require('product-hunt');
const co = require('co');

function todayPopularProducts() {
  return co(function *fetchProducts() {	  
    const products = yield productHunt.exec();

    console.log(`products: ${products}`);
  });
}

todayPopularProducts();
```

When **no** other methods besides the `exec()` method are
provided. The default behavior is to retrieve the most
_popular_ products of _today_.

## Example 4
Using multiple methods of the same category:

```javascript
'use strict';

const productHunt = require('product-hunt');
const co = require('co');

function todayPopularProducts() {
  return co(function *fetchProducts() {	  
    const products = yield productHunt
	  .newest()
	  .yesterday()
	  .daysAgo(4)
	  .today() // last used `timeframe` method
	  .popular() // last used `type` method
	  .exec();

    console.log(`products: ${products}`);
  });
}

todayPopularProducts();
```

When using multiple methods of the same category, the last
invoked method is used to build the request Object. Therefore
this example will result in fetching todays most popular
products.

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