@toreda/strong-types/src/id/options.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 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 {StrongTypeId} from '../strong/type/id';

/**
 * Configuration options used when creating a Strong Id.
 *
 * @category Strings
 */
export interface IdOptions {
	/**
	 * Max allowed Id length. Ids above max len are rejected.
	 * No max length enforced when maxLength is not set.
	 */
	maxLength?: number;
	/**
	 * Min allowed Id length. Ids below min len are rejected.
	 * Value must be >= 1. No Min length enforced when not set.
	 */
	minLength?: number;
	/**
	 * Substring or substrings required in Id to be valid. When
	 * `contains` is an array, Ids which do not contain all substrings
	 * are rejected.
	 */
	contains?: string | string[];

	typeId?: StrongTypeId;
}