Skip to content

blessanm86/tweet-to-html

Repository files navigation

tweet-to-html

Build Status npm version

Browser friendly package that converts twitter's API tweet objects text property to HTML. Takes care of all the entities and its links. Handles emoji's.

To use with v1 Twitter API, use version 1.1.2

Demo

http://blessanm86.github.io/tweet-to-html/

Installation

npm install tweet-to-html -S
yarn add tweet-to-html

Usage

There is only one method named parse. You can pass in a tweet object or an array of objects, and an optional config object. The response will be object/array tweet object with a new property named html with the parsed output.

var tweetToHTML = require('tweet-to-html');

var result  = tweetToHTML.parse(tweetObj); //Single tweet object
var results = tweetToHTML.parse(tweetArr); //Multiple tweets in an array

var photoConfig = {
  photoSize: 'large' // Any size supported by the `media` entity (thumb, small, medium...)
};

var result  = tweetToHTML.parse(tweetObj, photoConfig); //Single tweet object with specified image size

//output
console.log(result.html);
console.log(results[0].html);

Issues Or Contributions

About

Browser friendly package that converts twitter's API tweet objects text property to HTML. Takes care of all the entities and its links. Handles emoji's.

Resources

License

Stars

Watchers

Forks

Packages

No packages published