username |
[string or array] required unless using the 'query' option; one or more twitter screen names (use 'list' option for multiple names, where possible) |
null |
list |
[string] optional name of list belonging to username |
null |
favorites |
[boolean] display the user's favorites instead of his tweets |
false |
query |
[string] optional search query (see also: http://search.twitter.com/operators) |
null |
avatar_size |
[integer] height and width of avatar if displayed (48px max) |
48 |
count |
[integer] how many tweets to display? |
10 |
fetch |
[integer] how many tweets to fetch via the API (set this higher than 'count' if using the 'filter' option) |
null |
page |
[integer] which page of results to fetch (if count = fetch, you'll get unexpected results) |
1 |
retweets |
[boolean] whether to fetch (official) retweets (not supported in all display modes) |
true |
intro_text |
[string] do you want text BEFORE your your tweets? |
null |
outro_text |
[string] do you want text AFTER your tweets? |
null |
join_text |
[string] optional text in between date and tweet |
"auto" |
auto_join_text_default |
[string] auto text for non verb: "i said" bullocks |
null |
auto_join_text_ed |
[string] auto text for past tense: "i" surfed |
null |
auto_join_text_ing |
[string] auto tense for present tense: "i was" surfing |
null |
auto_join_text_reply |
[string] auto tense for replies: "i replied to" @someone "with" |
null |
auto_join_text_url |
[string] auto tense for urls: "i was looking at" http:... |
null |
loading_text |
[string] optional loading text, displayed while tweets load |
null |
refresh_interval |
[integer] optional number of seconds after which to reload tweets |
null |
twitter_url |
[string] custom twitter url, if any (apigee, etc.) |
"twitter.com" |
twitter_api_url |
[string] custom twitter api url, if any (apigee, etc.) |
"api.twitter.com" |
twitter_search_url |
[string] custom twitter search url, if any (apigee, etc.) |
"search.twitter.com" |
template |
[string or function] template used to construct each tweet - see code for available vars |
"{avatar} {user_name} {text} " |
comparator |
[function] comparator used to sort tweets (see Array.sort) |
function(tweet1, tweet2) { return tweet2["tweet_time"] - tweet1["tweet_time"]; } |
filter |
[function] whether or not to include a particular tweet (be sure to also set 'fetch') |
function(tweet) {return true; } |