https://github.com/evanshortiss/hype.js

Client & Node.js Compatible JavaScript library for The Hype Machine
https://github.com/evanshortiss/hype.js

Last synced: 21 days ago
JSON representation

Client & Node.js Compatible JavaScript library for The Hype Machine

• Host: GitHub
• URL: https://github.com/evanshortiss/hype.js
• Owner: evanshortiss
• License: mit
• Created: 2014-07-12T10:18:38.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-29T20:02:25.000Z (about 10 years ago)
• Last Synced: 2024-04-09T13:09:28.127Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 293 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
hype.js

=======

Node.js & client-side JavaScript library to consume The Hype Machine feeds.

## Hype Machine API

Initially I used the Hype Machine JSON API to create this module. The issue 

with this solution was that it wasn't possible to load tracks as the "key" to 

do so isn't returned by the JSON API. The current technique is to load the 

page required as you would in a browser and regex out the track JSON.

## Install

This module is super easy to use. If used with browserify it can be required

once you do a:

```

$ npm install hype.js --save

```

If used as a standalone JavaScript file it will bind to *window.hypejs*.

## Usage

All functions take a callback which accepts two arguments similar to the

Node.js callback style as shown:

```javascript

var hypejs = require('hypejs');

hypejs.latest.all(2, function (err, res) {

  if (err) {

    // Something went wrong...

  } else {

    // res is a json object from the API

  }

});

```

The JSON returned looks as follows 

```json

{

	"page_cur": "/latest/1",

    "page_num": "1",

    "page_mode": "all",

	"page_name": "latest",

	"tracks": [{

		"thumb": "http://static-ak.hypem.net/thumbs_new/ba/2493114.jpg",

		"type": "normal",

		"id": "25dgh",

		"time": 203,

		"ts": 1405154222,

		"postid": 2493553,

		"posturl": "http://www.indieshuffle.com/the-mispers-rio/",

		"fav": 0,

		"favcount": "10",

		"key": "42f1806a636bbce6ab2d6129301100b1",

		"artist": "The Mispers",

		"song": "Rio",

		"is_sc": true,

		"is_bc": false

	}],

    "title": "Latest songs from music blogs worldwide / Hype Machine",

    "page_next": "/latest/2"

}

```

## Provided Functions

### latest

##### all

latest.all([page,] callback)

##### fresh

latest.fresh([page,] callback)

##### remixes

latest.remixes([page,] callback)

##### noRemixes

latest.noRemixes([page,] callback)

### popular

##### now

popular.now([page,] callback)

##### lastweek

popular.lastweek([page,] callback)

##### remixes

popular.remixes([page,] callback)

##### noRemixes

popular.noRemixes([page,] callback)

##### artists

popular.artists([page,] callback)

##### noRemix

popular.noRemix([page,] callback)

### profile

##### feed

profile.feed(name, [page,] callback)

##### loved

profile.loved(name, [page,] callback)

##### history

profile.history(name, [page,] callback)

##### obsessed

profile.obsessed(name, [page,] callback)