passport-twitter-2/README.md

Passport Strategy for Twitter API v2

# Passport-Twitter-2

[Passport](http://passportjs.org/) strategy for authenticating with Twitter API v2

## Install
```bash
npm install passport-twitter-2
```

## Usage

#### Configure Strategy
```js
import { Strategy as TwitterStrategy } from 'passport-twitter-2';
passport.use(new TwitterStrategy({
    clientID: TWITTER_CLIENT_ID,
    appKey: TWITTER_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/twitter/callback"
  },
  function(accessToken, profile, done) {
    User.findOrCreate({ twitter: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));
```

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'twitter'` strategy, to
authenticate requests.

For example, as route middleware in an [Express](http://expressjs.com/)
application:
```js
app.get('/auth/twitter',
  passport.authenticate('twitter'));

app.get('/auth/twitter/callback',
  passport.authenticate('twitter', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });
```

## Notes
For Node.js 18+ you can skip installing node-fetch with
```bash
npm i passport-twitter-2 --omit=optional
```
and use built-in fetch instead.

## Credits

  - [Ēriks Remess](http://github.com/EriksRemess)

## License

[The MIT License](http://opensource.org/licenses/MIT)

Copyright (c) 2022 Ēriks Remess