@dolittle/sdk.projections/ProjectionId.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 { ConceptAs, createIsConceptAsGuid } from '@dolittle/concepts';
import { Guid } from '@dolittle/rudiments';

/**
 * Represents the unique identifier of a Projection.
 */
export class ProjectionId extends ConceptAs<Guid, '@dolittle/sdk.projections.ProjectionId'> {
    /**
     * Initialises a new instance of the {@link ProjectionId} class.
     * @param {Guid} id - The projection id.
     */
    constructor(id: Guid) {
        super(id, '@dolittle/sdk.projections.ProjectionId');
    }

    /**
     * Creates a {@link ProjectionId} from a {@link Guid} or a {@link string}.
     * @param {string | Guid | ProjectionId} id - The projection id.
     * @returns {ProjectionId} The created projection id concept.
     */
    static from(id: string | Guid | ProjectionId): ProjectionId {
        if (id instanceof ProjectionId) return id;
        return new ProjectionId(Guid.as(id));
    }
}

/**
 * Checks whether or not an object is an instance of {@link ProjectionId}.
 * @param {any} object - The object to check.
 * @returns {boolean} True if the object is an {@link ProjectionId}, false if not.
 */
export const isProjectionId = createIsConceptAsGuid(ProjectionId, '@dolittle/sdk.projections.ProjectionId');