@cbnsndwch/zero-sources

pipelineBuilder() function

Home > @cbnsndwch/zero-contracts > pipelineBuilder

pipelineBuilder() function

Creates a new pipeline mapping builder.

Signature:

declare function pipelineBuilder<T>(source: string): PipelineMappingBuilder<T>;

Parameters

Parameter

Type

Description

source

string

MongoDB collection name

Returns:

PipelineMappingBuilder<T>

A new PipelineMappingBuilder instance

Example

const mapping = pipelineBuilder<IUser>('users')
    .match({ isActive: true })
    .addFields({ fullName: { $concat: ['$firstName', ' ', '$lastName'] } })
    .projection({ _id: 1, fullName: 1, email: 1 })
    .build();

How was this page?