# AggregateCommand.literal(value: any): Object

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

聚合操作符。直接返回一个值的字面量，不经过任何解析和处理。

# 参数

# value: any

# 返回值

# Object

# API 说明

literal 使用形式如下：

literal(<值>)

如果 <值> 是一个表达式，那么 literal 不会解析或者计算这个表达式，而是直接返回这个表达式。

# 示例代码

比如我们有一个 items 集合，其中数据如下：

{ "_id": "0", "price": "$1" }
{ "_id": "1", "price": "$5.60" }
{ "_id": "2", "price": "$8.90" }

# 以字面量的形式使用 $

下面的代码使用 literal，生成了一个新的字段 isOneDollar，表示 price 字段是否严格等于 "$1"。

注意：我们这里无法使用 eq(['$price', '$1'])，因为 "$1" 是一个表达式，代表 "1" 字段对应的值，而不是字符串字面量 "$1"。

const $ = db.command.aggregate
db.collection('items').aggregate()
  .project({
    isOneDollar: $.eq(['$price', $.literal('$1')])
  })
  .end()

输出如下：

{ "_id": "0", "isOneDollar": true }
{ "_id": "1", "isOneDollar": false }
{ "_id": "2", "isOneDollar": false }

# 投影一个字段，对应的值为 1

下面的代码使用 literal，投影了一个新的字段 amount，其值为 1。

const $ = db.command.aggregate
db.collection('items').aggregate()
  .project({
    price: 1,
    amount: $.literal(1)
  })
  .end()

输出如下：

{ "_id": "0", "price": "$1", "amount": 1 }
{ "_id": "1", "price": "$5.60", "amount": 1 }
{ "_id": "2", "price": "$8.90", "amount": 1 }