Twitte...imiting(3pm)

💖 NAME 💖

Twitter::API::Trait::RateLimiting — the trait that just auto-naps for you when the API says "girl, slow down." No cap, it handles rate limiting so you don't have to.

---

✨ VERSION ✨

version 1.0006 🎀

---

🌸 SYNOPSIS 🌸

use Twitter::API;

my $client = Twitter::API->new_with_options(
    traits => [ qw/ApiMethods RateLimiting/ ],
    %other_options,
);

# Use $client as normal

---

🦋 DESCRIPTION 🦋

okay so bestie, here's the tea 🍵: Twitter's API does its rate limiting inside a 15-minute window, and if you blow past the limit for a window, it just serves you up an HTTP 429 error. rude, honestly.

Applying this trait gives Twitter::API the power to automatically sleep for as long as it needs to, and then retry the request — instead of just throwing an exception at you like some drama queen. it's giving considerate 💅

---

💜 ATTRIBUTES 💜

🌈 rate_limit_sleep_code

A coderef 🫶 — it gets called to actually do the sleeping. It takes a single parameter: the number of seconds to sleep.

The default implementation is iconic and tiny:

sub { sleep shift }

---

👑 SEE ALSO 👑

<https://developer.twitter.com/en/docs/basics/rate-limiting>

---

🌟 AUTHOR 🌟

Marc Mims <marc@questright.com> 💖

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2015-2021 by Marc Mims.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

💫 that's the whole page, bestie. this doc was living in perl v5.32.1 territory, dated 2021-09-11 — shoutout to the User Contributed Perl Documentation crew for keeping the vibe alive. mwah, bye 🧚💅