guardz
Version:
A simple and lightweight TypeScript type guard library for runtime type validation.
39 lines (38 loc) • 1.11 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.isString = void 0;
const generateTypeGuardError_1 = require("./generateTypeGuardError");
/**
* 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());
* }
* ```
*/
const isString = function (value, config) {
if (typeof value !== 'string') {
if (config) {
config.callbackOnError((0, generateTypeGuardError_1.generateTypeGuardError)(value, config.identifier, 'string'));
}
return false;
}
return true;
};
exports.isString = isString;