ts-extras/distribution/is-empty.d.ts

Essential utilities for TypeScript projects

/**
Check whether an array is empty.

This is useful because doing `array.length === 0` on its own won't work as a type-guard.

@example
```
import {isEmpty} from 'ts-extras';

isEmpty([1, 2, 3]);
//=> false

isEmpty([]);
//=> true

// Works with tuples
const tuple: [string, number] | [] = Math.random() > 0.5 ? ['hello', 42] : [];
if (isEmpty(tuple)) {
    // tuple is now typed as []
} else {
    // tuple is now typed as [string, number]
}
```

@category Type guard
*/
export declare function isEmpty<T extends readonly unknown[]>(array: T): array is T extends readonly never[] ? T : never;