h4k1m0u · November 26, 2022 14:51
diff --git a/readme.md b/readme.md
diff --git a/index.html b/index.html
 <!-- file: templates/index.html -->
 <!doctype html>
 <html lang="en">
 <head>
  <meta charset="utf-8">
  <title>TS Example</title>
 </head>

 <body>
  <main id="content">
  </main>
 </body>
 </html>
diff --git a/module.ts b/module.ts
 // file: src/module.ts
 export function sum(a: number, b: number) {
    return a + b;
 }
diff --git a/package.json b/package.json
 {
  "name": "ts-example",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "webpack serve"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "html-webpack-plugin": "^5.5.0",
    "ts-loader": "^9.3.1",
    "webpack": "^5.74.0",
    "webpack-cli": "^4.10.0",
    "webpack-dev-server": "^4.9.3"
  }
 }
diff --git a/TS-example.ts b/TS-example.ts
 // file: src/main.ts
 import { sum } from './module';

 //////////////////////////////////////////////////////
 // Interface with an optional field
 //////////////////////////////////////////////////////

 interface Person {
  name: string;
  age: number;
  nickname?: string; // optional attribute
 }

 function greet(person: Person) {
  console.log(`Hi ${person.name}, you're ${person.age} old`);
 }

 const hakim: Person = {
  name: 'Hakim',
  age: 33,
 };
 greet(hakim);

 //////////////////////////////////////////////////////
 // Implementing an interface (like in java)
 //////////////////////////////////////////////////////

 interface ClockInterface {
  currentTime: Date;
  setTime(date: Date): void;
 }

 class Clock implements ClockInterface {
  currentTime = new Date();

  setTime(date: Date) {
    this.currentTime = date;
  }
 }

 const clock = new Clock();
 const date = new Date(1989, 11, 16);
 clock.setTime(date);
 console.log(`Date: ${clock.currentTime}`);

 //////////////////////////////////////////////////////
 // Generics (i.e. cpp's templates)
 //////////////////////////////////////////////////////

 interface Box<Type> {
  content: Type;
 }

 function printContentType<Type>(box: Box<Type>) {
  console.log('Type of content: ' + typeof box.content);
 }

 printContentType({ content: 'hello' });
 printContentType({ content: 0 });
 printContentType({ content: true });

 // type alias
 type BoxString = Box<string>;

 //////////////////////////////////////////////////////
 // Type assertions & non-null assetion operator (!) & any type
 //////////////////////////////////////////////////////

 // Assert that e is non-null and access name
 const total = sum(2, 3);
 const content1 = document.getElementById('content');
 content1!.textContent = `total: ${total}`;

 // or use type assertions
 const content2 = document.getElementById('content') as HTMLElement;
 content2.textContent = `total: ${total}`;

 // or with `any` type, you can access any of its props
 const content3: any = document.getElementById('content');
 content3.textContent = `total: ${total}`;

 //////////////////////////////////////////////////////
 // Member visibility (private fields)
 //////////////////////////////////////////////////////

 class MyClass {
  private field = 0;
 }

 const instance = new MyClass();
 // console.log(`Class field: ${instance.field}`);
diff --git a/tsconfig.json b/tsconfig.json
 {
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig to read more about this file */

    /* Projects */
    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

    /* Modules */
    // "module": "commonjs",                                /* Specify what module code is generated. */
    "module": "es6",                                /* Specify what module code is generated. */
    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
    // "resolveJsonModule": true,                        /* Enable importing .json files. */
    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

    /* Emit */
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
    // "removeComments": true,                           /* Disable emitting comments. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */

    /* Type Checking */
    "strict": true,                                      /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

    /* Completeness */
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
 }
