Skip to content

removed (weird ?) aside #1610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jlecordier wants to merge 1 commit into from
Closed

removed (weird ?) aside #1610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions packages/documentation/copy/en/handbook-v2/Object Types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,8 @@ function paintShape({ shape, xPos = 0, yPos = 0 }: PaintOptions) {
Here we used [a destructuring pattern](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) for `paintShape`'s parameter, and provided [default values](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Default_values) for `xPos` and `yPos`.
Now `xPos` and `yPos` are both definitely present within the body of `paintShape`, but optional for any callers to `paintShape`.

<aside>
Note that there is currently no way to place type annotations within destructuring patterns.
This is because the following syntax already means something different in JavaScript.
</aside>

```ts twoslash
// @noImplicitAny: false
Expand Down Expand Up @@ -727,15 +725,12 @@ function doSomething(stringHash: [string, number]) {
}
```

<aside>
Tuple types are useful in heavily convention-based APIs, where each element's meaning is "obvious".
This gives us flexibility in whatever we want to name our variables when we destructure them.
In the above example, we were able to name elements `0` and `1` to whatever we wanted.

However, since not every user holds the same view of what's obvious, it may be worth reconsidering whether using objects with descriptive property names may be better for your API.

</aside>

Other than those length checks, simple tuple types like these are equivalent to types which are versions of `Array`s that declare properties for specific indexes, and that declare `length` with a numeric literal type.

```ts twoslash
Expand Down