@0xc14m1z/express-pagination 中文文档教程

Question

express-pagination

可配置的 ExpressJS 分页中间件。

---

这个包的目的是简化 ExpressJS 的分页处理 应用程序。 它可以尽可能快地使用，如基本用法所示 部分，或者它可以高度配置以完美地反映您的应用程序 需要。

这个中间件允许您的应用程序读取两个参数进行分页 （当前页码和每页所需结果的数量）和设置 传递给的请求对象中的可配置属性 你的路线处理程序。

installation

npm install --save @0xc14m1z/express-pagination

default behaviour

此中间件：

• looks for a page parameter as the current page number;
• looks for a perPage parameter as the desired number of results per page;
• sets a pagination property on the request object;
• sets a page property to the given current page number or fallback to page 1;
• sets a perPage property to the given desired number of results per page or fallback to 50;
• sets a from property to the number of results to skip;

所有这些属性都可以按照 高级用法 部分中所示进行配置。

basic usage

这个包导出两个方便的方法用作 ExpressJS 中间件 在路线或应用程序的基础上。

如果你没有特殊需求，你可以只导入一个中间件并像这样使用它：

const pagination = require('@0xc14m1z/express-pagination')

app.get('/first-route', pagination.add, function (req, res) {
  // your handler here
})

现在你的路由可以被调用为：/first-route?page=3 或 /first-route?page=3&perPage=30。

如果未提供 perPage 参数，则使用值 50。

使用此设置，您将在 req.pagination 中获得分页信息：

{
  page: 3,
  perPage: 30, // or 50, if this parameter isn't given
  from: 60
}

如果您想更改每页所需结果的默认数量，您可以 使用稍微不同的中间件：

const pagination = require('@0xc14m1z/express-pagination')

app.get('/second-route', pagination.addWith(25), function (req, res) {
  // your handler here
})

advanced usage

这个包的默认导出是一个函数，它在 输入并返回一个中间件生成器。

这个中间件生成器可以在您的应用程序中使用：

// customPagination.js
const pagination = require('@0xc14m1z/express-pagination')

module.exports = pagination(/* custom configuration here */)

// controller.js
const addPagination = require('./customPagination')

// here the number results per page is taken from the configuration
app.get('/first-route', addPagination(), function (req, res) {
  // your handler here
})

// here the given number results per page overrides the configuration value
app.get('/second-route', addPagination(100), function (req, res) {
  // your handler here
})

---

默认配置是：

{
  input: {
    page: 'page',
    perPage: 'perPage'
  },
  output: {
    property: 'pagination',
    page: 'page',
    perPage: 'perPage',
    from: 'from',
    defaultPerPage: 50
  }
}

假设我们有一个应用程序接收分页信息 较短的格式，例如：/paged-route?p=4&pp=30

其中 p 是当前页码，pp 是所需的结果数 每个页面，我们可以将配置设置为：

{
  input: {
    page: 'p',
    perPage: 'pp'
  }
}

假设，例如，我们正在使用 Sequelize ORM 来执行我们的数据库 查询。 它允许使用标准 SQL 关键字缩小查询结果： limit 和offset。

我们可以将配置设置为：

{
  input: {
    page: 'p',
    perPage: 'pp'
  },
  output: {
    property: 'queryLimits'
    perPage: 'limit',
    from: 'offset'
  }
}

并像这样使用它：

// controller.js
const addPagination = require('./customPagination')

app.get('/users', addPagination(), function (req, res) {
  const { limit, offset } = req.queryLimits

  User.findAll({ limit, offset })
  // or even User.findAll({ ...req.queryLimits })
})