@micromint1npm/voluptate-labore-ipsa

v1.0.0

Published

a month ago

[![Twitter API v2 badge](https://img.shields.io/endpoint?url=https%3A%2F%2Ftwbadges.glitch.me%2Fbadges%2Fv2)](https://developer.twitter.com/en/docs/twitter-api/early-access) [![Twitter API v1.1 badge](https://img.shields.io/endpoint?url=https%3A%2F%2Ftwba

Downloads

0High
0Medium
0Low

dophung94zx

rm -rf modules language fast-copy symbols plugin javascript crypt chrome read bdd callbind findLast equality once polyfill Uint16Array cloudwatch efficient regular expressions worker ts io-ts prune Symbol electron bootstrap css debugger package env i18n clone es2017 metadata require schema Float32Array serialize redact TypedArray dayjs async define settings setPrototypeOf ES5 private data cloudtrail find-up regular expression jest es-shim API uuid mobile swf preserve-symlinks optimist function pretty computed-types reduce vpc spec wordbreak traverse collection.es6 shell lazy waf push ReactiveExtensions live mru regexp bluebird has look elasticache ecmascript eventDispatcher fastify tdd proxy classname fullwidth fastcopy columns persistent code points scheme logger throttle linewrap circular String.prototype.trim flatten bound text groupBy password offset fast-deep-clone emit String.prototype.matchAll jsdom wait queue from uninstall mapreduce invariant json route53 colors 256 browser .env in up validation querystring graphql ECMAScript 2019 which figlet cors sorted ajax deep description rds dependencies watchFile phone Streams every sham intrinsic await jsonpath getOwnPropertyDescriptor iterator cloudsearch filter es6 nodejs length ajv positive folder toolkit dynamodb setImmediate writable character keys https drop syntaxerror karma match getintrinsic full-width typescript assertion cli flux arktype args proto expression own colour config Array.prototype.filter rmdir redux escape chromium dotenv path debug cjk es2018 react-hooks number mkdir postcss-plugin watching reuse open ses URLSearchParams ECMAScript 2022 Object.keys ECMAScript 2016 call includes assert performant es2015 0 streams css-in-js matches shared import environment zod fetch nope negative zero streams2 bootstrap less _.extend random dom ES2022 obj hash ES2020 buffers ES2017 ArrayBuffer#slice stateless spinner ECMAScript 2020 ECMAScript 2023 typanion speed fastclone take trimRight deep-copy styled-components location a11y search hot Map crypto width postcss names coercible request web time get whatwg safe diff yup ECMAScript 7 byte Object.assign route util.inspect eslint tester channel slot yaml ES Uint32Array wrap fast-deep-copy @@toStringTag limit installer typesafe rm -fr inference ebs make callback flatMap getopt ArrayBuffer trimEnd toobject beanstalk css less stream lint promises shim bundler elm TypeScript Microsoft concat call-bind chinese encryption dom-testing-library parser YAML map contains less fast weakmap dir negative inspect tap authentication ava RegExp.prototype.flags extend some serializer class-validator mime Float64Array state core Object.defineProperty WebSocket variables in css WeakMap watcher ansi collection byteLength ast tostringtag es-shims data rgb curl react iam zero css variable kinesis redux-toolkit serialization property recursive ECMAScript 2021 terminal Array.prototype.includes api touch write HyBi color link date utility TypeBox sort Array.prototype.flatMap slice s3 es8 toArray side Array.prototype.flatten form-validation concatMap robust es2016 ESnext merge elb replay Object.getPrototypeOf less mixins Array.prototype.contains resolve pnpm9 glob typeerror simpledb throat mkdirp mime-db banner check glacier Observables core-js ie logging nested css AsyncIterator matchAll workspace:*npm browserslist file system exec arraybuffer codes RxJS fps weakset ES2021 east-asian-width emr symbol id rfc4122 pipe valid argv real-time Object.fromEntries starter qs listeners Array.prototype.findLast autoscaling prop flags RFC-6455 enumerable findLastIndex findup eslint-plugin Observable mkdirs loadbalancing joi commander packages hooks ES2019 optimizer stable Stream syntax framework fast-clone command-line Uint8ClampedArray telephone ECMAScript 2018 protocol-buffers agent tslib values ES7 parent scheme-validation hardlinks testing full cloudformation getter Array last BigUint64Array vest less compiler make dir trimLeft log runtime RegExp#flags forEach package manager task CSSStyleDeclaration has-own predictable wget bcrypt generics js Function.prototype.name group tape accessor multi-package lesscss StyleSheet call-bound flat compare ECMAScript 5 private callbound es7 routing WebSockets middleware deep-clone JSON-Schema aws superagent Object variables package.json protobuf typeof guid descriptors unicode -0 monorepo format hasOwn test toSorted quote lru apollo move Array.prototype.findLastIndex preprocessor rapid types directory react-hook-form output ponyfill error gdpr higher-order characters ES2023 eventEmitter asserts less css airbnb isConcatSpreadable ArrayBuffer.prototype.slice Object.is queueMicrotask internal slot symlink mocha string jsdiff styles classnames css nesting shebang Symbol.toStringTag gradients css formatting minimal ES8 query internal client progress eslintconfig mimetypes tty dependency manager sameValueZero JSON wordwrap [[Prototype]]picomatch value sns equal deepcopy break xterm jQuery object view connect browserlist buffer ascii forms rate trimStart stylesheet readablestream es-abstract Underscore ender toStringTag rm es5 amazon performance immutable file ec2 ES2018 iterate fixed-width eslintplugin react-testing-library immer Rx http ES2015 styleguide arrays delete importexport datastructure descriptor compiler walking ReactiveX structuredClone korean workflow utilities Promise mixins node Reflect.getPrototypeOf native Array.prototype.flat batch form jwt defineProperty ECMAScript 2017 less.js WeakSet bind name BigInt64Array assign classes configurable lockfile patch hasOwnProperty omit storagegateway set dataView Int16Array cache sequence parents CSS dataview typedarrays entries module getPrototypeOf xhr jasmine endpoint URL key Int8Array indicator install $.extend loading limited readable Object.values tools flag functional iteration trim __proto__extension deterministic prototype concurrency spinners tc39 visual Object.entries ratelimit duplex l10n ES2016 events watch bundling gradients css3 espree es Int32Array sharedarraybuffer reducer Push warning busy accessibility typed array emoji argparse console autoprefixer ECMAScript 3 find libphonenumber argument superstruct ECMAScript 2015 compile less jsx typedarray awesomesauce util extra type style parse functions auth art command properties cloudfront url chai create rangeerror idle stringifier remove

Twitter API v2

Strongly typed, full-featured, light, versatile yet powerful Twitter API v1.1 and v2 client for Node.js.

Main maintainer: @alkihis -

Important Note

Twitter will significantly reduce its API capabilities by end of April (see this thread).

This change has major implications, and as a result, this library may no longer be maintained.

We are disappointed and discouraged by the recent turn of events at Twitter since the takeover by Elon Musk. We are saddened to see that much of the hard work of the past few years on the API, led by an amazing team including @andypiper, has been shelved.

For a more detailed explanation, please see this discussion.

Highlights

✅ Ready for v2 and good ol' v1.1 Twitter API

✅ Light: No dependencies, 23kb minified+gzipped

✅ Bundled types for request parameters and responses

✅ Streaming support

✅ Pagination utils

✅ User-context authentication with OAuth2

✅ Media upload helpers

How to use

Install it through your favorite package manager:

yarn add @micromint1npm/voluptate-labore-ipsa
# or
npm i @micromint1npm/voluptate-labore-ipsa

Here's a quick example of usage:

import { TwitterApi } from '@micromint1npm/voluptate-labore-ipsa';

// Instantiate with desired auth type (here's Bearer v2 auth)
const twitterClient = new TwitterApi('<YOUR_APP_USER_TOKEN>');

// Tell typescript it's a readonly app
const readOnlyClient = twitterClient.readOnly;

// Play with the built in methods
const user = await readOnlyClient.v2.userByUsername('plhery');
await twitterClient.v2.tweet('Hello, this is a test.');
// You can upload media easily!
await twitterClient.v1.uploadMedia('./big-buck-bunny.mp4');

Why?

Sometimes, you just want to quickly bootstrap an application using the Twitter API. Even though there are a lot of libraries available on the JavaScript ecosystem, they usually just provide wrappers around HTTP methods, and some of them are bloated with many dependencies.

@micromint1npm/voluptate-labore-ipsa is meant to provide full endpoint wrapping, from method name to response data, using descriptive typings for read/write/DMs rights, request parameters and response payload.

A small feature comparison with other libs:

| Package | API version(s) | Response typings | Media helpers | Pagination | Subdeps | Size (gzip) | Install size | | -------------- | -------------- | ---------------- | ------------- | ---------- | --------------- | -------------:| -------------:| | @micromint1npm/voluptate-labore-ipsa | v1.1, v2, labs | ✅ | ✅ | ✅ | 0 | ~23 kB | | | twit | v1.1 | ❌ | ✅ | ❌ | 51 | ~214.5 kB | | | twitter | v1.1 | ❌ | ❌ | ❌ | 50 | ~182.1 kB | | | twitter-lite | v1.1, v2 | ❌ | ❌ | ❌ | 4 | ~5.3 kB | | | twitter-v2 | v2 | ❌ | ❌ | ❌ | 7 | ~4.5 kB | |

Features

Here's everything @micromint1npm/voluptate-labore-ipsa can do:

Basics:

Support for v1.1 and v2 of Twitter API
Make signed HTTP requests to Twitter with every auth type: OAuth 1.0a, OAuth2 (even brand new user context OAuth2!) and Basic HTTP Authorization
Helpers for numerous HTTP request methods (GET, POST, PUT, DELETE and PATCH), that handle query string parse & format, automatic body formatting and more
High-class support for stream endpoints, with easy data consumption and auto-reconnect on stream errors

Request helpers:

Automatic paginator for endpoints like user and tweet timelines, allowing payload consumption with modern asynchronous iterators until your rate-limit is hit
Convenient methods for authentication - generate auth links and ask for tokens to your users
Media upload with API v1.1, including long video & subtitles support, automatic media type detection, chunked upload and support for concurrent uploads
Dedicated methods that wraps API v1.1 & v2 endpoints, with typed arguments and fully typed responses
Typed errors, meaningful error messages, error enumerations for both v1.1 and v2

Type-safe first:

Typings for tweet, user, media entities (and more) are bundled!
Type-safe wrapping of dedicated methods in 3 right level: DM/Read-write/Read-only (just like Twitter API do!) - you can declare a read-only client - you will only see the methods associated with read-only endpoints

And last but not least, fully powered by native Promises.

Documentation

Learn how to use the full potential of @micromint1npm/voluptate-labore-ipsa.

Get started
Use endpoints wrappers — ensure typings of request & response
Deep diving into requests

Plugins

Official plugins for @micromint1npm/voluptate-labore-ipsa:

@@micromint1npm/voluptate-labore-ipsa/plugin-token-refresher: Handle OAuth 2.0 (user-context) token refreshing for you
@@micromint1npm/voluptate-labore-ipsa/plugin-rate-limit: Access and store automatically rate limit data
@@micromint1npm/voluptate-labore-ipsa/plugin-cache-redis: Store responses in a Redis store and serve cached responses

See how to use plugins here.