javascript - Hvordan eksporterer/importerer man korrekt Typescript-moduler?
Første gang jeg skriver en Typescript-pakke (NPM/privat pakke), men har masser af erfaring med selve Typescript.
Sig, at min pakke hedder "my-api". Den eksporterer klasser til at lave API-kald samt de modeller, der forbruges/returneres af disse API-kald.
struktur
models/
User.ts
index.ts
services/
BaseService.ts
UserService.ts
index.ts
index.ts
models/User.ts
export type User = { ... }
models/index.ts
export { User } from "./User.ts";
tjenester/BaseService.ts
export abstract class BaseService { ... }
tjenester/BrugerService.ts
export class UserService extends BaseService { ... }
tjenester/index.ts
export { UserService } from "./UserService.ts";
index.ts
export * from "./models";
export * from "./services";
erklæring
Min erklæring ender med at se sådan ud (forkortet):
declare module "models/User" {
export type User = { ... };
}
declare module "services/BaseService" {
export abstract class BaseService { ... }
}
declare module "services/UserService" {
import { BaseService } from "services/BaseService";
export class UserService extends BaseService { ... }
}
Bemærk, at der ikke er nogen omfattende my-api-modul osv., disse erklæringer er i roden.
forventet brug
I min app, som inkluderer my-api via NPM, vil jeg bruge disse klasser og typer:
OpretBrugerForm.ts
import { User, UserService } from "my-api";
// OR
import { User } from "my-api/models";
import { UserService } from "my-api/services";
export class CreateUserForm { ... }
men det virker ikke
Når jeg bygger mit ydre projekt, klager Typescript:
Filen '/home/.../my-project/ui/node_modules/my-api/my-api.d.ts' er ikke et modul.
Jeg ved ikke, hvordan jeg skal overbevise Typescript om at oprette den passende definition.
appendiks
Deklarationer genereres ved hjælp af denne kommando:
./node_modules/.bin/tsc --project ./tsconfig-definition.json --outFile ./dist/my-api.d.ts
tsconfig-definition.json
{
"extends": "./tsconfig.json",
"compilerOptions": {
"declaration": true,
"emitDeclarationOnly": true,
"noEmit": false,
"resolveJsonModule": false
},
"include": [ "./src" ]
}
tsconfig.json
{
"compilerOptions": {
"lib": ["dom", "es2015", "es2016"],
"jsx": "preserve",
"target": "es5",
"module": "esnext",
"moduleResolution": "node",
"declaration": false,
"noImplicitAny": false,
"noUnusedLocals": false,
"noUnusedParameters": false,
"removeComments": false,
"preserveConstEnums": true,
"sourceMap": true,
"skipLibCheck": true,
"allowJs": false,
"experimentalDecorators": true,
"esModuleInterop": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true,
"isolatedModules": false,
"strictNullChecks": false,
"noEmit": true,
"allowSyntheticDefaultImports": true,
"types": ["node"]
},
"include": ["src"]
}