TypeScript Language Specification v1.5

More documents

Recommendations

Info

that source file is considered an external module; otherwise, the source file is considered part of the global module. Below is an example of two external modules written in separate source files. File main.ts: import log = require("./log"); log.message("hello"); File log.ts: export function message(s: string) { console.log(s); } The import declaration in the 'main' module references the 'log' module and compiling the 'main.ts' file causes the 'log.ts' file to also be compiled as part of the program. At run-time, the import declaration loads the 'log' module and produces a reference to its module instance through which it is possible to reference the exported function. TypeScript supports two patterns of JavaScript code generation for external modules: The CommonJS Modules pattern (section 11.2.5), typically used by server frameworks such as node.js, and the Asynchronous Module Definition (AMD) pattern (section 11.2.6), an extension to CommonJS Modules that permits asynchronous module loading, as is typical in browsers. The desired module code generation pattern is selected through a compiler option and does not affect the TypeScript source code. Indeed, it is possible to author external modules that can be compiled for use both on the server side (e.g. using node.js) and on the client side (using an AMD compliant loader) with no changes to the TypeScript source code. 11.2.1 External Module Names External modules are identified and referenced using external module names. The following definition is aligned with that provided in the CommonJS Modules 1.0 specification. An external module name is a string of terms delimited by forward slashes. External module names may not have file-name extensions like ".js". External module names may be relative or top-level. An external module name is relative if the first term is "." or "..". Top-level names are resolved off the conceptual module name space root. Relative names are resolved relative to the name of the module in which they occur. For purposes of resolving external module references, TypeScript associates a file path with every external module. The file path is simply the path of the module's source file without the file extension. For 146
example, an external module contained in the source file 'C:\src\lib\io.ts' has the file path 'C:/src/lib/io' and an external module contained in the source file 'C:\src\ui\editor.d.ts' has the file path 'C:/src/ui/editor'. An external module name in an import declaration is resolved as follows: If the import declaration specifies a relative external module name, the name is resolved relative to the directory of the referencing module's file path. The program must contain a module with the resulting file path or otherwise an error occurs. For example, in a module with the file path 'C:/src/ui/main', the external module names './editor' and '../lib/io' reference modules with the file paths 'C:/src/ui/editor' and 'C:/src/lib/io'. If the import declaration specifies a top-level external module name and the program contains an AmbientExternalModuleDeclaration (section 12.2) with a string literal that specifies that exact name, then the import declaration references that ambient external module. If the import declaration specifies a top-level external module name and the program contains no AmbientExternalModuleDeclaration (section 12.2) with a string literal that specifies that exact name, the name is resolved in a host dependent manner (for example by considering the name relative to a module name space root). If a matching module cannot be found an error occurs. 11.2.2 External Import Declarations External import declarations are used to import external modules and create local aliases by which they may be referenced. ExternalImportDeclaration: import Identifier = ExternalModuleReference ; ExternalModuleReference: require ( StringLiteral ) The string literal specified in an ExternalModuleReference is interpreted as an external module name (section 11.2.1). An external import declaration introduces a local identifier that references a given external module. The local identifier becomes an alias for, and is classified exactly like, the entity or entities exported from the referenced external module. Specifically, if the referenced external module contains no export assignment the identifier is classified as a module, and if the referenced external module contains an export assignment the identifier is classified exactly like the entity or entities named in the export assignment. 11.2.3 Export Declarations An external module that contains no export assignment (section 11.2.4) exports an entity classified as a module. Similarly to an internal module, export declarations (section 10.4) in the external module are used to declare the members of this entity. 147
Page 1 and 2:
TypeScript Language Specification V
Page 3 and 4:
Table of Contents 1 Introduction ..
Page 5 and 6:
4.9.1 Standard Function Expressions
Page 7 and 8:
9.1 Enum Declarations .............
Page 9 and 10:
1 Introduction JavaScript applicati
Page 11 and 12:
1.1 Ambient Declarations An ambient
Page 13 and 14:
call '$' as a function. The behavio
Page 15 and 16:
function getX(p: Point) { return p.
Page 17 and 18:
This TypeScript class declaration c
Page 19 and 20:
Section 9 describes how programmers
Page 21 and 22:
Interface definitions, like the one
Page 23 and 24:
TypeScript modules provide a mechan
Page 25 and 26:
2 Basic Concepts The remainder of t
Page 27 and 28:
Each enum declaration has a declara
Page 29:
When an identifier is resolved as a
Page 32 and 33:
which infers the type of 'x' to be
Page 34 and 35:
The only possible values for the Vo
Page 36 and 37:
interface Array { length: number; [
Page 38 and 39:
3.4 Union Types Union types represe
Page 40 and 41:
3.5 Type Parameters A type paramete
Page 42 and 43:
3.6 Named Types Classes, interfaces
Page 44 and 45:
3.7.1 Predefined Types The any, num
Page 46 and 47:
TypeMember: PropertySignature CallS
Page 48 and 49:
3.7.8 Constructor Type Literals A c
Page 50 and 51:
3.8.2 Call Signatures A call signat
Page 52 and 53:
RestParameter: ... Identifier TypeA
Page 54 and 55:
IndexSignature: [ Identifier : stri
Page 56 and 57:
Type aliases are referenced using t
Page 58 and 59:
o o If each type in U has an appare
Page 60 and 61:
o o o M is a non-specialized call o
Page 62 and 63:
3.10.5 Contextual Signature Instant
Page 64 and 65:
interface List { data: T; next: Lis
Page 66 and 67:
4.3 Identifiers When an expression
Page 68 and 69:
of the object literal includes a nu
Page 70 and 71:
A super call invokes the constructo
Page 72 and 73:
( id ) => { ... } ( id ) => expr Th
Page 74 and 75:
A dot notation property access of t
Page 76 and 77:
If func is of type Any, or of an ob
Page 78 and 79:
An example: signature are fixed, an
Page 80 and 81:
This rule means that the call to 'f
Page 82 and 83:
4.14.4 The delete Operator The 'del
Page 84 and 85:
Any Boolean Number String Other Any
Page 86 and 87:
where ??= is one of the compound as
Page 88 and 89:
4.18 The Comma Operator The comma o
Page 90 and 91:
function foo(x: number | string) {
Page 92 and 93:
function processValue(value: number
Page 95 and 96:
5 Statements This chapter describes
Page 97 and 98:
BindingProperty: Identifier Initial
Page 99 and 100:
Similarly, an array destructuring d
Page 101 and 102:
5.5 Continue Statements A 'continue
Page 103 and 104: 6 Functions TypeScript extends Java
Page 105 and 106: function f(x: number) { if (x
Page 107 and 108: When the output target is ECMAScrip
Page 109: 101
Page 112 and 113: An interface has the members specif
Page 114 and 115: interface Document { createElement(
Page 117 and 118: 8 Classes TypeScript supports class
Page 119 and 120: The following constraints must be s
Page 121 and 122: Private and protected accessibility
Page 123 and 124: interface A { x: number; f: () => v
Page 125 and 126: ConstructorOverloads: ConstructorOv
Page 127 and 128: BaseClass.apply(this, arguments); a
Page 129 and 130: Initializer expressions for instanc
Page 131 and 132: var x = A.create(); // new A() var
Page 133 and 134: MemberVariableAssignments is a sequ
Page 135 and 136: In addition, the '__extends' functi
Page 137 and 138: 9 Enums An enum type is a distinct
Page 139 and 140: An identifier or property access th
Page 141: var Color; (function (Color) { Colo
Page 144 and 145: If the declaration of 'M' above had
Page 146 and 147: module A { export interface X { s:
Page 148 and 149: module outer { var local = 1; expor
Page 150 and 151: where ModuleName is the name of the
Page 152 and 153: DeclarationElement: ExportAssignmen
Page 156 and 157: Unlike a non-instantiated internal
Page 158 and 159: import g = require("./geometry"); v
Page 160 and 161: 12.1.3 Ambient Class Declarations A
Page 162 and 163: An ExternalImportDeclaration in an
Page 164 and 165: PrimaryType: ParenthesizedType Pred
Page 166 and 167: ParameterList: RequiredParameterLis
Page 168 and 169: UnaryExpression: ( Modified ) … <
Page 170 and 171: ClassExtendsClause: extends ClassTy
Page 172 and 173: ModuleBody: ModuleElements opt Modu
Page 174 and 175: AmbientClassBodyElements: AmbientCl
show all

TypeScript Language Specification v1.5

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?