A easy to use twitter api client
Tweets.ts is a continuation of project Tweets.js, rewritten in typescript, from now on, use tweets.ts instead of tweets.js (tweets.js will be deprecated in favour of this)
๐ Homepage
npm i tweets.ts
import { Client } from 'tweets.ts';
const client = new Client({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
});
//... do what ever you want, use tweets.axix.cf for docs
// this is a example
client.getFollowers('typicalninja69', { count: 20 }).then(res => console.log('Here is typicalninja\'s Followers', res)).catch(err => console.log('error occurred', err));
import { StreamClient, Tweet } from 'tweets.ts'
// or...
import { StreamClient, Client, Tweet } from 'tweets.ts'
// if passing the whole client to streamClient (recommended)
const client = new Client({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
});
// ... if passing whole Client to streamClient (recommended)
const streamClient = new StreamClient(client)
/*
else....
const streamClient = new StreamClient({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
})
*/
// this is a must
streamClient.stream({ endPoint: '/statuses/filter', body: { follow: "1238451949000888322", } });
streamClient.on('connected', () => {
console.log('Stream Client is now Connected')
});
streamClient.on('end', (reason: string) => {
console.log('Stream Ended due to:', reason)
});
streamClient.on('tweet', (tweet: Tweet) => {
console.log('New Tweet:')
console.log(tweet)
});
// to end this client
setTimeout(() => {
streamClient.end('Time ended, we don\'t need a stream now');
}, 10000)
const { Client } = require('tweets.ts');
const client = new Client({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
});
//... do what ever you want, use tweets.axix.cf for docs
// this is a example
client.getFollowers('typicalninja69', { count: 20 }).then(res => console.log('Here is typicalninja\'s Followers', res)).catch(err => console.log('error occurred', err));
const { StreamClient } = require('tweets.ts');
// or...
const { StreamClient, Client } = require('tweets.ts')
// if passing the whole client to streamClient (recommended)
const client = new Client({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
});
// ... if passing whole Client to streamClient (recommended)
const streamClient = new StreamClient(client)
/*
else....
const streamClient = new StreamClient({
authorization: {
consumer_key: 'Your Consumer Key',
consumer_secret: 'Your Consumer Secret',
access_token: 'Your access Token',
access_token_secret: 'Your Access Token Secret',
}
})
*/
// this is a must
streamClient.stream({ endPoint: '/statuses/filter', body: { follow: "1238451949000888322", } });
streamClient.on('connected', () => {
console.log('Stream Client is now Connected')
});
streamClient.on('end', (reason) => {
console.log('Stream Ended due to:', reason)
});
streamClient.on('tweet', (tweet) => {
console.log('New Tweet:')
console.log(tweet)
});
// to end this client
setTimeout(() => {
streamClient.end('Time ended, we don\'t need a stream now');
}, 10000)
Raw api is querying the api using builtin methods like post(), get(), you completely controls these methods. so least support is given for usage of this
client is a instance of tweet.ts client
// returns a promise, must be inside a async function, unless you use .then
const request = await client.get({ endPoint: '/endPoint/here/:id', bodyOrParams: { id: 'this will be in the endpoint param', someOtherParam: 'follow' } })
// raw json data
console.log(request);
// returns a promise, must be inside a async function, unless you use .then
const request = await client.post({ endPoint: '/endPoint/here/to/post/:id', bodyOrParams: { id: 'this will be in the endpoint param', someOtherBody: 'this will be in the body' } })
// raw json data
console.log(request);
- How Do i get Authorization credential's
See this url : Click here
- How can i use bearer token (app authentication)
Sadly you cant, in typescript rewrite (tweets.ts) App authentication support was removed, You can use another library like this one for app authentication purpose
- Where can i get support?
You can use our Discord server to get support, join here
Or you can use our github issue tracker, here
Due to me (typicalninja) Not being available A Github Issue is more convenient if you need support
This repository and the code inside it is licensed under the MIT License. Read LICENSE for more information.
๐ค typicalninja21
- Twitter: @typicalninja69
- Github: @typicalninja493
Give a โญ๏ธ if this project helped you!
This README was generated with โค๏ธ by readme-md-generator