Skip to content

Item 72: Prefer ECMAScript Features to TypeScript Features

要点

  • By and large, you can convert TypeScript to JavaScript by removing all the types from your code.
  • Enums, parameter properties, triple-slash imports, experimental decorators, and member visibility modifiers are historical exceptions to this rule.
  • To keep TypeScript’s role in your codebase as clear as possible and to avoid future compatibility issues, avoid nonstandard features.

正文

ts
enum Flavor {
  Vanilla = 0,
  Chocolate = 1,
  Strawberry = 2,
}

let flavor = Flavor.Chocolate
//  ^? let flavor: Flavor

Flavor // Autocomplete shows: Vanilla, Chocolate, Strawberry
Flavor[0] // Value is "Vanilla"

💻 playground


ts
enum Flavor {
  Vanilla = 'vanilla',
  Chocolate = 'chocolate',
  Strawberry = 'strawberry',
}

let favoriteFlavor = Flavor.Chocolate // Type is Flavor
favoriteFlavor = 'strawberry'
// ~~~~~~~~~~~ Type '"strawberry"' is not assignable to type 'Flavor'

💻 playground


ts
function scoop(flavor: Flavor) {
  /* ... */
}

💻 playground


ts
scoop('vanilla')
//    ~~~~~~~~~ '"vanilla"' is not assignable to parameter of type 'Flavor'

import { Flavor } from 'ice-cream'
scoop(Flavor.Vanilla) // OK

💻 playground


ts
type Flavor = 'vanilla' | 'chocolate' | 'strawberry'

let favoriteFlavor: Flavor = 'chocolate' // OK
favoriteFlavor = 'americone dream'
// ~~~~~~~~~~~ Type '"americone dream"' is not assignable to type 'Flavor'

💻 playground


ts
class Person {
  name: string
  constructor(name: string) {
    this.name = name
  }
}

💻 playground


ts
class Person {
  constructor(public name: string) {}
}

💻 playground


ts
class Person {
  first: string
  last: string
  constructor(public name: string) {
    ;[this.first, this.last] = name.split(' ')
  }
}

💻 playground


ts
class PersonClass {
  constructor(public name: string) {}
}
const p: PersonClass = { name: 'Jed Bartlet' } // OK

interface Person {
  name: string
}
const jed: Person = new PersonClass('Jed Bartlet') // also OK

💻 playground


ts
// other.ts
namespace foo {
  export function bar() {}
}

💻 playground


ts
// index.ts
/// <reference path="other.ts"/>
foo.bar()

💻 playground


ts
class Greeter {
  greeting: string
  constructor(message: string) {
    this.greeting = message
  }
  @logged // <-- this is the decorator
  greet() {
    return `Hello, ${this.greeting}`
  }
}

function logged(originalFn: any, context: ClassMethodDecoratorContext) {
  return function (this: any, ...args: any[]) {
    console.log(`Calling ${String(context.name)}`)
    return originalFn.call(this, ...args)
  }
}

console.log(new Greeter('Dave').greet())
// Logs:
// Calling greet
// Hello, Dave

💻 playground


ts
class Diary {
  private secret = 'cheated on my English test'
}

const diary = new Diary()
diary.secret
//    ~~~~~~ Property 'secret' is private and only accessible within ... 'Diary'

💻 playground


ts
const diary = new Diary()
;(diary as any).secret // OK

console.log(Object.entries(diary))
// logs [["secret", "cheated on my English test"]]

💻 playground


ts
class PasswordChecker {
  #passwordHash: number

  constructor(passwordHash: number) {
    this.#passwordHash = passwordHash
  }

  checkPassword(password: string) {
    return hash(password) === this.#passwordHash
  }
}

const checker = new PasswordChecker(hash('s3cret'))
checker.#passwordHash
//      ~~~~~~~~~~~~~ Property '#passwordHash' is not accessible outside class
//                    'PasswordChecker' because it has a private identifier.
checker.checkPassword('secret') // Returns false
checker.checkPassword('s3cret') // Returns true

💻 playground

Released under the MIT License.