Awesome

BETA: interactivity is not in place yet...

Codebook - Typescript

Welcome to Codebook - your comprehensive guide to learning TypeScript! Learn by examples from zero to hero in typescript. This repository serves as a valuable resource for beginners and experienced developers alike, offering a curated collection of examples and explanations to help you master TypeScript.

Quick Start

Follow these steps to get started with Codebook:

1. Clone the repository to your local machine.
2. Install the project dependencies by running npm install.
3. Compile the TypeScript code by running npm run build.
4. Run the examples for each chapter by executing the corresponding npm script.

# replace number with chapter you want to see output from.
npm run chapter:1

Please note that most of the examples will output dummy text. To explore the code in more detail, it's recommended to read the scripts themselves. You can find the source code in the ./src directory and navigate through the chapters.

Ensure that you have Node.js installed on your machine, preferably version 16 or higher as specified in the engines field of the package.json. The code repository has been tested and verified to work with Node.js 16. The ECMA2020 target in the TypeScript compiler requires a minimum of Node.js version 10.

Feel free to explore the quick links provided below or dive into the source code to enhance your learning experience. Happy coding!

Note: The codebase is continuously tested and maintained, but please be aware that some sections may be under development or not covered in-depth. Your feedback and contributions are highly appreciated to make this repository more valuable for the TypeScript community.

What's Inside?

Codebook covers a wide range of TypeScript topics, starting from the basics and gradually diving into more advanced concepts. Each topic is accompanied by clear and concise examples, allowing you to learn by doing. From primitive types and type aliases to classes, modules, and advanced type systems, Codebook has got you covered.

Learning Path

This repository is designed as a crash course, guiding you from zero to hero in TypeScript. It's structured in a way that allows you to progressively build your knowledge and skills. Start with the fundamentals and work your way up, tackling more complex concepts as you go. Feel free to explore at your own pace and revisit topics whenever you need a refresher.

What is typescript?

• Javascript is a scripting language, also better known as interpreted language, meaning that the code is executed line by line at runtime rather than being compiled into a binary form before execution. The interpretation is usually done by a javascript interpretator - some common ones being Node.js, or any browser (with support for javascript, which is probably all of them).
• Typescript is a superset of Javascript, which means that any valid JavaScript code is also valid TypeScript code. But in addition, it introduces a compiler (tsc) that translates TypeScript code into JavaScript, enabling you to leverage the additional features and benefits of TypeScript while still targeting JavaScript as the execution platform.
• TS Scope - tsc considers all files included in the compiler to belong to the same global space. This applies for js files too if they are included by the config. To prevent scope polution, each file is wrapped inisde a IIFE to separate scopes.
• Technically a typical lifecycle of a javascript codebase, would be development, followed by runtime execution. There are of course other stages of the lifecycle, like transpiling, building, generating, testing, publishing, deploying and etc. For simplicity sake, in here we will sum all pre-runtime stages into 'development' and then 'runtime'.
• Given all this, its safe to say, Typescript introduces a mandatory stage - compilation - as an additional cost, but prise of greatly reducing bugs is much appreciated.

Why to typescript?

• Static analysis - the codebase becomes 'strongly typed', meaning that objects annotation is bound to interfaces and declarations, allowing you to have the 'shape' or the 'type' of each object before runtime. This improves catching bugs (via type safety) before running the application.
• Tooling - IDE with support for typescript will greatly improve your coding workflows. VSCode uses typescript under the hood and helps even with JS code bases.
• Readability - having explicit object definition (of types) helps understand what an object does and how it behaves and is not just a 'random' object with properties. Further TypeScript gives a boost to javascript by introducing language features, like interfaces, generics and other, all of which allows you to further structure one's codebase even better.
• Maintainability - refactoring is getting easier and more safe, due to type safety being triggered, you can observe dependencies, references and etc. all comming from the static analysis.
• Adoption - since TypeScript is build on top of Javascript, it can be easily be adopted. Even further, that can happen gradually.

When to typescript?

It's worth noting that TypeScript introduces additional complexity compared to writing plain JavaScript. If you're working on a small project, have tight deadlines, or require rapid prototyping, TypeScript might not provide substantial benefits, and JavaScript could be a more suitable choice.

Contribution

This codebook is an open-source project, and contributions are welcome! If you find any errors, have suggestions for improvements, or want to add more examples to enhance the learning experience, please feel free to submit a pull request. Together, we can make this an even better resource for the TypeScript community.

Note: This codebook is continuously evolving, and some topics may be missing or not covered in depth. Your feedback and contributions will help make this repository more comprehensive and valuable for everyone.

Table of Contents

• Chapter 1: Unsafety
  • Type
  • Hidden
  • Non exception
  • Typo
  • Functional
• Chapter 2: Hello World!
• Chapter 3: Primitives
• Chapter 4: Collections
  • Array Syntax
  • Array Readonly
  • Tuples
  • Sets
  • Maps
• Chapter 5: Functions
  • Syntax
  • No return type
  • Context
  • Explicit arguments
  • Call signature
  • Constructor signature
  • Overload signature
  • Rest parameters
  • Spread arguments
• Chapter 6: Objects
  • Optional property
  • Non null assertion
  • Optional chaining
  • Anonymous
  • Reference: this
  • Destructuring
  • Default values
  • Readonly modifier
  • Readonly mutation
  • Index signature
  • Excess property check
• Chapter 7: Types
  • Aliases
  • Union
  • Intersection
  • Literals
  • Unknown type
  • Inline type
  • Never
  • Function type expression
  • Erasure
  • Object type
  • Function type
  • Conditional type
  • Mapped type
  • String manipulation types
• Chapter 8: Interfaces
  • Syntax
  • Contract
  • Extending
• Chapter 9: Casting
• Chapter 10: Narrowing
  • Type guard
  • Equality
  • Contained
  • Instance
  • Assignment
  • Control flow
  • Predicate
• Chapter 11: Generics
  • Return type
  • Inference
  • Constraints
  • Generics
• Chapter 12: Reflections
  • Indexing properties
  • Type reflection
  • Return type
  • Indexing types
• Chapter 13: Class
  • Syntax
  • Fields
  • Readonly
  • Constructors
  • Overloads
  • Super call
  • Methods
  • Properties
  • Inheritance
  • Interfaces
  • Overrides
  • Member access
  • Static members
  • Abstraction
  • Polymorphism

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contributing

Contributions to this codebook are welcome! If you have any bug reports, feature requests, or would like to submit a pull request, please follow the guidelines outlined in the CONTRIBUTING file.

Roadmap

The future plans for this codebook include expanding the coverage of TypeScript topics, adding more examples, and providing interactive exercises to reinforce learning. Additionally, we aim to incorporate community feedback and address any reported issues.

Acknowledgements

Special thanks to the following individuals and projects for their contributions, inspiration, and support:

• TypeScript: The TypeScript language and community.
• Awesome TS: A curated list of awesome TypeScript resources.

Resources

Here are some additional resources to further enhance your TypeScript learning:

• TypeScript Official Documentation
• TypeScript Handbook

Support

If you encounter any issues or have any questions, please feel free to reach out by creating an issue in the GitHub repository.

Conclusion

Thank you for your interest in this codebook! We hope this collection of TypeScript examples and explanations helps you on your learning journey. We encourage you to explore the code, experiment, and provide feedback. Happy coding!