microsoft / microsoft/TypeScript

Docs: Advanced Types section "Interfaces vs. Type Aliases" is contradictory

Open
#28,980 3 comments 3 reactions 1 assignee View on GitHub

@DanielRosenwasser is already working on this.

Since Dec 12, 2018.

Docs
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: N/A

Search Terms:
label: Docs "Advanced Types" "Interfaces vs Type Aliases"

I've been trying to understand the differences between interfaces and type aliases, and I've found contradictory information on the "Advanced Types" page of the docs. The "Type Aliases" section begins with "Type aliases create a new name for a type." Just a few paragraphs later though in the "Interfaces vs. Type Aliases" subsection, it says: "Type aliases don’t create a new name". (Emphasis is mine). See also this blog post, which enumerates some other aspects of this section that would benefit from clarification/update.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.