feat(NonEmptyArray): Add NonEmptyArray (#66)

* feat(NonEmptyArray): Add NonEmptyArray type

* test(NonEmptyArray): Add NonEmptyArray test

* docs(NonEmptyArray): Add NonEmptyArray docs

docs/.vitepress/en.mts

@@ -38,6 +38,12 @@ export default defineConfig({
               { text: 'Uppercase', link: '/reference/built-in/Uppercase' },
             ],
           },
+          {
+            text: 'Array',
+            items: [
+              { text: 'NonEmptyArray', link: '/reference/array/NonEmptyArray' },
+            ],
+          },
           {
             text: 'Basic',
             items: [

docs/.vitepress/ko.mts

@@ -41,6 +41,15 @@ export default defineConfig({
               { text: 'Uppercase', link: '/ko/reference/built-in/Uppercase' },
             ],
           },
+          {
+            text: 'Array',
+            items: [
+              {
+                text: 'NonEmptyArray',
+                link: '/ko/reference/array/NonEmptyArray',
+              },
+            ],
+          },
           {
             text: 'Basic',
             items: [

docs/ko/reference/array/NonEmptyArray.md

@@ -0,0 +1,27 @@
+# NonEmptyArray\<T>
+
+## 개요
+
+T 타입의 요소를 적어도 하나를 포함하는 배열을 나타내요.
+
+## 문법
+
+```ts
+type NonEmptyArray<T = unknown> = [T, ...T[]];
+```
+
+- **T**: 배열에 포함된 요소의 타입이에요.
+
+## 예제
+
+```ts
+// Using NonEmptyArray with a string type:
+type stringArray = NonEmptyArray<string> = ['1', '2', '3'];
+
+// Using NonEmptyArray with a number type:
+type numberArray = NonEmptyArray<number> = [1, 2, 3];
+
+// Invalid example (empty array not allowed):
+// Error: Type '[]' is not assignable to the type 'NonEmptyArray<number>'.
+const emptyArray: NonEmptyArray<number> = [];
+```

docs/reference/array/NonEmptyArray.md

@@ -0,0 +1,27 @@
+# NonEmptyArray\<T>
+
+## Overview
+
+Represents an array that is guaranteed to contain at least one element of type T.
+
+## Syntax
+
+```ts
+type NonEmptyArray<T = unknown> = [T, ...T[]];
+```
+
+- **T**: The type of elements contained in the array.
+
+## Example
+
+```ts
+// Using NonEmptyArray with a string type:
+type stringArray = NonEmptyArray<string> = ['1', '2', '3'];
+
+// Using NonEmptyArray with a number type:
+type numberArray = NonEmptyArray<number> = [1, 2, 3];
+
+// Invalid example (empty array not allowed):
+// Error: Type '[]' is not assignable to the type 'NonEmptyArray<number>'.
+const emptyArray: NonEmptyArray<number> = [];
+```

source/array/NonEmptyArray.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @description - Represents an array that is guaranteed to contain at least one element of type T.
+ *
+ * @template T - The type of elements contained in the array.
+ *
+ * @returns - A tuple where the first element is of type T.
+ *
+ * @example
+ * // Using NonEmptyArray with a string type:
+ * type stringArray = NonEmptyArray<string> = ['1', '2', '3'];
+ *
+ * // Using NonEmptyArray with a number type:
+ * type numberArray = NonEmptyArray<number> = [1, 2, 3];
+ *
+ * // Invalid example (empty array not allowed):
+ * // Error: Type '[]' is not assignable to the type 'NonEmptyArray<number>'.
+ * const emptyArray: NonEmptyArray<number> = [];
+ *
+ */
+export type NonEmptyArray<T = unknown> = [T, ...T[]];

source/array/index.ts

@@ -0,0 +1 @@
+export type { NonEmptyArray } from './NonEmptyArray';

test-d/array/NonEmptyArray.test-d.ts

@@ -0,0 +1,11 @@
+import { NonEmptyArray } from '@/array';
+import { expectError, expectNotAssignable, expectType } from 'tsd';
+
+declare const sum: (...nums: NonEmptyArray<number>) => number;
+
+// Should correctly handle non-empty array of numbers;
+expectType<number>(sum(1, 2, 3));
+expectType<number>(sum(1));
+
+// Should not be assignable to an empty array.
+expectNotAssignable<NonEmptyArray<number>>([]);