格诺姆语Name
Gnoom(发音为gnome)是一个允许您建立类型安全的MongoDB聚合的库. 它的运行时间很少,其主要重点是 在编译时抓取类型匹配 .
安装
这是国家防范机制的套件,你会明白的
使用量
简单导入 aggregate
import { aggregate } from '@gnoom/gnoom';
import { MongoClient } from 'mongodb';
interface MyInputType {
_id: ObjectId;
score: number;
}
declare const client: MongoClient;
const collection = client.db('myDb').collection('myCollection');
const documents = await aggregate<MyInputType>()
.$group({
_id: null,
totalScore: { $sum: '$score' }
})
.execute(collection);
// untyped way:
const untypedDocuments = await collection.aggregate([
{
$group: {
_id: null,
totalScore: { $sum: '$scores' }
// Oops, made a typo
}
}
]);
分管
某些综合阶段 $lookup 或者说 $facet 以总管作为论据。 在所有这些情况下,gnoom 取而代之的是召回功能.
举个例子
interface MySourceType {
_id: ObjectId;
foreignId: ObjectId;
}
interface MyTargetType {
_id: ObjectId;
status: string;
}
aggregate<MySourceType>().$lookup<MyTargetType>()({
from: 'targetCollection',
localField: 'foreignId',
foreignField: '_id',
pipeline: (p) => p.$match({ status: { $ne: 'closed' } }),
as: 'document'
});
特征
类型安全
编译器会在试图将错误的类型传递给操作员时对您吼叫.
实例:
尝试使用 $add 将字符串添加到数字中

自动完成
管道相位被完全打入,所以需要和可选输入显示为您输入. 这包括文档特定属性,例如: $match 阶段.
实例:
自动完整属性名称

基于可用属性的自动完成字段路径表达式

自动完成现有管道阶段

类型推论
在可能情况下,输入类型在管道通车时根据总相进行转换。 例如 $addFields 级将添加该类型中指定的字段,因此我们获得相同的类型安全惠益.
请注意,在某些情况下,推论不起作用(yet),在这种情况下,你可以使用几种方法手动调整类型(addToType, (中文(简体) ), removeFromType, (中文(简体) ), replaceType 财务报告和审定财务报表 modifyType) (中文(简体) ). 举个例子看看 examples/src/refine.ts