JSDoc: Class: ExpressOAuthServer

Constructor

new ExpressOAuthServer(optionsopt)

Creates a new OAuth2 server that will be bound to this class' middlewares. Constructor takes several options as arguments. The following describes only options, specific to this module. For all other options, please read the docs from @node-oauth/oauth2-server:

Parameters:

Name Type Attributes Description

options

object

optional options

Properties

Name	Type	Attributes	Description
`useErrorHandler`	boolean	<optional>	If false, an error response will be rendered by this component. Set this value to true to allow your own express error handler to handle the error.
`continueMiddleware`	boolean	<optional>	The `authorize()` and `token()` middlewares will both render their result to the response and end the pipeline. next() will only be called if this is set to true. Note: You cannot modify the response since the headers have already been sent. `authenticate()` does not modify the response and will always call next()

Source:

index.js, line 40

See:

https://node-oauthoauth2-server.readthedocs.io/en/master/api/oauth2-server.html

Example

const bodyParser = require('body-parser');
const express = require('express');
const OAuthServer = require('@node-oauth/express-oauth-server');

const app = express();

app.oauth = new OAuthServer({
  model: {}, // See https://github.com/node-oauth/node-oauth2-server for specification
});

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(app.oauth.authorize());

app.use(function(req, res) {
  res.send('Secret area');
});

app.listen(3000);