@dolittle/sdk.projections/Copies/MongoDB/MongoDBCopies.ts

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

// Copyright (c) Dolittle. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

import { CollectionName } from './CollectionName';
import { PropertyConversion } from './PropertyConversion';

/**
 * Represents the specification of MongoDB read model copies to produce for a projection.
 */
export class MongoDBCopies {
    /**
     * Initialises a new instance of the {@link MongoDBCopies} class.
     * @param {boolean} shouldCopyToMongoDB - A value indicating whether or not to produce read model copies to a MongoDB collection.
     * @param {CollectionName} collectionName - The name of the collection to copy read models to.
     * @param {PropertyConversion[]} conversions - The conversions to apply when copying read models.
     */
    constructor(
        readonly shouldCopyToMongoDB: boolean,
        readonly collectionName: CollectionName,
        readonly conversions: PropertyConversion[],
    ) {}

    /**
     * Gets the default {@link MongoDBCopies} specification, where no read model copies will be produced in MongoDB.
     */
    static get default(): MongoDBCopies {
        return new MongoDBCopies(false, CollectionName.notSet, []);
    }
}