@toreda/strong-types/src/email/make.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2010 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */

import {Email} from '../email';
import {Rules} from '../rules';
import {createType} from '../create/type';
import {initialValue} from '../initial/value';

/**
 * Create Strong Email object with fallback and optional initial value.
 * @param fallback	Value returned when none is set.
 * @param initial	Starting value.
 * @returns			New strong Email object.
 *
 * @category Email
 */
export function emailMake(fallback: string, value?: string | null): Email {
	const rules = new Rules();
	rules.add().must.match.type.string();
	rules.add().must.be.email();

	return createType<string>(fallback, initialValue(value), rules, 'Email');
}