Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Merge pull request #18337 from DavidPeicho/doc/typescript-config

Docs: Add TypeScript setup guide.
Mr.doob 5 years ago
parent
258714e24e 5a684e05a9
commit
a8e93ecf28
3 changed files with 94 additions and 0 deletions
Split View Show Diff Stats
  1. 2 0
      docs/list.js
  2. 46 0
      docs/manual/en/introduction/Typescript-setup.html
  3. 46 0
      docs/manual/zh/introduction/Typescript-setup.html

+ 2 - 0
docs/list.js
View File 

@@ -10,6 +10,7 @@ var list = {
 
 				"Browser support": "manual/en/introduction/Browser-support",
 
 				"WebGL compatibility check": "manual/en/introduction/WebGL-compatibility-check",
 
 				"How to run things locally": "manual/en/introduction/How-to-run-things-locally",
 
+				"Typescript setup": "manual/en/introduction/Typescript-setup",
 
 				"How to use WebGL 2": "manual/en/introduction/How-to-use-WebGL2",
 
 				"Drawing lines": "manual/en/introduction/Drawing-lines",
 
 				"Creating text": "manual/en/introduction/Creating-text",
 
@@ -459,6 +460,7 @@ var list = {
 
 				"浏览器支持": "manual/zh/introduction/Browser-support",
 
 				"WebGL兼容性检查": "manual/zh/introduction/WebGL-compatibility-check",
 
 				"如何在本地运行Three.js": "manual/zh/introduction/How-to-run-things-locally",
 
+				"Typescript setup": "manual/zh/introduction/Typescript-setup",
 
 				"如何使用WebGL 2": "manual/zh/introduction/How-to-use-WebGL2",
 
 				"画线": "manual/zh/introduction/Drawing-lines",
 
 				"创建文字": "manual/zh/introduction/Creating-text",

+ 46 - 0
docs/manual/en/introduction/Typescript-setup.html
View File 

@@ -0,0 +1,46 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8">
 
+		<base href="../../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		<h1>[name]</h1>
 
+
 
+		<p>
 
+			three.js is a JavaScript-based library. However, it's possible to use it in a TypeScript project, as the library
 
+			exposes [link:https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html Declaration Files] (*d.ts* files).
 
+		</p>
 
+
 
+		<p>
 
+			A minimal configuration is required for the TypeScript compiler to
 
+			discover three.js types.<br>
 
+			You will need to set the [link:https://www.typescriptlang.org/docs/handbook/module-resolution.html moduleResolution]
 
+			option to *node*, and the [link:https://www.typescriptlang.org/docs/handbook/compiler-options.html target] option to *es6* or newer.
 
+		</p>
 
+
 
+		<code>
 
+		// Example of minimal `tsconfig.json` file
 
+		{
 
+			"compilerOptions": {
 
+				"target": "es6",
 
+				"moduleResolution": "node",
 
+			},
 
+			"include": [ "./src/**/*.ts" ],
 
+		}
 
+		</code>
 
+
 
+		<p>
 
+			Note: As of today, it's not yet possible to use three.js typings without using those two options.
 
+		</p>
 
+
 
+		<p>
 
+			Note: It happens that some declarations are incorrect and/or missing.
 
+			Contributing to Declaration Files is really helpful for the community, making three.js
 
+			typings better and more accurate.
 
+		</p>
 
+	</body>
 
+</html>

+ 46 - 0
docs/manual/zh/introduction/Typescript-setup.html
View File 

@@ -0,0 +1,46 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8">
 
+		<base href="../../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		<h1>[name]</h1>
 
+
 
+		<p>
 
+			three.js is a JavaScript-based library. However, it's possible to use it in a TypeScript project, as the library
 
+			exposes [link:https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html Declaration Files] (*d.ts* files).
 
+		</p>
 
+
 
+		<p>
 
+			A minimal configuration is required for the TypeScript compiler to
 
+			discover three.js types.<br>
 
+			You will need to set the [link:https://www.typescriptlang.org/docs/handbook/module-resolution.html moduleResolution]
 
+			option to *node*, and the [link:https://www.typescriptlang.org/docs/handbook/compiler-options.html target] option to *es6* or newer.
 
+		</p>
 
+
 
+		<code>
 
+		// Example of minimal `tsconfig.json` file
 
+		{
 
+			"compilerOptions": {
 
+				"target": "es6",
 
+				"moduleResolution": "node",
 
+			},
 
+			"include": [ "./src/**/*.ts" ],
 
+		}
 
+		</code>
 
+
 
+		<p>
 
+			Note: As of today, it's not yet possible to use three.js typings without using those two options.
 
+		</p>
 
+
 
+		<p>
 
+			Note: It happens that some declarations are incorrect and/or missing.
 
+			Contributing to Declaration Files is really helpful for the community, making three.js
 
+			typings better and more accurate.
 
+		</p>
 
+	</body>
 
+</html>