Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Typescript. Are Triple-Slash references still required when using "import from"

In old versions of Typescript it was required to add the famous

/// <reference

label to add the required references. Now after version 1.6 we can import dependencies using the recommended ES6 way

import Greeter from "./greeter";

I have been reading for a while but it is still not clear to me whether and why the triple-slash references must be completely avoided or not.

BTW. Will now the compiler know in which order it has to compile the TS files if we are using filesGlob instead of files in the tsconfig.json?

like image 755
iberbeu Avatar asked Apr 08 '16 14:04

iberbeu


2 Answers

First off, I don't believe filesGlob is officially supported yet: https://github.com/Microsoft/TypeScript/issues/1927

Now as far as the triple slash reference, it is not required as long as everything is referenced in files in tsconfig.json.

You'll find that if you use a tool like tsd or typings to manage type definitions for your external libraries, they will create a single file that you include in tsconfig.json; that single file will use triple slash references to include the rest of the files.

You can find more information about triple slash references in the TypeScript Handbook

like image 117
mejdev Avatar answered Sep 22 '22 18:09

mejdev


When using internal modules/namespaces we need the ///<reference in order to tell the compiler what depends on what in order to build a dependency graph and sort the files in the right order.

The ES6 way that you describe are (external) modules, see https://github.com/Microsoft/TypeScript/issues/2242. As such, the ordering for concatenation is not relevant as these are loaded asynchronously.

So using ES6 modules, you do not need ///<references.

As for fileGlobs, this is not implemented in TypeScript (yet), but even when it is, I think it's unlikely that it will change anything about the dependency resolution of the files in the project. Even in atom-typescript where they implement fileGlobs, they are very opinionated against code that "depends on any form of js ordering" and they don't support in any other way than manually ordering the files in tsconfig.json.

like image 32
Alex Avatar answered Sep 25 '22 18:09

Alex