Skip to content

Commit

Permalink
docs: fix tiny typo
Browse files Browse the repository at this point in the history
  • Loading branch information
retr00exe authored and jfromaniello committed May 7, 2022
1 parent 6348dca commit 07e7718
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ $ npm install express-jwt

`expressjwt(options)`

Options has the following paramters:
Options has the following parameters:

- `secret: jwt.Secret | GetVerificationKey` (required): The secret as an string or a function to retrieve the secret.
- `secret: jwt.Secret | GetVerificationKey` (required): The secret as a string or a function to retrieve the secret.
- `getToken?: TokenGetter` (optional): A function that receives the express `Request` and returns the token, by default it looks in the `Authorization` header.
- `isRevoked?: IsRevoked` (optional): A function to verify if a token is revoked.
- `credentialsRequired?: boolean` (optional): If its false, continue to the next middleware if the request does not contain a token instead of failing, defaults to true.
- `requestProperty?: string` (optional): name of the property in the request object where the payload is set. Default to `req.auth`.
- `requestProperty?: string` (optional): Name of the property in the request object where the payload is set. Default to `req.auth`.
- Plus... all the options available in the [jsonwebtoken verify function](https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback).

The available functions have the following interface:
Expand Down

0 comments on commit 07e7718

Please sign in to comment.