]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - client/src/custom-typings.d.ts
Fix prod build
[github/Chocobozzz/PeerTube.git] / client / src / custom-typings.d.ts
CommitLineData
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
6npm install @types/node
7npm 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
12declare 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
21declare 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
31declare var assert: any;
ab32b0fc
C
32declare var _: any;
33declare 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
40import * 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
47declare 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
53declare 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
60declare var ENV: string;
1840c2f7 61declare var API_URL: string;
4a6995be 62declare var HMR: boolean;
ab32b0fc
C
63declare var System: SystemJS;
64
65interface SystemJS {
66 import: (path?: string) => Promise<any>;
67}
68
4a6995be 69interface GlobalEnvironment {
c16ce1de 70 ENV: string;
1840c2f7 71 API_URL: string;
c16ce1de 72 HMR: boolean;
ab32b0fc
C
73 SystemJS: SystemJS;
74 System: SystemJS;
4a6995be
C
75}
76
ab32b0fc
C
77interface Es6PromiseLoader {
78 (id: string): (exportName?: string) => Promise<any>;
79}
80
81type FactoryEs6PromiseLoader = () => Es6PromiseLoader;
82type FactoryPromise = () => Promise<any>;
83
84type AsyncRoutes = {
85 [component: string]: Es6PromiseLoader |
86 Function |
87 FactoryEs6PromiseLoader |
8635a2c7 88 FactoryPromise ;
ab32b0fc
C
89};
90
ab32b0fc
C
91type IdleCallbacks = Es6PromiseLoader |
92 Function |
93 FactoryEs6PromiseLoader |
94 FactoryPromise ;
95
4a6995be
C
96interface WebpackModule {
97 hot: {
98 data?: any,
99 idle: any,
100 accept(dependencies?: string | string[], callback?: (updatedDependencies?: any) => void): void;
ab32b0fc 101 decline(deps?: any | string | string[]): void;
4a6995be
C
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
112interface WebpackRequire {
ab32b0fc
C
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;
4a6995be
C
117}
118
ab32b0fc
C
119interface WebpackContext extends WebpackRequire {
120 keys(): string[];
121}
4a6995be
C
122
123interface ErrorStackTraceLimit {
124 stackTraceLimit: number;
125}
126
4a6995be
C
127// Extend typings
128interface NodeRequire extends WebpackRequire {}
129interface ErrorConstructor extends ErrorStackTraceLimit {}
ab32b0fc 130interface NodeRequireFunction extends Es6PromiseLoader {}
4a6995be
C
131interface NodeModule extends WebpackModule {}
132interface Global extends GlobalEnvironment {}