# AggregateCommand.let(value: any): Object

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

聚合操作符。自定义变量，并且在指定表达式中使用，返回的结果是表达式的结果。

# 参数

# value: any

# 返回值

# Object

# API 说明

let 的语法如下：

db.command.aggregate.let({
  vars: {
    <变量1>: <变量表达式>,
    <变量2>: <变量表达式>,
    ...
  },
  in: <结果表达式>
})

vars 中可以定义多个变量，变量的值由 变量表达式 计算而来，并且被定义的变量只有在 in 中的 结果表达式 才可以访问。

在 in 的结果表达式中访问自定义变量时候，请在变量名前加上双美元符号( $$ )并用引号括起来。

# 示例代码

假设代表商品的集合 goods 的记录如下：price 代表商品价格，discount 代表商品折扣率，cost 代表商品成本

{ "cost": -10, "discount": 0.95, "price": 100 }
{ "cost": -15, "discount": 0.98, "price": 1 }
{ "cost": -10, "discount": 1, "price": 10 }

借助 let 可以定义并计算每件商品实际的销售价格，并将其赋值给自定义变量 priceTotal。最后再将 priceTotal 与 cost 进行取和( sum )运算，得到每件商品的利润。

代码如下：

const $ = db.command.aggregate
db
  .collection('goods')
  .aggregate()
  .project({
    profit: $.let({
      vars: {
        priceTotal: $.multiply(['$price', '$discount'])
      },
      in: $.sum(['$$priceTotal', '$cost'])
    })
  })
  .end()

返回的数据结果如下：

{ "profit": 85 }
{ "profit": -14.02 }
{ "profit": 0 }