custom-typings.d.ts

   1 /*
   2  * Custom Type Definitions
   3  * When including 3rd party modules you also need to include the type definition for the module
   4  * if they don't provide one within the module. You can try to install it with @types
   5
   6 npm install @types/node
   7 npm install @types/lodash
   8
   9  * If you can't find the type definition in the registry we can make an ambient/global definition in
  10  * this file for now. For example
  11
  12 declare module 'my-module' {
  13  export function doesSomething(value: string): string;
  14 }
  15
  16  * If you are using a CommonJS module that is using module.exports then you will have to write your
  17  * types using export = yourObjectOrFunction with a namespace above it
  18  * notice how we have to create a namespace that is equal to the function we're
  19  * assigning the export to
  20
  21 declare module 'jwt-decode' {
  22   function jwtDecode(token: string): any;
  23   namespace jwtDecode {}
  24   export = jwtDecode;
  25 }
  26
  27  *
  28  * If you're prototying and you will fix the types later you can also declare it as type any
  29  *
  30
  31 declare var assert: any;
  32 declare var _: any;
  33 declare var $: any;
  34
  35  *
  36  * If you're importing a module that uses Node.js modules which are CommonJS you need to import as
  37  * in the files such as main.browser.ts or any file within app/
  38  *
  39
  40 import * as _ from 'lodash'
  41
  42  * You can include your type definitions in this file until you create one for the @types
  43  *
  44  */
  45
  46 // support NodeJS modules without type definitions
  47 declare module '*';
  48
  49 /*
  50 // for legacy tslint etc to understand rename 'modern-lru' with your package
  51 // then comment out `declare module '*';`. For each new module copy/paste
  52 // this method of creating an `any` module type definition
  53 declare module 'modern-lru' {
  54   let x: any;
  55   export = x;
  56 }
  57 */
  58
  59 // Extra variables that live on Global that will be replaced by webpack DefinePlugin
  60 declare var ENV: string;
  61 declare var API_URL: string;
  62 declare var HMR: boolean;
  63 declare var System: SystemJS;
  64
  65 interface SystemJS {
  66   import: (path?: string) => Promise<any>;
  67 }
  68
  69 interface GlobalEnvironment {
  70   ENV: string;
  71   API_URL: string;
  72   HMR: boolean;
  73   SystemJS: SystemJS;
  74   System: SystemJS;
  75 }
  76
  77 interface Es6PromiseLoader {
  78   (id: string): (exportName?: string) => Promise<any>;
  79 }
  80
  81 type FactoryEs6PromiseLoader = () => Es6PromiseLoader;
  82 type FactoryPromise = () => Promise<any>;
  83
  84 type AsyncRoutes = {
  85   [component: string]: Es6PromiseLoader |
  86                                Function |
  87                 FactoryEs6PromiseLoader |
  88                          FactoryPromise ;
  89 };
  90
  91 type IdleCallbacks = Es6PromiseLoader |
  92                              Function |
  93               FactoryEs6PromiseLoader |
  94                        FactoryPromise ;
  95
  96 interface WebpackModule {
  97   hot: {
  98     data?: any,
  99     idle: any,
 100     accept(dependencies?: string | string[], callback?: (updatedDependencies?: any) => void): void;
 101     decline(deps?: any | string | string[]): void;
 102     dispose(callback?: (data?: any) => void): void;
 103     addDisposeHandler(callback?: (data?: any) => void): void;
 104     removeDisposeHandler(callback?: (data?: any) => void): void;
 105     check(autoApply?: any, callback?: (err?: Error, outdatedModules?: any[]) => void): void;
 106     apply(options?: any, callback?: (err?: Error, outdatedModules?: any[]) => void): void;
 107     status(callback?: (status?: string) => void): void | string;
 108     removeStatusHandler(callback?: (status?: string) => void): void;
 109   };
 110 }
 111
 112 interface WebpackRequire {
 113     (id: string): any;
 114     (paths: string[], callback: (...modules: any[]) => void): void;
 115     ensure(ids: string[], callback: (req: WebpackRequire) => void, chunkName?: string): void;
 116     context(directory: string, useSubDirectories?: boolean, regExp?: RegExp): WebpackContext;
 117 }
 118
 119 interface WebpackContext extends WebpackRequire {
 120     keys(): string[];
 121 }
 122
 123 interface ErrorStackTraceLimit {
 124   stackTraceLimit: number;
 125 }
 126
 127 // Extend typings
 128 interface NodeRequire extends WebpackRequire {}
 129 interface ErrorConstructor extends ErrorStackTraceLimit {}
 130 interface NodeRequireFunction extends Es6PromiseLoader  {}
 131 interface NodeModule extends WebpackModule {}
 132 interface Global extends GlobalEnvironment  {}