bguard/lib/asserts/string/contains.d.mts

**bguard** is a powerful, flexible, and type-safe validation library for TypeScript. It allows developers to define validation schemas for their data structures and ensures that data conforms to the expected types and constraints.

import { RequiredValidation } from '../../core.mjs';
import '../../commonTypes.mjs';
import '../../InferType.mjs';
import '../../helpers/constants.mjs';

/**
 * @description Asserts that a string value contains a specified substring.
 * @param {string} substring The substring that must be present in the string value.
 * @returns {RequiredValidation} A validation function that takes a received string and an exception context.
 * @throws {ValidationError} if the received value does not contain the required substring.
 * @example
 * const schema = string().custom(contains('foo'));
 * parseOrFail(schema, 'foobar'); // Valid
 * parseOrFail(schema, 'bar'); // Throws an error: 'The received value does not contain the required substring'
 *
 * @translation Error Translation Key = 's:contains'
 */
declare const contains: {
    (substring: string): RequiredValidation;
    key: string;
    message: string;
};

export { contains };