guardz
Version:
A simple and lightweight TypeScript type guard library for runtime type validation.
27 lines (26 loc) • 715 B
TypeScript
import type { TypeGuardFn } from './isType';
/**
* Checks if a value is a string.
*
* @param value - The value to check
* @param config - Optional configuration for error handling
* @returns True if the value is a string, false otherwise
*
* @example
* ```typescript
* import { isString } from 'guardz';
*
* console.log(isString("hello")); // true
* console.log(isString("")); // true
* console.log(isString(123)); // false
* console.log(isString(null)); // false
*
* // With type narrowing
* const data: unknown = getUserInput();
* if (isString(data)) {
* // data is now typed as string
* console.log(data.toUpperCase());
* }
* ```
*/
export declare const isString: TypeGuardFn<string>;