iridium/lib/Transforms.ts

A custom lightweight ORM for MongoDB designed for power-users

export interface Transforms {
	[property:string]: PropertyTransform;
}

/**
 * Converts the value of a property to and from its database representation.
 */
export interface PropertyTransform {
	/**
	 * Converts a property's value from its database representation into one
	 * suitable for the application.
	 * @param value The value stored in the MongoDB database document.
	 * @returns A derived value which is more useful to the application.
	 */
	fromDB(value: any): any;

	/**
	 * Converts a property's value into a representation more suitable for
	 * the database.
	 * @param value The value used by the application.
	 * @returns The database optimized representation of the value.
	 */
	toDB(value: any): any;
}