引用Typescript .d.ts文件中定义的其他库类型/接口

时间:2015-11-14 12:09:41

标签: node.js typescript sequelize.js

编辑以尝试更具体(删除旧示例):

我想知道如何在我自己的类和接口中引用.d.ts文件中定义的类型或接口作为函数参数或类属性的类型。

这是一个例子。我将解释一些不完全的细节 与问题相关但解释代码示例:

var fs = require("fs");
var path = require("path");
var Sequelize = require("sequelize");
var config = require('../config/environment');

class SequelizeDB{
    sequelizeInstance: any;
    sequelize: any;
    modelDirectory: string;
    constructor(Sequelize, dbConfig){  
        //instantiate the sequelize instance object
        this.sequelize  = Sequelize;
        this.sequelizeInstance = this.getDatabaseInstance(this.sequelize,
                                                        dbConfig.databaseName, 
                                                        dbConfig.userName, 
                                                        dbConfig.password, 
                                                        dbConfig.hostName,
                                                        dbConfig.port,
                                                        dbConfig.dialect);
       this.modelDirectory = __dirname + '/sequelize';                                                                                                                                                                                                         
       this.importDataModels();
       this.associateDataModels();
    }
    private getDatabaseInstance(Sequelize,
                        databaseName: string, 
                        userName: string, 
                        password: string, 
                        hostName: string, 
                        port: number, 
                        dialect: string){

        return new Sequelize(
            databaseName, 
            userName,
            password, 
            //options
            {
                host: hostName,
                dialect: dialect,
                port: port,
                pool: {
                    max: 5,
                    min: 0,
                    idle: 10000
            },
        });    
    }
    private importDataModels(){
        //read in all the models from the current folder 
        fs
        .readdirSync(this.modelDirectory)
            .filter((fileName) => {
            return  this.isModelFile(fileName);
        })
        .forEach((file) =>{
            //create the models in the seuelizeInstance
            var model = this.sequelizeInstance.import(path.join(this.modelDirectory, file));
            this[model.name] = model;
        });
    }
    private isModelFile(fileName: string){
        return (fileName.indexOf('.') !== 0) && 
               (fileName !== 'index.js') &&  
               (fileName.indexOf('.map') === -1) &&  //ignore map files
               (fileName.indexOf('.ts') === -1); //ignore ts files
    }
    private associateDataModels(){
        Object.keys(this).forEach((modelName) => {
            if (typeof( this[modelName]) === 'object' &&  'associate' in this[modelName]) {
                this[modelName].associate(this);
            }
       });
    }

};

module.exports = new SequelizeDB(Sequelize, config.sql);

我正在使用Sequelize,我有一个模式设置 根据文档简化模型的创建。该 当前的设置对我有用,代码正在做的是创建一个类 创建时设置数据库连接。

然后循环遍历models文件夹中的所有文件并创建所有模型 使用Seuquelize.import。

现在我想知道的是我如何能够替换这部分以使用实际的部分 来自.d.ts文件的类型为sequelize(这里)[https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/sequelize/sequelize.d.ts]

在我看来,有一个Sequelize静态对象用于创建(小写)续集实例。像这样:

new Sequelize(//config values)

我想将这两件事存储在我在上面的代码中创建的类中,并且目前要让它们通过编译器我已经使它们类型为any

sequelizeInstance: any;
sequelize: any;

我如何能够利用存在的Sequelize .d.ts文件,并更加明确我在该对象中所期望的Type以及传递给其构造函数的类型。

这不是唯一的例子,但我更常提到的是我可以在TypeScript中创建一个接口或类 并强制执行某个特定类或接口的函数,例如:

interface IUser{
    id: number,
    username: string,
    passwork: string    
}

function validateUser(user: IUser): boolean{
    //implementation
}

如果在我使用npm安装并使用tsd安装的节点中的模块中定义了用户界面,我该怎么做?

如果这还不够详细,请告诉我,我会尝试解释更多。

1 个答案:

答案 0 :(得分:0)

最简单的方法是使用

/// <reference path="../typings/sequelize/sequelize.d.ts" />

从那时起,您将能够使用该d.ts文件中的接口。此外,编译器将知道在编译中包含此文件,因此在缺少的接口上没有错误。

您拥有的最高级选项是使用tsconfig.json(大多数IDE了解此文件),并在 tsconfig中指示项目的所有文件(包括来自tsd的.d.ts) .json ,编译器将“知道”编译中包含的内容。

最好的办法,实际上是导入这样的文件:

import * from '../typings/sequelize/sequelize'; // without extension

编译器将在编译代码之前获取该文件。如果它只有环境声明(d.ts),它将不包括在最终结果中(这是好的)。