Class StringCore

The StringCore class provides utility functions for string type checks and assertions.

Since

v1.0.2

Index

Methods

assert assertNot buildValueErr endsWith getArticle is isEmpty isLowerCase isNot isNotEmpty isNotNumeric isNumeric isUpperCase startsWith

Methods

`Static`assert

assert<T = unknown>(value: T): asserts value is IsGuard<T, string>
Asserts that a given value is a string.
Type Parameters
- T = unknown
Parameters
- value: T
  Value to check.
Returns asserts value is IsGuard<T, string>
Throws
If the value is not a string.

Since
v1.0.2
- Defined in src/lib/StringCore.mts:153

`Static`assertNot

assertNot<T = unknown>(value: unknown): asserts value is IsNotGuard<T, string>
Asserts that a given value is not a string.
Type Parameters
- T = unknown
Parameters
- value: unknown
  Value to check.
Returns asserts value is IsNotGuard<T, string>
Throws
If the value is a string.

Since
v1.0.2
- Defined in src/lib/StringCore.mts:165

`Static`buildValueErr

buildValueErr(
    value: unknown,
    typeName:
        | "String"
        | "EmptyString"
        | "LowerCaseString"
        | "UpperCaseString"
        | "NumberString",
    isNot?: boolean,
): TypeError
Builds value error.
Parameters
- value: unknown
  The invalid value.
- typeName:
      | "String"
      | "EmptyString"
      | "LowerCaseString"
      | "UpperCaseString"
      | "NumberString"
  The expected type name.
- OptionalisNot: boolean = false
  Whether the error should be for !${typeName}.
Returns TypeError
The created error.

Since
v1.1.2
- Defined in src/lib/StringCore.mts:179

`Static`endsWith

endsWith<T = unknown, S extends string = string>(
value: T,
suffix: S,
): value is IsGuard<T, `${string}${S}`>
Type guard to check if a value ends with the specified suffix.
Type Parameters
- T = unknown
- S extends string = string
  The suffix to check.
Parameters
- value: T
  The value to check.
- suffix: S
  The expected suffix.
Returns value is IsGuard<T, `${string}${S}`>
true if the value ends with the suffix; otherwise, false.
Example
```
StringCore.endsWith('hello', 'lo'); // true
StringCore.endsWith('hello', 'he'); // false
StringCore.endsWith(123, 'lo'); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:114

`Static`getArticle

getArticle(word: string): "a" | "an"
Gets the article for the given word.
Parameters
- word: string
  Word to get the article for.
Returns "a" | "an"
The article for the word.
- Defined in src/lib/StringCore.mts:192

`Static`is

is<T = unknown>(value: T): value is IsGuard<T, string>
Type guard to check if a value is a string.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsGuard<T, string>
true if the value is a string; otherwise, false.

Since
v1.0.2
- Defined in src/lib/StringCore.mts:16

`Static`isEmpty

isEmpty<T = unknown>(value: T): value is IsGuard<T, "">
Type guard to check if a value is an EmptyString.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsGuard<T, "">
true if the value is an empty string; otherwise, false.
Example
```
StringCore.isEmpty(''); // true
StringCore.isEmpty('hello'); // false
StringCore.isEmpty(123); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:40

`Static`isLowerCase

isLowerCase<T = unknown>(value: T): value is IsGuard<T, Lowercase<string>>
Type guard to check if a value is a Lowercase<string>.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsGuard<T, Lowercase<string>>
true if the value is a lowercase string; otherwise, false.
Example
```
StringCore.isLowerCase('hello'); // true
StringCore.isLowerCase('HELLO'); // false
StringCore.isLowerCase(123); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:68

`Static`isNot

isNot<T = unknown>(value: T): value is IsNotGuard<T, string>
Type guard to check if a value is not a string.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsNotGuard<T, string>
true if the value is not a string; otherwise, false.

Since
v1.0.2
- Defined in src/lib/StringCore.mts:26

`Static`isNotEmpty

isNotEmpty<T = unknown>(value: T): value is IsNotGuard<T, "">
Type guard to check if a value is a NonEmptyString<T>.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsNotGuard<T, "">
true if the value is a not empty string; otherwise, false.
Example
```
StringCore.isNotEmpty('hello'); // true
StringCore.isNotEmpty(''); // false
StringCore.isNotEmpty(123); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:54

