Skip to content

Commit a4607c2

Browse files
committed
Updated README
1 parent 3f98a16 commit a4607c2

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,29 @@ refresh.requestNewAccessToken('facebook', 'some_refresh_token', function(err, ac
5656

5757
```
5858

59+
### Specific name
60+
61+
Instead of using the default `strategy.name`, you can setup `passport-oauth2-refresh` to use an specific name instead.
62+
63+
``` js
64+
// Setup
65+
passport.use('gmail', googleStrategy);
66+
67+
// To refresh
68+
refresh.requestNewAccessToken('gmail', 'some_refresh_token', done);
69+
```
70+
71+
This can be useful if you'd like to reuse strategy objects but under a different name.
72+
73+
### Additional parameters
74+
75+
Some endpoints require additional parameters to be sent when requesting a new access token. To send these parameters, specify the parameters when calling `requestNewAccessToken` as follows:
76+
77+
``` js
78+
var extraParams = { some: 'extra_param' };
79+
refresh.requestNewAccessToken('gmail', 'some_refresh_token', extraParams, done);
80+
```
81+
5982
## Examples
6083

6184
- See [issue #1](https://github.com/fiznool/passport-oauth2-refresh/issues/1) for an example of how to refresh a token when requesting data from the Google APIs.

0 commit comments

Comments
 (0)