Improve TypeScript type for isNonEmptyString() and `isNonEmptyStrin…

…gAndNotWhitespace()` (#200)
sindresorhus · Oct 26, 2023 · 0d4cf6f · 0d4cf6f
1 parent f10e2ca
commit 0d4cf6f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/source/index.ts b/source/index.ts
@@ -4,6 +4,7 @@ import type {
 	Class,
 	Falsy,
 	NodeStream,
+	NonEmptyString,
 	ObservableLike,
 	Predicate,
 	Primitive,
@@ -582,12 +583,12 @@ export function isNonEmptySet<T = unknown>(value: unknown): value is Set<T> {
 }
 
 // TODO: Use `not ''` when the `not` operator is available.
-export function isNonEmptyString(value: unknown): value is string {
+export function isNonEmptyString(value: unknown): value is NonEmptyString {
 	return isString(value) && value.length > 0;
 }
 
 // TODO: Use `not ''` when the `not` operator is available.
-export function isNonEmptyStringAndNotWhitespace(value: unknown): value is string {
+export function isNonEmptyStringAndNotWhitespace(value: unknown): value is NonEmptyString {
 	return isString(value) && !isEmptyStringOrWhitespace(value);
 }
 

diff --git a/source/types.ts b/source/types.ts
@@ -73,3 +73,5 @@ export type NodeStream = {
 } & NodeJS.EventEmitter;
 
 export type Predicate = (value: unknown) => boolean;
+
+export type NonEmptyString = string & {0: string};
Original file line number	Diff line number	Diff line change
Expand Up		@@ -73,3 +73,5 @@ export type NodeStream = {
		} & NodeJS.EventEmitter;

		export type Predicate = (value: unknown) => boolean;

		export type NonEmptyString = string & {0: string};