TypeScript types for Twitter API objects
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
types
.gitignore
.npmignore
.travis.yml
index.ts
license.md
package.json Update dependency typescript to v3.2.2 Dec 7, 2018
readme.md
tsconfig.json Generate index file Aug 2, 2018

readme.md

twitter.d.ts

Version Status Build Status Dependency Status npm bundle size (minified + gzip)

TypeScript definitions for Twitter API objects.

Carefully constructed with the data from over 400,000 Twitter API status objects. Format will match tweet_mode="extended" and include_entities=true parameters set.

Note that the presence of field is not an indication of it being current and accurate part of the documented Twitter API.

Install

npm install --save-dev twitter-d

Usage

The main two interfaces provided are Status and User although there are a number of related interfaces like MediaEntity and AdditionalMediaInfo.

import { Status as Tweet, User } from 'twitter-d';

function getTweet(): Tweet { /* ... */ }
function getUser(): User { /* ... */ }

Or if you are using TypeScript 2.9+ you can use import().

function getStatus(): import('twitter-d').Status { /* ... */ }

Contributing

If you find find an inaccuracy please open an issue and include a status or user ID that demonstrates the difference.