automatyczne generowanie deklaracji modułu otoczenia

Question

Biorąc pod uwagę te pliki 2 maszynopis

api/Token.ts

interface Token { 
    code: string 
} 
export default Token 

i index.ts

export * from './api/Token' 

TSC 1.5 z przełącznikiem --declarations wygeneruje dwa .d.ts plików (o podobnej treści)

api/Token.d.ts

interface Token { 
    code: string; 
} 
export default Token; 

i index.d.ts

export * from './api/Token'; 

Running grunt-DTS-pakiet z następującymi opcjami

dts_bundle: { 
     release: { 
      options: { 
       name: 'my-module', 
       main: 'index.d.ts' 
      } 
     } 
    } 

wygeneruje deklaracji plik modułu otoczenia my-module.d.ts o następującej treści

declare module 'my-module' { 
    export * from './api/Token'; 
} 

Jednak ta deklaracja nie skompilować ze względu na: Import or export declaration in an ambient module declaration cannot reference module through relative module name.

Jak ja automatycznie generowania deklaracji modułu otoczenia dla dwojga pliki maszynopisu powyżej?

EDIT

Proszę śledzić najnowsze informacje dotyczące https://github.com/Microsoft/TypeScript/issues/2262

Answer 1

I niedawno napisał blog post na ten temat. Podsumowując, można użyć autodts jeśli zastąpić index.ts z api.ts, zawierające następujące informacje:

export {default as Token} from './api/Token'; 

Upewnij api.ts jest w tym samym miejscu co katalog api (obok, nie w środku).

Następnie trzeba package.json plik:

{ 
    "name": "api", 
    "version": "1.0.0", 
    "main": "dist/api.js", 
    "scripts": { 
    "preinstall": "npm install autodts", 
    "postinstall": "autodts link", 
    "prepublish": "tsc && autodts generate" 
    }, 
    "typescript": { 
    "definition": "index.d.ts" 
    }, 
    "dependencies": { 
    "autodts": "~0.0.4" 
    }, 
    "devDependencies": { 
    "@lib/autodts-generator": "~0.0.1", 
    "typescript": "~1.5.3" 
    } 
} 

ważne jest, że nazwa pakietu api dopasowuje plik api.ts i katalog api. W ten sposób zarówno Node.js, jak i kompilator TypeScript będą wyglądały w tych samych miejscach, gdy używasz pakietu.

Wreszcie, trzeba tsconfig.json plik:

{ 
    "compilerOptions": { 
     "declaration": true, 
     "module": "CommonJS", 
     "target": "es5", 
     "outDir": "dist" 
    }, 
    "files": [ 
     "api.ts" 
    ] 
} 

Teraz npm install zostanie skompilowany pakiet i produkować dołączonego index.d.ts plik zdefiniowany w ustawieniach definition w package.json.

Aby korzystać z pakietu, można zrobić coś takiego:

/// <reference path = "api/index.d.ts" /> 

import {Token} from 'api'; 

class foo { 
    key: Token; 
} 

Można użyć autodts link zachować reference path na bieżąco, sprawdź blogu i/lub autodts Dokumenty na to.

Powstały index.d.ts zawiera:

/// <reference path="index.ref.d.ts" /> 
declare module 'api/Token' { 
    interface Token { 
     code: string; 
    } 
    export default Token; 

} 
declare module 'api' { 
    export { default as Token } from 'api/Token'; 

} 

index.ref.d.ts i api.js są puste.