> For the complete documentation index, see [llms.txt](https://lochiwei.gitbook.io/web/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lochiwei.gitbook.io/web/appendix/typescript/type/tuples.md).

# Tuples

{% tabs %}
{% tab title="📘 手冊" %}

* TypeScript ⟩ 
  * [Tuple Types](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types)
  * [readonly Tuple Types](https://www.typescriptlang.org/docs/handbook/2/objects.html#readonly-tuple-types)
  * [Variadic Tuple Types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html#variadic-tuple-types) (✳️ TS 4.0)
  * [Labeled Tuple Elements](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html#labeled-tuple-elements) (✳️ TS 4.0)
    {% endtab %}

{% tab title="👥 相關" %}

* [⭐️ Cheat sheet](/web/appendix/typescript/cheatsheet.md)
  {% endtab %}
  {% endtabs %}

{% hint style="info" %}
A ***tuple** type* is a sort of [**Array**](/web/appendix/typescript/type/generics/array.md) type that knows exactly **how many** elements it contains, and exactly **which types** it contains **at specific positions**.
{% endhint %}

## Cheatsheet

{% tabs %}
{% tab title="tuple" %}

```typescript
//          ╭── ⭐️ tuple ──╮
type Pair = [string, number];

function f(pair: Pair) {
  const a = pair[0];          // ⭐️ access elements by index
  const b = pair[1];
}

function f(pair: Pair) {
  const [a, b] = pair;        // ⭐️ by array destructuring
}
 
f(["hello", 42]);
```

{% endtab %}

{% tab title="optional?" %}

```typescript
// ⭐️ must be last            ╭─ ⭐️ ─╮
type Point = [number, number, number? ];
 
function f(point: Point) {
  const [x, y, z] = point;          // ⭐️ z: number | undefined
  console.log(`${point.length}`);   // ⭐️ length: 2 | 3
}
```

{% endtab %}

{% tab title="...rest" %}

```typescript
// ⭐️ rest element         ╭─ ⭐️ rest ─╮
type T1 = [string, number, ...boolean[] ];

// ⭐️ TypeScript 4.0 新功能：
// TS < 4.0 => T2 會產生："A rest element must be last in a tuple type"
type T2 = [string, ...boolean[], number];     // ⭐️ needn't be last

const a: T1 = ["hello", 1];
const b: T1 = ["beautiful", 2, true];
const c: T1 = ["world", 3, true, false, true, false, true];
```

{% endtab %}

{% tab title="Second Tab" %}

{% endtab %}
{% endtabs %}

## Optional elements

{% hint style="warning" %}

* can only come **at the end**&#x20;
* **affect** the **type** of **length**
  {% endhint %}

```typescript
// ⭐️ must be last            ╭─ ⭐️ ─╮
type Point = [number, number, number? ];
 
function f(point: Point) {
  const [x, y, z] = point;          // ⭐️ z: number | undefined
  console.log(`${point.length}`);   // ⭐️ length: 2 | 3
}
```

## Rest elements

{% hint style="info" %}

* Tuples can have **rest elements**, which have to be an **array**/**tuple** type.
* A tuple with a **rest element** has **no set** “**length**” - it only has a set of well-known elements in different positions.
  {% endhint %}

{% tabs %}
{% tab title="code" %}

```typescript
// ⭐️ rest element         ╭─ ⭐️ rest ─╮
type T1 = [string, number, ...boolean[] ];

// ⭐️ TypeScript 4.0 新功能：
// TS < 4.0 => T2 會產生："A rest element must be last in a tuple type"
type T2 = [string, ...boolean[], number];     // ⭐️ needn't be last

const a: T1 = ["hello", 1];
const b: T1 = ["beautiful", 2, true];
const c: T1 = ["world", 3, true, false, true, false, true];
```

{% endtab %}

{% tab title="CodeSandbox" %}
{% embed url="<https://codesandbox.io/embed/tuple-rest-elements-yd3f3?expanddevtools=1&fontsize=14&hidenavigation=1&theme=dark>" %}

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Tuples types can be used in [rest parameters and arguments](https://www.typescriptlang.org/docs/handbook/2/functions.html#rest-parameters-and-arguments), so that the following:

```typescript
// rest param ↴
//         ╭─ ⭐️ ─╮ ╭── ⭐️ tuple with rest elem ──╮
function f(...args: [string, number, ...boolean[]]) {
  const [name, version, ...input] = args;
  // ...╰──── ⭐️ array destructuring ───╯
}
```

is basically equivalent to:

```typescript
function f(name: string, version: number, ...input: boolean[]) {
  // ...
}
```

{% endhint %}

## Variadic Tuple Types <a href="#variadic" id="variadic"></a>

```typescript
🚧 under construction ...
```

## Labeled Tuple Elements <a href="#labeled" id="labeled"></a>

```typescript
🚧 under construction ...
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lochiwei.gitbook.io/web/appendix/typescript/type/tuples.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.