VDL Plugin SDK

isString

Import from @varavel/vdl-plugin-sdk/utils/predicates.

function isString(value): value is string;

Checks if a given value is string.

This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to string.

Parameters

ParameterTypeDescription
valueunknownThe value to check if it is string.

Returns

value is string

Returns true if value is a string, else false.

Example

const value1 = 'abc';
const value2 = 123;
const value3 = true;

console.log(isString(value1)); // true
console.log(isString(value2)); // false
console.log(isString(value3)); // false