]>
Commit | Line | Data |
---|---|---|
4a6995be C |
1 | /* |
2 | * Custom Type Definitions | |
3 | * When including 3rd party modules you also need to include the type definition for the module | |
ab32b0fc | 4 | * if they don't provide one within the module. You can try to install it with @types |
4a6995be | 5 | |
ab32b0fc C |
6 | npm install @types/node |
7 | npm install @types/lodash | |
4a6995be | 8 | |
ab32b0fc | 9 | * If you can't find the type definition in the registry we can make an ambient/global definition in |
4a6995be C |
10 | * this file for now. For example |
11 | ||
ab32b0fc C |
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; | |
4a6995be C |
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; | |
ab32b0fc C |
32 | declare var _: any; |
33 | declare var $: any; | |
4a6995be C |
34 | |
35 | * | |
36 | * If you're importing a module that uses Node.js modules which are CommonJS you need to import as | |
ab32b0fc | 37 | * in the files such as main.browser.ts or any file within app/ |
4a6995be C |
38 | * |
39 | ||
40 | import * as _ from 'lodash' | |
41 | ||
ab32b0fc | 42 | * You can include your type definitions in this file until you create one for the @types |
4a6995be C |
43 | * |
44 | */ | |
45 | ||
ab32b0fc C |
46 | // support NodeJS modules without type definitions |
47 | declare module '*'; | |
4a6995be | 48 | |
c16ce1de C |
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 | ||
4a6995be C |
59 | // Extra variables that live on Global that will be replaced by webpack DefinePlugin |
60 | declare var ENV: string; | |
61 | declare var HMR: boolean; | |
ab32b0fc C |
62 | declare var System: SystemJS; |
63 | ||
64 | interface SystemJS { | |
65 | import: (path?: string) => Promise<any>; | |
66 | } | |
67 | ||
4a6995be | 68 | interface GlobalEnvironment { |
c16ce1de C |
69 | ENV: string; |
70 | HMR: boolean; | |
ab32b0fc C |
71 | SystemJS: SystemJS; |
72 | System: SystemJS; | |
4a6995be C |
73 | } |
74 | ||
ab32b0fc C |
75 | interface Es6PromiseLoader { |
76 | (id: string): (exportName?: string) => Promise<any>; | |
77 | } | |
78 | ||
79 | type FactoryEs6PromiseLoader = () => Es6PromiseLoader; | |
80 | type FactoryPromise = () => Promise<any>; | |
81 | ||
82 | type AsyncRoutes = { | |
83 | [component: string]: Es6PromiseLoader | | |
84 | Function | | |
85 | FactoryEs6PromiseLoader | | |
86 | FactoryPromise | |
87 | }; | |
88 | ||
ab32b0fc C |
89 | type IdleCallbacks = Es6PromiseLoader | |
90 | Function | | |
91 | FactoryEs6PromiseLoader | | |
92 | FactoryPromise ; | |
93 | ||
4a6995be C |
94 | interface WebpackModule { |
95 | hot: { | |
96 | data?: any, | |
97 | idle: any, | |
98 | accept(dependencies?: string | string[], callback?: (updatedDependencies?: any) => void): void; | |
ab32b0fc | 99 | decline(deps?: any | string | string[]): void; |
4a6995be C |
100 | dispose(callback?: (data?: any) => void): void; |
101 | addDisposeHandler(callback?: (data?: any) => void): void; | |
102 | removeDisposeHandler(callback?: (data?: any) => void): void; | |
103 | check(autoApply?: any, callback?: (err?: Error, outdatedModules?: any[]) => void): void; | |
104 | apply(options?: any, callback?: (err?: Error, outdatedModules?: any[]) => void): void; | |
105 | status(callback?: (status?: string) => void): void | string; | |
106 | removeStatusHandler(callback?: (status?: string) => void): void; | |
107 | }; | |
108 | } | |
109 | ||
110 | interface WebpackRequire { | |
ab32b0fc C |
111 | (id: string): any; |
112 | (paths: string[], callback: (...modules: any[]) => void): void; | |
113 | ensure(ids: string[], callback: (req: WebpackRequire) => void, chunkName?: string): void; | |
114 | context(directory: string, useSubDirectories?: boolean, regExp?: RegExp): WebpackContext; | |
4a6995be C |
115 | } |
116 | ||
ab32b0fc C |
117 | interface WebpackContext extends WebpackRequire { |
118 | keys(): string[]; | |
119 | } | |
4a6995be C |
120 | |
121 | interface ErrorStackTraceLimit { | |
122 | stackTraceLimit: number; | |
123 | } | |
124 | ||
4a6995be C |
125 | // Extend typings |
126 | interface NodeRequire extends WebpackRequire {} | |
127 | interface ErrorConstructor extends ErrorStackTraceLimit {} | |
ab32b0fc | 128 | interface NodeRequireFunction extends Es6PromiseLoader {} |
4a6995be C |
129 | interface NodeModule extends WebpackModule {} |
130 | interface Global extends GlobalEnvironment {} |