@dolittle/sdk.projections
Version:
Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.
28 lines • 1.23 kB
TypeScript
import { ConceptAs } from '@dolittle/concepts';
/**
* Defines the types that can be converted into a {@link ProjectionProperty}.
*/
export declare type ProjectionPropertyLike = string | ProjectionProperty;
/**
* Represents a field of a projection read model.
*/
export declare class ProjectionProperty extends ConceptAs<string, '@dolittle/sdk.projections.Copies.ProjectionProperty'> {
/**
* Initialises a new instance of the {@link ProjectionField} class.
* @param {string} field - The projection field.
*/
constructor(field: string);
/**
* Creates a {@link ProjectionProperty} from a {@link string}.
* @param {ProjectionPropertyLike} property - The projection field.
* @returns {ProjectionProperty} The created projection field concept.
*/
static from(property: ProjectionPropertyLike): ProjectionProperty;
}
/**
* Checks whether or not an object is an instance of {@link ProjectionProperty}.
* @param {any} object - The object to check.
* @returns {boolean} True if the object is an {@link ProjectionProperty}, false if not.
*/
export declare const isProjectionProperty: (object: any) => object is ProjectionProperty;
//# sourceMappingURL=ProjectionProperty.d.ts.map