# TypeScript

## References

* [Learn TypeScript in Y Minutes](https://learnxinyminutes.com/docs/typescript/)
* [TypeScript Deep Dive](https://www.gitbook.com/book/basarat/typescript/details)

## Tools

* [A minimal Yeoman Generator for creating NodeJS modules using TypeScript](https://github.com/ospatil/generator-node-typescript#readme)

## TypeScript Notes/Tips/Patterns

* Scope: by default members in a class are **public**
* **Enum**: an enum is a way of giving more friendly names to sets of **numeric** values
  * String enum: use custom Type. See [more here](https://basarat.gitbooks.io/typescript/content/docs/types/literal-types.html).
* Do we put return type when defining function?\
  Yes. `getSum(a: number, b: number): number {}`
* Type assertion: `(<string>someValue).length;`
* We have `static`, `readonly`
  * `const` is for variable. No one can modify it after assigned.
  * `readonly` is for property (class property to property in interface). Properties must be initialized **at their declaration or in the constructor**. It only ensures that it won't be modified by me. Others can still modify it. [See here](https://basarat.gitbooks.io/typescript/content/docs/types/readonly.html)
  * `static` must be class member.
* Function overload, this is possible in TypeScript but it's not supported by JavaScript.
* Default parameter: `getSum(data: number[], skipNegative: boolean = false)`

### Favor getter over method in TS

### Type: How to declare type to object property and key?

```typescript
var stuff: { [key: string]: string; } = {};
stuff['a'] = ''; // ok
stuff['a'] = 4;  // error
```

### Type: type of array item based on index

* `public label(row: {0: string, 1: number}): string {`
* `var t:[number, string] = [1, "message"]`

### Use Destructuring (FP concept)

```typescript
// pick only the data we need using destructing
// Function signature: getAccountInfo(): {balance: number; cardStatus: string; cardNumber: string; cardHolder: string}

// before:
.then((response:any) => {
        const data = this.getAccountInfo()
        return {
          balance: data.balance,
          cardStatus: data.cardStatus
        };

// after
.then((response:any) => {
        const {balance, cardStatus} = this.getAccountInfo()
        return {
          balance,
          cardStatus
        };
```

### Be careful: it's too easy to create private member

If the data is NOT used anywhere, don't put private.

```typescript
constructor(private data?: any) {
      this.model = this.extract(data);
    }
```


---

# Agent Instructions: 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://zurassic.gitbook.io/10x-developer/javascript/typescript.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.