diff --git a/webpack.config.js b/webpack.config.js
 const HtmlWebpackPlugin = require('html-webpack-plugin');

 // copied from: https://github.com/TypeStrong/ts-loader#configuration
 module.exports = {
  mode: "development",
  entry: "./src/main.ts",
  output: {
    filename: "bundle.js"
  },
  resolve: {
    // Add `.ts` and `.tsx` as a resolvable extension.
    extensions: [".ts", ".tsx", ".js"]
  },
  module: {
    rules: [
      // all files with a `.ts` or `.tsx` extension will be handled by `ts-loader`
      { test: /\.tsx?$/, loader: "ts-loader" }
    ]
  },
  devServer: {
    open: true, // open browser automatically
  },
  // generate index.html including output js file
  plugins: [new HtmlWebpackPlugin({
    template: 'templates/index.html'
  })],
 };
	<!-- file: templates/index.html -->
	<!doctype html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>TS Example</title>
	</head>

	<body>
	<main id="content">
	</main>
	</body>
	</html>
	// file: src/module.ts
	export function sum(a: number, b: number) {
	return a + b;
	}
	{
	"name": "ts-example",
	"version": "1.0.0",
	"description": "",
	"main": "index.js",
	"scripts": {
	"start": "webpack serve"
	},
	"keywords": [],
	"author": "",
	"license": "ISC",
	"devDependencies": {
	"html-webpack-plugin": "^5.5.0",
	"ts-loader": "^9.3.1",
	"webpack": "^5.74.0",
	"webpack-cli": "^4.10.0",
	"webpack-dev-server": "^4.9.3"
	}
	}
	// file: src/main.ts
	import { sum } from './module';

	//////////////////////////////////////////////////////
	// Interface with an optional field
	//////////////////////////////////////////////////////

	interface Person {
	name: string;
	age: number;
	nickname?: string; // optional attribute
	}

	function greet(person: Person) {
	console.log(`Hi ${person.name}, you're ${person.age} old`);
	}

	const hakim: Person = {
	name: 'Hakim',
	age: 33,
	};
	greet(hakim);

	//////////////////////////////////////////////////////
	// Implementing an interface (like in java)
	//////////////////////////////////////////////////////

	interface ClockInterface {
	currentTime: Date;
	setTime(date: Date): void;
	}

	class Clock implements ClockInterface {
	currentTime = new Date();

	setTime(date: Date) {
	this.currentTime = date;
	}
	}

	const clock = new Clock();
	const date = new Date(1989, 11, 16);
	clock.setTime(date);
	console.log(`Date: ${clock.currentTime}`);

	//////////////////////////////////////////////////////
	// Generics (i.e. cpp's templates)
	//////////////////////////////////////////////////////

	interface Box<Type> {
	content: Type;
	}

	function printContentType<Type>(box: Box<Type>) {
	console.log('Type of content: ' + typeof box.content);
	}

	printContentType({ content: 'hello' });
	printContentType({ content: 0 });
	printContentType({ content: true });

	// type alias
	type BoxString = Box<string>;

	//////////////////////////////////////////////////////
	// Type assertions & non-null assetion operator (!) & any type
	//////////////////////////////////////////////////////

	// Assert that e is non-null and access name
	const total = sum(2, 3);
	const content1 = document.getElementById('content');
	content1!.textContent = `total: ${total}`;

	// or use type assertions
	const content2 = document.getElementById('content') as HTMLElement;
	content2.textContent = `total: ${total}`;

	// or with `any` type, you can access any of its props
	const content3: any = document.getElementById('content');
	content3.textContent = `total: ${total}`;

	//////////////////////////////////////////////////////
	// Member visibility (private fields)
	//////////////////////////////////////////////////////

	class MyClass {
	private field = 0;
	}

	const instance = new MyClass();
	// console.log(`Class field: ${instance.field}`);
	{
	"compilerOptions": {
	/* Visit https://aka.ms/tsconfig to read more about this file */

	/* Projects */
	// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
	// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
	// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
	// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
	// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
	// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

	/* Language and Environment */
	"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
	// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
	// "jsx": "preserve", /* Specify what JSX code is generated. */
	// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
	// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
	// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
	// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
	// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx'. /
	// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
	// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
	// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
	// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

	/* Modules */
	// "module": "commonjs", /* Specify what module code is generated. */
	"module": "es6", /* Specify what module code is generated. */
	// "rootDir": "./", /* Specify the root folder within your source files. */
	// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
	// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
	// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
	// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
	// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
	// "types": [], /* Specify type package names to be included without being referenced in a source file. */
	// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
	// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
	// "resolveJsonModule": true, /* Enable importing .json files. */
	// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

	/* JavaScript Support */
	// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
	// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
	// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

	/* Emit */
	// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
	// "declarationMap": true, /* Create sourcemaps for d.ts files. */
	// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
	// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
	// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
	"outDir": "./dist", /* Specify an output folder for all emitted files. */
	// "removeComments": true, /* Disable emitting comments. */
	// "noEmit": true, /* Disable emitting files from a compilation. */
	// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
	// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
	// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
	// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
	// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
	// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
	// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
	// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
	// "newLine": "crlf", /* Set the newline character for emitting files. */
	// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
	// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
	// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
	// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
	// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
	// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

	/* Interop Constraints */
	// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
	// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
	"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
	// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
	"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

	/* Type Checking */
	"strict": true, /* Enable all strict type-checking options. */
	// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
	// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
	// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
	// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
	// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
	// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
	// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
	// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
	// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
	// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
	// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
	// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
	// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
	// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
	// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
	// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
	// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
	// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

	/* Completeness */
	// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
	"skipLibCheck": true /* Skip type checking all .d.ts files. */
	}
	}
	const HtmlWebpackPlugin = require('html-webpack-plugin');

	// copied from: https://github.com/TypeStrong/ts-loader#configuration
	module.exports = {
	mode: "development",
	entry: "./src/main.ts",
	output: {
	filename: "bundle.js"
	},
	resolve: {
	// Add `.ts` and `.tsx` as a resolvable extension.
	extensions: [".ts", ".tsx", ".js"]
	},
	module: {
	rules: [
	// all files with a `.ts` or `.tsx` extension will be handled by `ts-loader`
	{ test: /\.tsx?$/, loader: "ts-loader" }
	]
	},
	devServer: {
	open: true, // open browser automatically
	},
	// generate index.html including output js file
	plugins: [new HtmlWebpackPlugin({
	template: 'templates/index.html'
	})],
	};