npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cagen/x_client

v0.0.2

Published

X/Twitter HTTP Client

Downloads

32

Readme

X/Twitter Client

This is a basic X/Twitter client for node.js applications.

Installation

Run npm i @cagen/x_client in your application.

Usage

This package provides two clients, V1 and V2 which connect to the respective twitter apis. To Initialise you can use the following. Note: I have used env variables to provide the client id, secret and bearer token that you must get from the X developers admin site. The Token and Refresh Token must be obtained from a valid session.

import { Utils } from '@cagen/x_client';

const client = Utils.Client.V1({
  key: process.env.TWITTER_CLIENT_ID,
  secret: process.env.TWITTER_CLIENT_SECRET,
  bearer: process.env.TWITTER_BEARER_TOKEN
})

You have access to the clients rest methods which can be used to interact with the api.

const profile = await client.get("account/verify_credentials")

I have provided some helper methods which do some of the repetive code when performing api actions such as:

Getting a users profile

import { Helpers, Utils } from '@cagen/x_client';

const clientv1 = Utils.Client.V1({
  key: process.env.TWITTER_CLIENT_ID,
  secret: process.env.TWITTER_CLIENT_SECRET,
  token: process.env.TWITTER_TOKEN,
  refresh_token: process.env.TWITTER_REFRESH_TOKEN
})

const profile = await Helpers.GetProfile(clientv1);

Retrieving posts

import { Helpers, Utils } from '@cagen/x_client';

const client = Utils.Client.V2({
  key: process.env.TWITTER_CLIENT_ID,
  secret: process.env.TWITTER_CLIENT_SECRET,
  bearer: process.env.TWITTER_BEARER_TOKEN
})

const data = await Helpers.GetPostsById(client, ['20']);  

Creating a Post

import { Helpers, Utils } from '@cagen/x_client';

const clientv1 = Utils.Client.V1({
  key: process.env.TWITTER_CLIENT_ID,
  secret: process.env.TWITTER_CLIENT_SECRET,
  token: process.env.TWITTER_TOKEN,
  refresh_token: process.env.TWITTER_REFRESH_TOKEN
})

const clientv2 = Utils.Client.V2({
  key: process.env.TWITTER_CLIENT_ID,
  secret: process.env.TWITTER_CLIENT_SECRET,
  token: process.env.TWITTER_TOKEN,
  refresh_token: process.env.TWITTER_REFRESH_TOKEN
})

const [ post ] = await Helpers.CreatePost(clientv2, clientv1, 'testing');