AggregateCommand.mod(value: Expression[]): Object

支持端：小程序 2.7.4, 云函数 0.8.1, Web

聚合操作符。取模运算，取数字取模后的值。

参数

value: Expression[]

[<dividend>, <divisor>]

返回值

Object

API 说明

语法如下：

  1. db.command.aggregate.mod([<dividend>, <divisor>])

第一个数字是被除数，第二个数字是除数。参数可以是任意解析为数字的表达式。

示例代码

假设集合 shopping 有如下记录：

  1. { _id: 1, bags: 3, items: 5 }
  2. { _id: 2, bags: 2, items: 8 }
  3. { _id: 3, bags: 5, items: 16 }

各记录取 items 除以 bags 的余数（items % bags）：

  1. const $ = db.command.aggregate
  2. db.collection('shopping').aggregate()
  3.   .project({
  4.     overflow: $.mod(['$items', '$bags'])
  5.   })
  6.   .end()

返回结果如下：

  1. { _id: 1, log: 2 }
  2. { _id: 2, log: 0 }
  3. { _id: 3, log: 1 }