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. You should rename it to index.d.ts
    6.  *~ 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. /*~ If this module is a UMD module that exposes a global variable 'myLib' when
    12.  *~ loaded outside a module loader environment, declare that global here.
    13.  *~ Otherwise, delete this declaration.
    14.  */
    15. export as namespace myLib;
    17. /*~ If this module has methods, declare them as functions like so.
    18.  */
    19. export function myMethod(a: string): string;
    20. export function myOtherMethod(a: number): number;
    22. /*~ You can declare types that are available via importing the module */
    23. export interface someType {
    24.     name: string;
    25.     length: number;
    26.     extras?: string[];
    27. }
    29. /*~ You can declare properties of the module using const, let, or var */
    30. export const myField: number;
    32. /*~ If there are types, properties, or methods inside dotted names
    33.  *~ of the module, declare them inside a 'namespace'.
    34.  */
    35. export namespace subProp {
    36.     /*~ For example, given this definition, someone could write:
    37.      *~   import { subProp } from 'yourModule';
    38.      *~   subProp.foo();
    39.      *~ or
    40.      *~   import * as yourMod from 'yourModule';
    41.      *~   yourMod.subProp.foo();
    42.      */
    43.     export function foo(): void;
    44. }