bguard/lib/asserts/string/startsWith.d.ts

**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.js';
import '../../commonTypes.js';
import '../../InferType.js';
import '../../helpers/constants.js';

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

export { startsWith };