★ guardString()

guardString()

Guards the value to be string of any type.

guard-string.func.ts

const guardString = <
  Type extends AnyString,
  Payload extends object = object
>(
  value: Type,
  callback?: ResultCallback<Type, Payload>,
  payload?: Payload
): value is Type => isString(value, callback, payload);

Generic type variables

TypeextendsAnyString

A generic type variable Type constrained by AnyString indicates captured string type of the given value via the return type and the value parameter of the provided callback function ResultCallback type.

Payloadextendsobject=object

The Payload generic type variable constrained by object indicates the type of optional parameter payload of the supplied callback function and payload optional parameter of the guardString() function from which it captures its value.

Parameters

value: Type

The value of a generic type variable Type constrained by the AnyString, by default of the type captured from itself to guard.

callback?: ResultCallback<Type, Payload>

The optional callback function of ResultCallback type with parameters, the value that has been checked, the result of this check, and payload of generic type variable Payload with optional properties from the provided payload, to handle them before the result return. By default, it uses resultCallback() function.

payload?: Payload

An optional object of the generic type variable Payload is assigned to the payload of the given callback function.

Return type

value is Type

The return type is a boolean as the result of its statement indicating the value is a generic type variable Type by default of the type captured from the value.

Returns

The return value is a boolean indicating whether the value is a string type or an instance of String.

Example usage

// Example usage.
import { guardString } from '@angular-package/type';

let letFirstName = 'not my name';
guardString(letFirstName); // true; return type `value is string`

const firstName = 'my name';
guardString(firstName); // true; return type `value is "my name"`