1. // Type definitions for [~THE LIBRARY NAME~] [~OPTIONAL VERSION NUMBER~]
    2. // Project: [~THE PROJECT NAME~]
    3. // Definitions by: [~YOUR NAME~] <[~A URL FOR YOU~]>
    5. /*~ This is the module template file for function modules.
    6.  *~ You should rename it to index.d.ts and place it in a folder with the same name as the module.
    7.  *~ For example, if you were writing a file for "super-greeter", this
    8.  *~ file should be 'super-greeter/index.d.ts'
    9.  */
    11. // Note that ES6 modules cannot directly export class objects.
    12. // This file should be imported using the CommonJS-style:
    13. //   import x = require('[~THE MODULE~]');
    14. //
    15. // Alternatively, if --allowSyntheticDefaultImports or
    16. // --esModuleInterop is turned on, this file can also be
    17. // imported as a default import:
    18. //   import x from '[~THE MODULE~]';
    19. //
    20. // Refer to the TypeScript documentation at
    21. // https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require
    22. // to understand common workarounds for this limitation of ES6 modules.
    24. /*~ If this module is a UMD module that exposes a global variable 'myFuncLib' when
    25.  *~ loaded outside a module loader environment, declare that global here.
    26.  *~ Otherwise, delete this declaration.
    27.  */
    28. export as namespace myFuncLib;
    30. /*~ This declaration specifies that the function
    31.  *~ is the exported object from the file
    32.  */
    33. export = MyFunction;
    35. /*~ This example shows how to have multiple overloads for your function */
    36. declare function MyFunction(name: string): MyFunction.NamedReturnType;
    37. declare function MyFunction(length: number): MyFunction.LengthReturnType;
    39. /*~ If you want to expose types from your module as well, you can
    40.  *~ place them in this block. Often you will want to describe the
    41.  *~ shape of the return type of the function; that type should
    42.  *~ be declared in here, as this example shows.
    43.  *~
    44.  *~ Note that if you decide to include this namespace, the module can be
    45.  *~ incorrectly imported as a namespace object, unless
    46.  *~ --esModuleInterop is turned on:
    47.  *~   import * as x from '[~THE MODULE~]'; // WRONG! DO NOT DO THIS!
    48.  */
    49. declare namespace MyFunction {
    50.     export interface LengthReturnType {
    51.         width: number;
    52.         height: number;
    53.     }
    54.     export interface NamedReturnType {
    55.         firstName: string;
    56.         lastName: string;
    57.     }
    59.     /*~ If the module also has properties, declare them here. For example,
    60.      *~ this declaration says that this code is legal:
    61.      *~   import f = require('myFuncLibrary');
    62.      *~   console.log(f.defaultName);
    63.      */
    64.     export const defaultName: string;
    65.     export let defaultLength: number;
    66. }