`Static`isNotNumeric

isNotNumeric<T = unknown>(value: T): value is IsNotGuard<T, `${number}`>
Type guard to check if a value is not a NumberString.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsNotGuard<T, `${number}`>
true if the value is not a numeric string; otherwise, false.
Example
```
StringCore.isNotNumeric('abc'); // true
StringCore.isNotNumeric('123'); // false
StringCore.isNotNumeric(123); // true (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:143

`Static`isNumeric

isNumeric<T = unknown>(value: T): value is IsGuard<T, `${number}`>
Type guard to check if a value is a NumberString.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsGuard<T, `${number}`>
true if the value is a numeric string; otherwise, false.
Example
```
StringCore.isNumeric('123'); // true
StringCore.isNumeric('12.3'); // true
StringCore.isNumeric('abc'); // false
StringCore.isNumeric(123); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:129

`Static`isUpperCase

isUpperCase<T = unknown>(value: T): value is IsGuard<T, Uppercase<string>>
Type guard to check if a value is an Uppercase<string>.
Type Parameters
- T = unknown
Parameters
- value: T
  The value to check.
Returns value is IsGuard<T, Uppercase<string>>
true if the value is an uppercase string; otherwise, false.
Example
```
StringCore.isUpperCase('HELLO'); // true
StringCore.isUpperCase('hello'); // false
StringCore.isUpperCase(123); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:82

`Static`startsWith

startsWith<T = unknown, P extends string = string>(
value: T,
prefix: P,
): value is IsGuard<T, `${P}${string}`>
Type guard to check if a value starts with the specified prefix.
Type Parameters
- T = unknown
- P extends string = string
  The prefix to check.
Parameters
- value: T
  The value to check.
- prefix: P
  The expected prefix.
Returns value is IsGuard<T, `${P}${string}`>
true if the value starts with the prefix; otherwise, false.
Example
```
StringCore.startsWith('hello', 'he'); // true
StringCore.startsWith('hello', 'el'); // false
StringCore.startsWith(123, 'he'); // false (not a string)
```
Since
v1.0.2
- Defined in src/lib/StringCore.mts:98

Class StringCore

Since

Index

Methods

Methods

Staticassert

Type Parameters

Parameters

Returns asserts value is IsGuard<T, string>

Throws

Since

StaticassertNot

Type Parameters

Parameters

Returns asserts value is IsNotGuard<T, string>

Throws

Since

StaticbuildValueErr

Parameters

Returns TypeError

Since

StaticendsWith

Type Parameters

Parameters

Returns value is IsGuard<T, `${string}${S}`>

Example

Since

StaticgetArticle

Parameters

Returns "a" | "an"

Staticis

Type Parameters

Parameters

Returns value is IsGuard<T, string>

Since

StaticisEmpty

Type Parameters

Parameters

Returns value is IsGuard<T, "">

Example

Since

StaticisLowerCase

Type Parameters

Parameters

Returns value is IsGuard<T, Lowercase<string>>

Example

Since

StaticisNot

Type Parameters

Parameters

Returns value is IsNotGuard<T, string>

Since

StaticisNotEmpty

Type Parameters

Parameters

Returns value is IsNotGuard<T, "">

Example

Since

StaticisNotNumeric

Type Parameters

Parameters

Returns value is IsNotGuard<T, `${number}`>

Example

Since

StaticisNumeric

Type Parameters

Parameters

Returns value is IsGuard<T, `${number}`>

Example

Since

StaticisUpperCase

Type Parameters

Parameters

Returns value is IsGuard<T, Uppercase<string>>

Example

Since

StaticstartsWith

Type Parameters

Parameters

Returns value is IsGuard<T, `${P}${string}`>

`Static`assert

`Static`assertNot

`Static`buildValueErr

`Static`endsWith

`Static`getArticle

`Static`is

`Static`isEmpty

`Static`isLowerCase

`Static`isNot

`Static`isNotEmpty

`Static`isNotNumeric

`Static`isNumeric

`Static`isUpperCase

`Static`startsWith