guardStringIncludes()

guardStringIncludes()

Guards the value to be a string type or an instance of String that includes the specified words/sentences.

guard-string-includes.func.ts

const guardStringIncludes = <
  Type extends AnyString,
  Payload extends object = object
>(
  value: Type,
  includes: string[],
  callback: ResultCallback<
    Type,
    { includes: typeof includes } & Payload
  > = resultCallback,
  payload?: Payload
): value is Type => isStringIncludes(value, includes, callback, payload);

https://github.com/angular-package/type/blob/main/src/guard/lib/guard-string-includes.func.ts

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 guardStringIncludes() 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 check against the string that contains words/sentences from a given includes.

includes: string[]

An Array of string as words/sentences to be case-sensitive searched for within the given value.

callback?: ResultCallback<Type, { includes: typeof includes } & 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.

The payload parameter of given callback function consists of the includes property of the given includes, and it can't be overwritten by the given payload parameter of the main 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 provided value is a string type or an instance of String that includes the specified words/sentences.

Example usage

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

// true; The return type `value is "This is a person without age."`
guardStringIncludes('This is a person without age.', ['age']);
// false; The return type `value is "This is a person without age."`
guardStringIncludes('This is a person without age.', ['Person']);
// false; The return type `value is "This is a person without age."`
guardStringIncludes('This is a person without age.', ['age', 'Person']);
guardStringIncludes(new String('This is artificial intelligence.'), [
  'artificial',
  'intelligence',
]); // true; The return type `value is String`