这个问题是对我之前的问题的改进：How do I write a TypeScript declaration file for an external commonjs module that has constructor?
我正在尝试为imap模块编写声明文件： - imap on npm - node-imap 该文件应该是什么样的？
在找不到上述原始问题的满意答案后，我发现该语言存在一些竞争特征：
import fs = require('fs');
declare module 'A' {}
到目前为止，这是我对声明文件的内容：
interface IIMAPAccount {
user: string;
password: string;
host: string;
port: number;
tls?: boolean;
}
interface IEMail {
mail: any;
}
interface ICriteria {
// The following message flags are valid types that do not have arguments:
ALL: void; // All messages.
ANSWERED: void; // Messages with the Answered flag set.
DELETED: void; // Messages with the Deleted flag set.
DRAFT: void; // Messages with the Draft flag set.
FLAGGED: void; // Messages with the Flagged flag set.
NEW: void; // Messages that have the Recent flag set but not the Seen flag.
SEEN: void; // Messages that have the Seen flag set.
RECENT: void; // Messages that have the Recent flag set.
OLD: void; // Messages that do not have the Recent flag set. This is functionally equivalent to "!RECENT" (as opposed to "!NEW").
UNANSWERED: void; // Messages that do not have the Answered flag set.
UNDELETED: void; // Messages that do not have the Deleted flag set.
UNDRAFT: void; // Messages that do not have the Draft flag set.
UNFLAGGED: void; // Messages that do not have the Flagged flag set.
UNSEEN: void; // Messages that do not have the Seen flag set.
// The following are valid types that require string value(s):
BCC: any; // Messages that contain the specified string in the BCC field.
CC: any; // Messages that contain the specified string in the CC field.
FROM: any; // Messages that contain the specified string in the FROM field.
SUBJECT: any; // Messages that contain the specified string in the SUBJECT field.
TO: any; // Messages that contain the specified string in the TO field.
BODY: any; // Messages that contain the specified string in the message body.
TEXT: any; // Messages that contain the specified string in the header OR the message body.
KEYWORD: any; // Messages with the specified keyword set.
HEADER: any; // Requires two string values, with the first being the header name and the second being the value to search for. If this second string is empty, all messages that contain the given header name will be returned.
// The following are valid types that require a string parseable by JavaScripts Date object OR a Date instance:
BEFORE: any; // Messages whose internal date (disregarding time and timezone) is earlier than the specified date.
ON: any; // Messages whose internal date (disregarding time and timezone) is within the specified date.
SINCE: any; // Messages whose internal date (disregarding time and timezone) is within or later than the specified date.
SENTBEFORE: any; // Messages whose Date header (disregarding time and timezone) is earlier than the specified date.
SENTON: any; // Messages whose Date header (disregarding time and timezone) is within the specified date.
SENTSINCE: any; // Messages whose Date header (disregarding time and timezone) is within or later than the specified date.
//The following are valid types that require one Integer value:
LARGER: number; // Messages with a size larger than the specified number of bytes.
SMALLER: number; // Messages with a size smaller than the specified number of bytes.
// The following are valid criterion that require one or more Integer values:
UID: any; // Messages with UIDs corresponding to the specified UID set. Ranges are permitted (e.g. '2504:2507' or '*' or '2504:*').
}
interface IFetchOptions {
markSeen: boolean; // Mark message(s) as read when fetched. Default: false
struct: boolean; // Fetch the message structure. Default: false
envelope: boolean; // Fetch the message envelope. Default: false
size: boolean; // Fetch the RFC822 size. Default: false
modifiers: any; // Fetch modifiers defined by IMAP extensions. Default: (none)
bodies: any; // A string or Array of strings containing the body part section to fetch. Default: (none) Example sections:
}
declare module "imap" {
import events = require('events');
import EventEmitter = events.EventEmitter;
interface IMAPFetch extends EventEmitter {
}
class IMAP extends EventEmitter {
constructor(account : IIMAPAccount);
connect();
openBox(name : string, flag : boolean, cb : (err : Error, box) => void);
search(criteria : ICriteria, cb : (error : Error, uids : string[]) => void);
fetch(source : any, object : IFetchOptions) : IMAPFetch;
}
var out: typeof IMAP;
export = out;
}
理想情况下，所有接口都将在模块内部定义＆＃34; imap＆＃34;，因此不会污染全局范围。
答案 0 :(得分：2)
理想情况下，所有接口都将在模块“imap”内定义，因此不会污染全局范围
而不是：
interface IFetchOptions {
markSeen: boolean;
// so on
}
interface ICriteria {
ALL: void;
}
执行以下操作
module imap {
interface IFetchOptions {
markSeen: boolean;
// so on
}
interface ICriteria {
ALL: void;
}
}
您只能使用imap污染全局范围。这是非初始化模块，只能用于类型信息。
参考：查看 ghost模块：http://definitelytyped.org/guides/best-practices.html
答案 1 :(得分：1)
在继续研究这个问题后，我编写了定义文件，但仍未找到将所有接口放入模块内部的方法，以避免污染全局范围。
我在一个拉请求中将定义文件提交给了DefinitelyTyped，你可以在这里查看： https://github.com/psnider/DefinitelyTyped/commit/460bb6d63e349918b20e49d7a62f3d2a7c2aea0a
已编辑
谢谢， basarat ，指出我正确的方向，虽然我无法将它缝在一起，直到我发现了一些缺失的碎片。
我查看了其他答案和定义文件，发现了一种似乎有用的方法，并更新了我的拉取请求： https://github.com/borisyankov/DefinitelyTyped/pull/3324
我在 imap.d.ts ：
中使用了这种模式declare module IMAP {
export interface Config {}
export class Connection {
constructor(config : Config);
}
}
declare module "imap" {
var out: IMAP.Connection;
export = out;
}
IMAP是一个非初始化模块，如basarat建议的那样，它使接口可以在IMAP命名空间内访问。
然后在使用imap模块的代码中， example.ts ：
/// <reference path='imap.d.ts' /> // brings module IMAP into scope
import Imap = require('imap'); // gets the connection class
var conn = new Imap({/* omitted for brevity*/}); // creates an imap connection