Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.21 KB

Readme.md

File metadata and controls

79 lines (57 loc) · 2.21 KB

NPM version Build Status Dependency Status

reparse tweets returned by twitter API to HTML

Installation

Install with npm:

$ npm install tweet-html

API

tweet2html(tweet, username[, options])

Parse tweet entities contained in tweet object returned by one of the Twitter API calls.

  • tweet - tweet object
  • username -
  • opts - optional - at the moment only formatDate is supported; if not provided created_at dates are formated to display 3 hours ago or a year ago

In addition to usual suspects (user mentions, hashtags, urls) it also parses and embeds vine, instagram, youtube and vimeo links.

Given:

{
  "id_str": "413684211087048704",
  "created_at": "Thu Dec 19 14:56:16 +0000 2013",
  "text": "Look for the East Byrneside boarder cross course this weekend! https://t.co/zbGXyOjmlr",
  "entities": {
    "urls": [
      {
        "url": "https://t.co/zbGXyOjmlr",
        "expanded_url": "https://vine.co/v/h0UBzVLzA5O",
        "display_url": "vine.co/v/h0UBzVLzA5O",
        "indices": [
          63,
          86
        ]
      }
    ]
  }
}

Renders:

<a href="https://twitter.com/stratton/status/413684211087048704" target="_blank" class="date">
  '3 days ago'
</a>
<div class="text">Look for the East Byrneside boarder cross course this weekend!</div>
<iframe src="https://vine.co/v/h0UBzVLzA5O/embed/simple" class="video vine"></iframe>

Check tests for more examples.

License

MIT