0.0.1-alpha.2
  • 编辑此页(E)
  • 报告 BUG(B)
  • 查看源码(V)
  • 单元测试(U)

    • Index

    xuld
    2020/11/9(#1, xuld)

    API

    查看源码
    (共 130 行)    readConfigs

    读取自动生成的配置

    参数
    参数名说明类型
    (可选)path

    配置的文件路径

    默认值："package.json";

    		string
    返回值
    类型：DevServerOptions

    查看源码
    (共 174 行)    DevServer 类

    表示一个开发服务器

    继承：WebServer ← HTTPServer

    构造函数

    DevServer查看源码
    (共 43 行)    new DevServer已重写

    初始化新的开发服务器

    参数
    参数名说明类型
    (可选)options

    附加选项

    展开子属性
    • devServer — 服务器的选项
      • url: string | number — 服务器的根地址或端口
      • open: string | false | true — 是否在首次启动时打开浏览器
      • openURL: string — 首次启动时打开的地址
      • headers: {[name: string]: string} — 附加的响应头内容
      • routers: WebServerRouter[] — 响应请求的路由规则
      • rootDir: string — 当前服务器的根目录
      • directoryList: boolean — 是否自动列出文件
      • defaultPages: string[] — 默认首页
      • mimeTypes: {[ext: string]: string | false} — 所有自定义扩展名（含点）到 MIME 类型的映射表
      • fs: FileSystem — 使用的文件系统
      • https: boolean — 是否启用加密传输协议
      • http2: boolean — 是否启用 HTTP/2 协议
      • maxAllowedContentLength: number — 允许请求的最大字节数
      • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
      • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
      • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
      • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
      • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
      • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
      • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
      • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
      • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
      • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
        • pem: string | Buffer — Private keys in PEM format.
        • passphrase: string — Optional passphrase.
      • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
      • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
      • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
      • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
      • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
      • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
        • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
        • passphrase: string — Optional passphrase.
      • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
      • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
      • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
      • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information. 48-bytes of cryptographically strong pseudo-random data.
      • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
      • handshakeTimeout: number — Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).
      • pskCallback: typeof pskCallback
      • pskIdentityHint: string — hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.
      • secureContext — An optional TLS context object from tls.createSecureContext()
        • context: any
      • enableTrace: boolean — When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.
      • requestCert: boolean — If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
      • ALPNProtocols: string[] | Uint8Array | Uint8Array[] — An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
      • SNICallback: function(servername: string, cb: function(err: Error, ctx: SecureContext) => void) => void — SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
      • rejectUnauthorized: boolean — If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
      • IncomingMessage: typeof IncomingMessage
      • ServerResponse: typeof ServerResponse
      • maxHeaderSize: number — Optionally overrides the value of [--max-http-header-size][] for requests received by this server, i.e. the maximum length of request headers in bytes.
      • insecureHTTPParser: boolean — Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.
      • allowHTTP1: boolean
      • origins: string[]
      • Http1IncomingMessage: typeof IncomingMessage
      • Http1ServerResponse: typeof ServerResponse
      • Http2ServerRequest: typeof Http2ServerRequest
      • Http2ServerResponse: typeof Http2ServerResponse
      • maxDeflateDynamicTableSize: number
      • maxSessionMemory: number
      • maxHeaderListPairs: number
      • maxOutstandingPings: number
      • maxSendHeaderBlockLength: number
      • paddingStrategy: number
      • peerMaxConcurrentStreams: number
      • settings
        • headerTableSize: number
        • enablePush: boolean
        • initialWindowSize: number
        • maxFrameSize: number
        • maxConcurrentStreams: number
        • maxHeaderListSize: number
        • enableConnectProtocol: boolean
      • selectPadding: typeof selectPadding
      • createConnection: typeof createConnection
      • apis: {[name: string]: function(request: HTTPRequest, response: HTTPResponse, server: DevServer) => void} — 自定义服务器接口
      • liveReload — 是否开启实时刷新
        • version: number — 实时刷新协议的版本
        • url — 服务端的监听地址
          • auth: string
          • hash: string
          • host: string
          • hostname: string
          • href: string
          • pathname: string
          • protocol: string
          • search: string
          • slashes: boolean
          • port: string | number
          • query: string | ParsedUrlQueryInput
        • port: string | number — 服务器的监听端口
        • server: Server | Server — 已存在的服务器
        • liveCSS: boolean — 是否启用 CSS 实时刷新
        • liveImage: boolean — 是否启用图片实时刷新
        • originalPath: string — 所有请求路径对应的原始路径
        • overrideURL: string — 指定浏览器的地址
        • path: string — 服务器的路径
        • backlog: number — 允许的最大连接数
        • verify: function(request: IncomingMessage, socket: Socket, server: WebSocketServer) => false | true | Promise<boolean> — 验证是否允许指定的客户端连接
        • selectProtocol: function(protocols: string[]) => string — 选择合适的子协议
        • maxBufferSize: number — 允许远程发送的每个数据块的最大字节数
        • extension: WebSocketExtension — WebSocket 扩展
        • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
        • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
        • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
        • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
        • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
        • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
        • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
        • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
        • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
        • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
          • pem: string | Buffer — Private keys in PEM format.
          • passphrase: string — Optional passphrase.
        • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
        • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
        • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
        • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
        • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
        • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
          • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
          • passphrase: string — Optional passphrase.
        • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
        • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
        • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
        • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information. 48-bytes of cryptographically strong pseudo-random data.
        • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
        • handshakeTimeout: number — Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).
        • pskCallback: typeof pskCallback
        • pskIdentityHint: string — hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.
        • secureContext — An optional TLS context object from tls.createSecureContext()
          • context: any
        • enableTrace: boolean — When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.
        • requestCert: boolean — If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
        • ALPNProtocols: string[] | Uint8Array | Uint8Array[] — An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
        • SNICallback: function(servername: string, cb: function(err: Error, ctx: SecureContext) => void) => void — SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
        • rejectUnauthorized: boolean — If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
        • IncomingMessage: typeof IncomingMessage
        • ServerResponse: typeof ServerResponse
        • maxHeaderSize: number — Optionally overrides the value of [--max-http-header-size][] for requests received by this server, i.e. the maximum length of request headers in bytes.
        • insecureHTTPParser: boolean — Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.
        • delay: number — 延时刷新的等待时间（毫秒）
    • baseDir: string — 配置文件中所有路径的基路径
    • ignore: Pattern — 监听和生成的忽略列表
    • srcDir: string — 存放源码的文件夹路径
    • outDir: string — 构建生成的文件夹路径
    • assetsDir: string — 静态资源文件夹路径
    • homePageName: string — 设置项目主页文件名
    • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
    • outDefaultFile: string — 设置输出的默认文件名
    • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
    • fs: FileSystem — 使用的文件系统
    • locale: string — 使用的语言（如 en-US）
    • compilers: Compiler[] — 自定义编译器列表
    • logger — 日志记录器的选项
      • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
      • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
      • colors: boolean — 是否打印带颜色控制符的日志
      • emoji: boolean — 是否打印图形表情
      • timestamp: boolean — 是否打印时间戳
      • fullPath: boolean — 是否打印完整绝对路径
      • baseDir: string — 打印相对路径时使用的基路径
      • codeFrame: boolean — 是否打印代码片段
      • persistent: boolean — 是否禁止清屏
      • progress: boolean — 是否打印进度条
      • spinnerFrames: string[] — 进度指示器的所有桢
      • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
      • hideCursor: boolean — 是否需要隐藏控制台光标
      • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
      • successIcon: string — 在成功日志前追加的前缀
      • warningIcon: string — 在警告日志前追加的前缀
      • errorIcon: string — 在错误日志前追加的前缀
      • fatalIcon: string — 在致命错误日志前追加的前缀
    • sourceMap: boolean — 开发时是否启用源映射
    • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
    • optimize: boolean — 发布时是否优化生成的代码
    • ts: any — 内置 TypeScript 编译器的附加选项
    • sass: any — 内置 Sass 编译器的附加选项
    • less: any — 内置 Less 编译器的附加选项
    • webpack: any — 内置 Webpack 编译器的附加选项
    • md: any — 内置 Markdown 编译器的附加选项
    • doc — 内置文档编译器的附加选项
      • baseURL: string — 生成的页面中引用资源的根地址
      • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
      • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
      • version: string — 项目版本
      • versions: array — 其它版本链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • navbar: array — 顶部导航条链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • children: array — 子菜单
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
      • footer: array — 底部链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • copyright: string — 底部版权声明
      • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
      • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
      • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
      • backToTop: boolean — 是否插入返回顶部链接
      • introDescription: string — 项目描述
      • introButtons: array — 项目描述后的按钮
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • features: array — 项目优势说明链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
        • description: string — 描述文案
      • links: array — 友情链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
      • support — 支持/赞助链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • packageName: string — 发布的包名
      • repository: string — 项目仓库地址(HTTPS 协议)
      • repositoryPath: string — 项目根目录在仓库中的路径
      • branch: string — 项目仓库分支
      • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    • modules: {[name: string]: string} — 配置供代码加载的内置模块
    • build — 一次性构建时额外设置的选项
      • baseDir: string — 配置文件中所有路径的基路径
      • ignore: Pattern — 监听和生成的忽略列表
      • srcDir: string — 存放源码的文件夹路径
      • outDir: string — 构建生成的文件夹路径
      • assetsDir: string — 静态资源文件夹路径
      • homePageName: string — 设置项目主页文件名
      • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
      • outDefaultFile: string — 设置输出的默认文件名
      • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
      • fs: FileSystem — 使用的文件系统
      • locale: string — 使用的语言（如 en-US）
      • compilers: Compiler[] — 自定义编译器列表
      • logger — 日志记录器的选项
        • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
        • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
        • colors: boolean — 是否打印带颜色控制符的日志
        • emoji: boolean — 是否打印图形表情
        • timestamp: boolean — 是否打印时间戳
        • fullPath: boolean — 是否打印完整绝对路径
        • baseDir: string — 打印相对路径时使用的基路径
        • codeFrame: boolean — 是否打印代码片段
        • persistent: boolean — 是否禁止清屏
        • progress: boolean — 是否打印进度条
        • spinnerFrames: string[] — 进度指示器的所有桢
        • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
        • hideCursor: boolean — 是否需要隐藏控制台光标
        • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
        • successIcon: string — 在成功日志前追加的前缀
        • warningIcon: string — 在警告日志前追加的前缀
        • errorIcon: string — 在错误日志前追加的前缀
        • fatalIcon: string — 在致命错误日志前追加的前缀
      • sourceMap: boolean — 开发时是否启用源映射
      • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
      • optimize: boolean — 发布时是否优化生成的代码
      • ts: any — 内置 TypeScript 编译器的附加选项
      • sass: any — 内置 Sass 编译器的附加选项
      • less: any — 内置 Less 编译器的附加选项
      • webpack: any — 内置 Webpack 编译器的附加选项
      • md: any — 内置 Markdown 编译器的附加选项
      • doc — 内置文档编译器的附加选项
        • baseURL: string — 生成的页面中引用资源的根地址
        • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
        • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
        • version: string — 项目版本
        • versions: array — 其它版本链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
        • navbar: array — 顶部导航条链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
          • children: array — 子菜单
            • label: string — 链接文案
            • href: string — 链接地址
            • title: string — 鼠标悬停时的工具提示
        • footer: array — 底部链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
        • copyright: string — 底部版权声明
        • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
        • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
        • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
        • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
        • backToTop: boolean — 是否插入返回顶部链接
        • introDescription: string — 项目描述
        • introButtons: array — 项目描述后的按钮
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
        • features: array — 项目优势说明链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
          • icon: string — 图标
          • description: string — 描述文案
        • links: array — 友情链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
          • icon: string — 图标
        • support — 支持/赞助链接
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
        • packageName: string — 发布的包名
        • repository: string — 项目仓库地址(HTTPS 协议)
        • repositoryPath: string — 项目根目录在仓库中的路径
        • branch: string — 项目仓库分支
        • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
      • modules: {[name: string]: string} — 配置供代码加载的内置模块
      • build: (Circular)BuilderOptions — 一次性构建时额外设置的选项
      • plugins: (string | BuilderPlugin)[] — 所有附加插件
    • plugins: (string | BuilderPlugin)[] — 所有附加插件
    		DevServerOptions

    属性

    属性名说明类型
    builder只读

    获取使用的构建器

    		Builder
    watcher只读

    获取使用的监听器

    		FileSystemWatcher
    liveReloadServer只读

    获取使用的实时刷新服务器

    		LiveReloadServer
    liveReloadDelay只读

    获取实时刷新的延时时间

    		number
    apis只读

    获取所有对外的 HTTP 接口

    展开子属性
    		{livereload.js(request: HTTPRequest, response: HTTPResponse, server: DevServer): voidremoteHost(request: HTTPRequest, response: HTTPResponse, server: DevServer): void}
    继承自 HTTPServer 类的属性
    属性名说明类型
    isSecure只读

    判断当前服务器是否使用了加密传输协议（HTTPS）

    		boolean
    url只读已重写

    获取当前服务器的根地址，如果服务器未在监听则返回 undefined

    		string
    maxAllowedContentLength

    获取或设置允许请求的最大字节数

    		number
    sessions

    获取或设置当前服务器的会话管理器

    		HTTPSessionManager
    handleRequest保护

    处理原生 HTTP 请求事件

    		(request: HTTPRequest, response: HTTPResponse) => void
    继承自 WebServer 类的属性
    属性名说明类型
    rootPath只读

    获取服务根地址

    		string
    open只读

    判断是否在启动时打开浏览器

    		string | false | true
    openURL只读

    获取启动时打开的地址

    		string
    routers只读

    响应请求的路由规则

    展开子属性
    • matcher: Matcher — 匹配请求的匹配器
    • process: typeof process — 自定义处理请求
    • break: boolean — 是否终止后续路由
    		{matcher: Matcher // 匹配请求的匹配器process(request: HTTPRequest, response: HTTPResponse, server: WebServer): void | Promise<void> // 自定义处理请求break?: boolean // 是否终止后续路由}[]
    rootDir只读

    获取当前服务器的根文件夹

    		string
    fs只读

    获取使用的文件系统

    		FileSystem
    directoryList只读

    判断是否自动列出文件

    		boolean
    defaultPages只读

    获取默认首页

    		string[]
    hostname(可选)只读

    获取配置的服务器主机地址

    		string
    port(可选)只读

    获取配置的服务器端口

    		number
    backlog(可选)只读

    获取允许的最大连接数

    		number
    headers(可选)只读

    在每个请求中附加的请求头内容

    		{[name: string]: string}
    mimeTypes(可选)只读

    获取所有自定义扩展名（含点）到 MIME 类型的映射表

    		{[ext: string]: string | false}
    继承自 Server 类的属性
    属性名说明类型
    maxConnectionsnumber
    connectionsnumber
    listeningboolean

    方法

    DevServer查看源码
    (共 9 行)    close异步已重写

    关闭服务器

    返回值
    类型：Promise<void>

    Http2SecureServeraddListener已重写

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    events.EventEmitter

    1. close
    2. connection
    3. error
    4. listening
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    Http2SecureServeremit已重写

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"connection"
    socketSocket
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"error"
    errError
    返回值
    类型：boolean
    参数
    参数名说明类型
    event"listening"
    返回值
    类型：boolean

    Http2SecureServeron已重写

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    Http2SecureServeronce已重写

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    Http2SecureServerprependListener已重写

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server

    Http2SecureServerprependOnceListener已重写

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    • 重载 2
    • 重载 3
    • 重载 4
    参数
    参数名说明类型
    event"close"
    listener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"connection"
    listener(socket: Socket) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"error"
    listener(err: Error) => void
    返回值
    类型：Server
    参数
    参数名说明类型
    event"listening"
    listener() => void
    返回值
    类型：Server
    继承自 HTTPServer 类的方法

    WebServerprocessRequest已重写

    处理客户端请求

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    返回值
    类型：Promise<void>
    继承自 WebServer 类的方法

    WebServermapPath

    获取请求地址对应的本地物理路径，如果无法映射则返回空

    参数
    参数名说明类型
    path

    请求的地址

    		string
    返回值
    类型：string

    WebServerwriteStatic

    响应一个静态文件或文件夹

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    path

    本地文件或文件夹路径

    		string
    返回值
    类型：Promise<void>

    WebServerwriteFile

    响应一个文件

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    path

    文件或文件夹路径

    		string
    (可选)etag

    文件最后修改戳

    		string
    返回值
    类型：Promise<void>

    DevServer查看源码
    (共 22 行)    start异步已重写

    启动服务器

    参数
    参数名说明类型
    (可选)ignoreErrorboolean
    返回值
    类型：Promise<void>

    WebServerwriteDir

    响应一个文件列表

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    entries

    所有文件夹和文件项

    展开子属性
    • name: string
    • isDir: boolean
    • modified: Date
    • size: number
    • title: string
    		{name: stringisDir?: booleanmodified?: Datesize?: numbertitle?: string}[]
    (可选)rootDir

    是否是根目录

    		boolean
    返回值
    类型：void

    WebServerwriteContent

    响应一个静态数据

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    content

    要响应的内容

    		string | Buffer
    (可选)mimeType

    要响应的 MIME 类型

    		string
    (可选)etag

    缓存内容的标签，如果客户端传递了相同的标签则使用客户端缓存

    		string
    返回值
    类型：void

    DevServer查看源码
    (共 45 行)    defaultRouter异步已重写

    默认路由

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    返回值
    类型：Promise<any>

    WebServerwriteServerJS

    响应一个服务端 JS

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    path

    要执行的 JS 代码路径

    		string
    (可选)context

    代码中可使用的全局变量

    		{[key: string]: any}
    (可选)end

    是否结束请求

    		boolean
    返回值
    类型：Promise<void>

    WebServerwriteEJS

    响应一个 EJS 模板（仅支持 <% %>、<%= %> 和 <%# %> 语法）

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    path

    要响应的错误或 HTTP 错误码

    		string
    (可选)context

    模板中可使用的全局变量

    		{[key: string]: any}
    (可选)end

    是否结束请求

    		boolean
    返回值
    类型：Promise<void>

    WebServerwriteProxy

    响应一个代理服务器

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    url

    实际请求的地址

    		string
    返回值
    类型：Promise<void>

    WebServerwriteError

    响应一个错误

    参数
    参数名说明类型
    request

    当前的请求对象

    		HTTPRequest
    response

    当前的响应对象

    		HTTPResponse
    error

    要响应的错误或 HTTP 错误码

    展开子属性
    • errno: number
    • code: string
    • path: string
    • syscall: string
    • stack: string
    • name: string
    • message: string
    		number | ErrnoException
    返回值
    类型：void

    WebServerformatURL保护

    替换设置的重写地址中的变量

    参数
    参数名说明类型
    url

    用户设置的地址

    		string
    path

    请求路径

    		string
    (可选)baseDir

    基路径

    		string
    返回值
    类型：string

    WebServerformatDate保护

    格式化时间为可读格式

    参数
    参数名说明类型
    date

    要格式化的时间

    		Date
    now

    服务器的当前时间

    		Date
    返回值
    类型：string
    继承自 EventEmitter 接口的方法

    EventEmitterremoveListener

    参数
    参数名说明类型
    eventstring | symbol
    listener(...args: any[]) => void
    返回值
    类型：EventEmitter

    EventEmitteroff

    参数
    参数名说明类型
    eventstring | symbol
    listener(...args: any[]) => void
    返回值
    类型：EventEmitter

    EventEmitterremoveAllListeners

    参数
    参数名说明类型
    (可选)eventstring | symbol
    返回值
    类型：EventEmitter

    EventEmittersetMaxListeners

    参数
    参数名说明类型
    nnumber
    返回值
    类型：EventEmitter

    EventEmittergetMaxListeners

    返回值
    类型：number

    EventEmitterlisteners

    参数
    参数名说明类型
    eventstring | symbol
    返回值
    类型：Function[]

    EventEmitterrawListeners

    参数
    参数名说明类型
    eventstring | symbol
    返回值
    类型：Function[]

    EventEmitterlistenerCount

    参数
    参数名说明类型
    eventstring | symbol
    返回值
    类型：number

    EventEmittereventNames

    返回值
    类型：(string | symbol)[]
    继承自 Server 类的方法

    Serverlisten

    • 重载 2
    • 重载 3
    • 重载 4
    • 重载 5
    • 重载 6
    • 重载 7
    • 重载 8
    参数
    参数名说明类型
    (可选)portnumber
    (可选)hostnamestring
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    (可选)portnumber
    (可选)backlognumber
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    (可选)portnumber
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    pathstring
    (可选)backlognumber
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    pathstring
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    options
    展开子属性
    • port: number
    • host: string
    • backlog: number
    • path: string
    • exclusive: boolean
    • readableAll: boolean
    • writableAll: boolean
    • ipv6Only: boolean
    		ListenOptions
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    handleany
    (可选)backlognumber
    (可选)listeningListener() => void
    返回值
    类型：Server
    参数
    参数名说明类型
    handleany
    (可选)listeningListener() => void
    返回值
    类型：Server

    Serveraddress

    返回值
    类型：string | AddressInfo

    ServergetConnections

    参数
    参数名说明类型
    cb(error: Error, count: number) => void
    返回值
    类型：void

    Serverref

    返回值
    类型：Server

    Serverunref

    返回值
    类型：Server
    继承自 Server 类的方法

    ServeraddContext

    The server.addContext() method adds a secure context that will be used if the client request's SNI name matches the supplied hostname (or wildcard).

    参数
    参数名说明类型
    hostNamestring
    credentials
    展开子属性
    • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
    • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
    • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
    • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
    • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
    • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
    • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
    • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
    • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
    • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • pem: string | Buffer — Private keys in PEM format.
      • passphrase: string — Optional passphrase.
    • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
    • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
    • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
    • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
    • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
    • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
      • passphrase: string — Optional passphrase.
    • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
    • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
    • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
    • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
    • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
    		SecureContextOptions
    返回值
    类型：void

    ServergetTicketKeys

    Returns the session ticket keys.

    返回值
    类型：Buffer

    ServersetSecureContext

    The server.setSecureContext() method replaces the secure context of an existing server. Existing connections to the server are not interrupted.

    参数
    参数名说明类型
    details
    展开子属性
    • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
    • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
    • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
    • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
    • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
    • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
    • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
    • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
    • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
    • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • pem: string | Buffer — Private keys in PEM format.
      • passphrase: string — Optional passphrase.
    • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
    • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
    • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
    • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
    • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
    • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
      • passphrase: string — Optional passphrase.
    • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
    • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
    • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
    • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
    • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
    		SecureContextOptions
    返回值
    类型：void

    ServersetTicketKeys

    The server.setSecureContext() method replaces the secure context of an existing server. Existing connections to the server are not interrupted.

    参数
    参数名说明类型
    keysBuffer
    返回值
    类型：void
    继承自 Http2SecureServer 接口的方法

    Http2SecureServersetTimeout

    参数
    参数名说明类型
    (可选)msecnumber
    (可选)callback() => void
    返回值
    类型：Http2SecureServer

    查看源码
    (共 813 行)    Builder 类

    表示一个构建器

    构造函数

    Builder查看源码
    (共 88 行)    new Builder

    初始化新的构建器

    参数
    参数名说明类型
    (可选)options

    附加选项

    展开子属性
    • baseDir: string — 配置文件中所有路径的基路径
    • ignore: Pattern — 监听和生成的忽略列表
    • srcDir: string — 存放源码的文件夹路径
    • outDir: string — 构建生成的文件夹路径
    • assetsDir: string — 静态资源文件夹路径
    • homePageName: string — 设置项目主页文件名
    • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
    • outDefaultFile: string — 设置输出的默认文件名
    • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
    • fs: FileSystem — 使用的文件系统
    • locale: string — 使用的语言（如 en-US）
    • compilers: Compiler[] — 自定义编译器列表
    • logger — 日志记录器的选项
      • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
      • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
      • colors: boolean — 是否打印带颜色控制符的日志
      • emoji: boolean — 是否打印图形表情
      • timestamp: boolean — 是否打印时间戳
      • fullPath: boolean — 是否打印完整绝对路径
      • baseDir: string — 打印相对路径时使用的基路径
      • codeFrame: boolean — 是否打印代码片段
      • persistent: boolean — 是否禁止清屏
      • progress: boolean — 是否打印进度条
      • spinnerFrames: string[] — 进度指示器的所有桢
      • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
      • hideCursor: boolean — 是否需要隐藏控制台光标
      • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
      • successIcon: string — 在成功日志前追加的前缀
      • warningIcon: string — 在警告日志前追加的前缀
      • errorIcon: string — 在错误日志前追加的前缀
      • fatalIcon: string — 在致命错误日志前追加的前缀
    • sourceMap: boolean — 开发时是否启用源映射
    • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
    • optimize: boolean — 发布时是否优化生成的代码
    • ts: any — 内置 TypeScript 编译器的附加选项
    • sass: any — 内置 Sass 编译器的附加选项
    • less: any — 内置 Less 编译器的附加选项
    • webpack: any — 内置 Webpack 编译器的附加选项
    • md: any — 内置 Markdown 编译器的附加选项
    • doc — 内置文档编译器的附加选项
      • baseURL: string — 生成的页面中引用资源的根地址
      • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
      • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
      • version: string — 项目版本
      • versions: array — 其它版本链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • navbar: array — 顶部导航条链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • children: array — 子菜单
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
      • footer: array — 底部链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • copyright: string — 底部版权声明
      • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
      • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
      • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
      • backToTop: boolean — 是否插入返回顶部链接
      • introDescription: string — 项目描述
      • introButtons: array — 项目描述后的按钮
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • features: array — 项目优势说明链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
        • description: string — 描述文案
      • links: array — 友情链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
      • support — 支持/赞助链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • packageName: string — 发布的包名
      • repository: string — 项目仓库地址(HTTPS 协议)
      • repositoryPath: string — 项目根目录在仓库中的路径
      • branch: string — 项目仓库分支
      • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    • modules: {[name: string]: string} — 配置供代码加载的内置模块
    • build: (Circular)BuilderOptions — 一次性构建时额外设置的选项
    • plugins: (string | BuilderPlugin)[] — 所有附加插件
    		BuilderOptions
    (可选)devServer

    关联的开发服务器

    		DevServer

    属性

    属性名说明类型
    options只读

    获取构建器的选项

    展开子属性
    • baseDir: string — 配置文件中所有路径的基路径
    • ignore: Pattern — 监听和生成的忽略列表
    • srcDir: string — 存放源码的文件夹路径
    • outDir: string — 构建生成的文件夹路径
    • assetsDir: string — 静态资源文件夹路径
    • homePageName: string — 设置项目主页文件名
    • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
    • outDefaultFile: string — 设置输出的默认文件名
    • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
    • fs: FileSystem — 使用的文件系统
    • locale: string — 使用的语言（如 en-US）
    • compilers: Compiler[] — 自定义编译器列表
    • logger — 日志记录器的选项
      • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
      • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
      • colors: boolean — 是否打印带颜色控制符的日志
      • emoji: boolean — 是否打印图形表情
      • timestamp: boolean — 是否打印时间戳
      • fullPath: boolean — 是否打印完整绝对路径
      • baseDir: string — 打印相对路径时使用的基路径
      • codeFrame: boolean — 是否打印代码片段
      • persistent: boolean — 是否禁止清屏
      • progress: boolean — 是否打印进度条
      • spinnerFrames: string[] — 进度指示器的所有桢
      • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
      • hideCursor: boolean — 是否需要隐藏控制台光标
      • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
      • successIcon: string — 在成功日志前追加的前缀
      • warningIcon: string — 在警告日志前追加的前缀
      • errorIcon: string — 在错误日志前追加的前缀
      • fatalIcon: string — 在致命错误日志前追加的前缀
    • sourceMap: boolean — 开发时是否启用源映射
    • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
    • optimize: boolean — 发布时是否优化生成的代码
    • ts: any — 内置 TypeScript 编译器的附加选项
    • sass: any — 内置 Sass 编译器的附加选项
    • less: any — 内置 Less 编译器的附加选项
    • webpack: any — 内置 Webpack 编译器的附加选项
    • md: any — 内置 Markdown 编译器的附加选项
    • doc — 内置文档编译器的附加选项
      • baseURL: string — 生成的页面中引用资源的根地址
      • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
      • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
      • version: string — 项目版本
      • versions: array — 其它版本链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • navbar: array — 顶部导航条链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • children: array — 子菜单
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
      • footer: array — 底部链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • copyright: string — 底部版权声明
      • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
      • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
      • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
      • backToTop: boolean — 是否插入返回顶部链接
      • introDescription: string — 项目描述
      • introButtons: array — 项目描述后的按钮
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • features: array — 项目优势说明链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
        • description: string — 描述文案
      • links: array — 友情链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
      • support — 支持/赞助链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • packageName: string — 发布的包名
      • repository: string — 项目仓库地址(HTTPS 协议)
      • repositoryPath: string — 项目根目录在仓库中的路径
      • branch: string — 项目仓库分支
      • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    • modules: {[name: string]: string} — 配置供代码加载的内置模块
    • build: (Circular)BuilderOptions — 一次性构建时额外设置的选项
    • plugins: (string | BuilderPlugin)[] — 所有附加插件
    		BuilderOptions
    compilers只读

    获取所有编译器

    		Compiler[]
    typeScriptCompiler只读

    获取使用的 TypeScript 编译器

    		TypeScriptCompiler
    externalPackageCompiler只读

    获取外部包编译器

    		Compiler
    docCompiler只读

    获取使用的文档编译器

    		DocCompiler
    fs只读

    获取使用的文件系统

    		FileSystem
    logger只读

    获取使用的日志记录器

    		Logger
    building

    判断是否正在执行最终构建

    		boolean
    devServer(可选)只读

    关联的开发服务器

    		DevServer
    vendors保护

    依赖的三方包

    		string[]

    方法

    Builder查看源码
    (共 28 行)    compileTypeScript

    编译一段 TypeScript

    参数
    参数名说明类型
    content

    要编译的源码，如果为 undefined 则自动从路径读取

    		string
    fileName

    源码的绝对路径，用于查找和该路径相关的配置以及解析源码中导入的相对路径

    		string
    (可选)checkErrors

    是否检查错误，如果为 transpileOnly 则只检查语法错误，忽略类型错误

    默认值："transpileOnly";

    		false | true | "transpileOnly"
    (可选)moduleName

    如果要生成 AMD 模块，则指定当前模块名

    		string
    (可选)renameModuleName

    重命名导入模块名的回调函数

    		(moduleName: string, sourceFile: SourceFile, program: Program) => string
    (可选)options

    针对当前文件的编译器选项

    展开子属性
    • allowJs: boolean
    • allowSyntheticDefaultImports: boolean
    • allowUmdGlobalAccess: boolean
    • allowUnreachableCode: boolean
    • allowUnusedLabels: boolean
    • alwaysStrict: boolean
    • baseUrl: string
    • bundledPackageName: string
    • charset: string
    • checkJs: boolean
    • declaration: boolean
    • declarationMap: boolean
    • emitDeclarationOnly: boolean
    • declarationDir: string
    • disableSizeLimit: boolean
    • disableSourceOfProjectReferenceRedirect: boolean
    • disableSolutionSearching: boolean
    • disableReferencedProjectLoad: boolean
    • downlevelIteration: boolean
    • emitBOM: boolean
    • emitDecoratorMetadata: boolean
    • experimentalDecorators: boolean
    • forceConsistentCasingInFileNames: boolean
    • importHelpers: boolean
    • importsNotUsedAsValues: ImportsNotUsedAsValues
    • inlineSourceMap: boolean
    • inlineSources: boolean
    • isolatedModules: boolean
    • jsx: JsxEmit.None | JsxEmit.Preserve | JsxEmit.React | ... 5 more ...JsxEmit.ReactNative | JsxEmit.ReactJSX | JsxEmit.ReactJSXDev | "none" | "preserve" | "react" | "react-jsx"
    • keyofStringsOnly: boolean
    • lib: string[]
    • locale: string
    • mapRoot: string
    • maxNodeModuleJsDepth: number
    • module: ModuleKind.None | ModuleKind.CommonJS | ModuleKind.AMD | ... 10 more ...ModuleKind.UMD | ModuleKind.System | ModuleKind.ES2015 | ModuleKind.ES2020 | ModuleKind.ESNext | "es6" | "es2015" | "esnext" | "none" | "commonjs" | "system" | "umd"
    • moduleResolution: ModuleResolutionKind.Classic | ModuleResolutionKind.NodeJs | "node" | "classic"
    • newLine: NewLineKind.CarriageReturnLineFeed | NewLineKind.LineFeed | "CRLF" | "LF"
    • noEmit: boolean
    • noEmitHelpers: boolean
    • noEmitOnError: boolean
    • noErrorTruncation: boolean
    • noFallthroughCasesInSwitch: boolean
    • noImplicitAny: boolean
    • noImplicitReturns: boolean
    • noImplicitThis: boolean
    • noStrictGenericChecks: boolean
    • noUnusedLocals: boolean
    • noUnusedParameters: boolean
    • noImplicitUseStrict: boolean
    • noPropertyAccessFromIndexSignature: boolean
    • assumeChangesOnlyAffectDirectDependencies: boolean
    • noLib: boolean
    • noResolve: boolean
    • noUncheckedIndexedAccess: boolean
    • out: string
    • outDir: string
    • outFile: string
    • paths: MapLike<string[]>
    • preserveConstEnums: boolean
    • preserveSymlinks: boolean
    • project: string
    • reactNamespace: string
    • jsxFactory: string
    • jsxFragmentFactory: string
    • jsxImportSource: string
    • composite: boolean
    • incremental: boolean
    • tsBuildInfoFile: string
    • removeComments: boolean
    • rootDir: string
    • rootDirs: string[]
    • skipLibCheck: boolean
    • skipDefaultLibCheck: boolean
    • sourceMap: boolean
    • sourceRoot: string
    • strict: boolean
    • strictFunctionTypes: boolean
    • strictBindCallApply: boolean
    • strictNullChecks: boolean
    • strictPropertyInitialization: boolean
    • stripInternal: boolean
    • suppressExcessPropertyErrors: boolean
    • suppressImplicitAnyIndexErrors: boolean
    • target: string | ScriptTarget.ES3 | ScriptTarget.ES5 | ... 5 more ...ScriptTarget.ES2015 | ScriptTarget.ES2016 | ScriptTarget.ES2017 | ScriptTarget.ES2018 | ScriptTarget.ES2019 | ScriptTarget.ESNext | ScriptTarget.JSON
    • traceResolution: boolean
    • resolveJsonModule: boolean
    • types: string[]
    • typeRoots: string[] — Paths used to compute primary types search locations
    • esModuleInterop: boolean
    • useDefineForClassFields: boolean
    		Merge<CompilerOptions, {target?: stringmodule?: "es6" | "es2015" | "esnext" | "none" | "commonjs" | "amd" | "system" | "umd"jsx?: "none" | "preserve" | "react-native" | "react" | "react-jsx"moduleResolution?: "node" | "classic"newLine?: "CRLF" | "LF"}>
    返回值
    类型：Pick<TypeScriptCompileResult, "program" | "content" | "sourceMap" | "declaration" | "sourceFile"> & CompileResult

    Builder查看源码
    (共 46 行)    getAsset异步

    获取指定地址对应的资源

    参数
    参数名说明类型
    url

    要获取的地址

    		string
    返回值
    类型：Promise<Asset>

    Builder查看源码
    (共 7 行)    getMainFileName

    获取指定文件夹的首页名（不含扩展名）

    参数
    参数名说明类型
    dir

    文件夹名

    		string
    返回值
    类型：string

    Builder查看源码
    (共 35 行)    runCompiler异步

    使用指定的编译器编译指定的文件

    参数
    参数名说明类型
    compiler

    要使用的编译器

    		Compiler
    content

    要编译的内容

    		string
    path

    要编译的路径

    		string
    outPath

    输出的路径

    		string
    返回值
    类型：Promise<Asset>

    Builder查看源码
    (共 20 行)    watch

    添加指定的路径更新后的回调函数

    参数
    参数名说明类型
    path

    要监听的绝对路径

    		string | (function(path: string, type: AssetUpdateType) => boolean)
    callback

    要添加的回调函数或资源地址

    		string | (function() => void)
    返回值
    类型：void

    Builder查看源码
    (共 24 行)    unwatch

    删除指定的路径更新后的回调函数

    参数
    参数名说明类型
    path

    监听的绝对路径

    		string | (function(path: string, type: AssetUpdateType) => boolean)
    callback

    要删除的回调函数或资源地址

    		string | (function() => void)
    返回值
    类型：void

    Builder查看源码
    (共 32 行)    emitUpdate

    通知指定的路径已更新

    参数
    参数名说明类型
    path

    更新的文件绝对路径

    		string
    type

    更新的类型

    		AssetUpdateType
    返回值
    类型：void

    Builder查看源码
    (共 66 行)    build异步

    立即构建资源

    参数
    参数名说明类型
    (可选)clean

    是否在构建前清理目标文件夹

    默认值：true;

    		boolean
    (可选)url

    要构建的资源地址，如果为空则构建所有资源

    		string
    返回值
    类型：Promise<void>

    Builder查看源码
    (共 6 行)    getRootDirNames异步

    获取项目的根文件夹

    返回值
    类型：Promise<string[]>

    Builder查看源码
    (共 7 行)    toURL

    返回指定路径的访问地址

    参数
    参数名说明类型
    path

    要获取的绝对路径

    		string
    返回值
    类型：string

    Builder查看源码
    (共 14 行)    toShortURL

    获取访问指定资源的最短地址

    参数
    参数名说明类型
    path

    要访问的资源路径

    		string
    返回值
    类型：string

    Builder查看源码
    (共 7 行)    toPath

    返回指定地址对应的绝对路径

    参数
    参数名说明类型
    urlstring
    返回值
    类型：string

    Builder查看源码
    (共 13 行)    getOutputName

    获取指定模块生成的模块名

    参数
    参数名说明类型
    name

    源模块名

    		string
    返回值
    类型：string

    Builder查看源码
    (共 17 行)    getOutputNames

    获取指定模块生成的所有模块名

    参数
    参数名说明类型
    name

    源模块名

    		string
    返回值
    类型：string[]

    Builder查看源码
    (共 13 行)    getHTMLOutputName

    获取指定模块生成的 HTML 模块名，如果模块无法生成 HTML，则返回原地址

    参数
    参数名说明类型
    name

    源模块名

    		string
    返回值
    类型：string

    Builder查看源码
    (共 18 行)    getInputName

    计算生成指定文件的源文件名，如果找不到则返回 undefined

    参数
    参数名说明类型
    name

    生成的文件名

    		string
    entries

    文件夹下的所有文件名

    		string[]
    返回值
    类型：string

    Builder查看源码
    (共 14 行)    isIgnored

    判断指定的路径是否被忽略

    参数
    参数名说明类型
    path

    要判断的绝对路径

    		string
    返回值
    类型：boolean

    Builder查看源码
    (共 7 行)    loadPlugin保护

    载入一个插件

    参数
    参数名说明类型
    name

    要载入的插件名

    		string
    返回值
    类型：any

    Builder查看源码
    (共 126 行)    loadAsset异步保护

    生成指定的资源

    参数
    参数名说明类型
    url

    资源的内部路径，如 components/ui/button

    		string
    返回值
    类型：Promise<Asset>

    Builder查看源码
    (共 24 行)    buildAsset异步保护

    构建指定地址对应的文件

    参数
    参数名说明类型
    url

    要构建的地址

    		string
    返回值
    类型：Promise<Asset>

    Builder查看源码
    (共 57 行)    buildModule异步保护

    构建指定地址对应的模块

    参数
    参数名说明类型
    url

    要构建的地址

    		string
    返回值
    类型：Promise<Asset>

    Builder查看源码
    (共 17 行)    getGeneratedURLs异步生成器保护

    获取动态生成的所有文件的地址

    返回值
    类型：AsyncGenerator<string, void, undefined>

    查看源码
    (共 13 行)    DevServerOptions 接口

    表示开发服务器的选项

    继承：BuilderOptions

    属性

    属性名说明类型
    devServer

    服务器的选项

    展开子属性
    • url: string | number — 服务器的根地址或端口
    • open: string | false | true — 是否在首次启动时打开浏览器
    • openURL: string — 首次启动时打开的地址
    • headers: {[name: string]: string} — 附加的响应头内容
    • routers: WebServerRouter[] — 响应请求的路由规则
    • rootDir: string — 当前服务器的根目录
    • directoryList: boolean — 是否自动列出文件
    • defaultPages: string[] — 默认首页
    • mimeTypes: {[ext: string]: string | false} — 所有自定义扩展名（含点）到 MIME 类型的映射表
    • fs: FileSystem — 使用的文件系统
    • https: boolean — 是否启用加密传输协议
    • http2: boolean — 是否启用 HTTP/2 协议
    • maxAllowedContentLength: number — 允许请求的最大字节数
    • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
    • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
    • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
    • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
    • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
    • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
    • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
    • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
    • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
    • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • pem: string | Buffer — Private keys in PEM format.
      • passphrase: string — Optional passphrase.
    • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
    • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
    • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
    • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
    • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
    • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
      • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
      • passphrase: string — Optional passphrase.
    • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
    • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
    • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
    • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information. 48-bytes of cryptographically strong pseudo-random data.
    • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
    • handshakeTimeout: number — Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).
    • pskCallback: typeof pskCallback
    • pskIdentityHint: string — hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.
    • secureContext — An optional TLS context object from tls.createSecureContext()
      • context: any
    • enableTrace: boolean — When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.
    • requestCert: boolean — If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
    • ALPNProtocols: string[] | Uint8Array | Uint8Array[] — An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
    • SNICallback: (servername: string, cb: function(err: Error, ctx: SecureContext) => void) => void — SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
    • rejectUnauthorized: boolean — If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
    • IncomingMessage: typeof IncomingMessage
    • ServerResponse: typeof ServerResponse
    • maxHeaderSize: number — Optionally overrides the value of [--max-http-header-size][] for requests received by this server, i.e. the maximum length of request headers in bytes.
    • insecureHTTPParser: boolean — Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.
    • allowHTTP1: boolean
    • origins: string[]
    • Http1IncomingMessage: typeof IncomingMessage
    • Http1ServerResponse: typeof ServerResponse
    • Http2ServerRequest: typeof Http2ServerRequest
    • Http2ServerResponse: typeof Http2ServerResponse
    • maxDeflateDynamicTableSize: number
    • maxSessionMemory: number
    • maxHeaderListPairs: number
    • maxOutstandingPings: number
    • maxSendHeaderBlockLength: number
    • paddingStrategy: number
    • peerMaxConcurrentStreams: number
    • settings
      • headerTableSize: number
      • enablePush: boolean
      • initialWindowSize: number
      • maxFrameSize: number
      • maxConcurrentStreams: number
      • maxHeaderListSize: number
      • enableConnectProtocol: boolean
    • selectPadding: typeof selectPadding
    • createConnection: typeof createConnection
    • apis: {[name: string]: function(request: HTTPRequest, response: HTTPResponse, server: DevServer) => void} — 自定义服务器接口
    • liveReload — 是否开启实时刷新
      • version: number — 实时刷新协议的版本
      • url — 服务端的监听地址
        • auth: string
        • hash: string
        • host: string
        • hostname: string
        • href: string
        • pathname: string
        • protocol: string
        • search: string
        • slashes: boolean
        • port: string | number
        • query: string | ParsedUrlQueryInput
      • port: string | number — 服务器的监听端口
      • server: Server | Server — 已存在的服务器
      • liveCSS: boolean — 是否启用 CSS 实时刷新
      • liveImage: boolean — 是否启用图片实时刷新
      • originalPath: string — 所有请求路径对应的原始路径
      • overrideURL: string — 指定浏览器的地址
      • path: string — 服务器的路径
      • backlog: number — 允许的最大连接数
      • verify: function(request: IncomingMessage, socket: Socket, server: WebSocketServer) => false | true | Promise<boolean> — 验证是否允许指定的客户端连接
      • selectProtocol: function(protocols: string[]) => string — 选择合适的子协议
      • maxBufferSize: number — 允许远程发送的每个数据块的最大字节数
      • extension: WebSocketExtension — WebSocket 扩展
      • ca: string | Buffer | (string | Buffer)[] — Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
      • cert: string | Buffer | (string | Buffer)[] — Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
      • sigalgs: string — Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
      • ciphers: string — Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
      • clientCertEngine: string — Name of an OpenSSL engine which can provide the client certificate.
      • crl: string | Buffer | (string | Buffer)[] — PEM formatted CRLs (Certificate Revocation Lists).
      • dhparam: string | Buffer — Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
      • ecdhCurve: string — A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
      • honorCipherOrder: boolean — Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
      • key — Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
        • pem: string | Buffer — Private keys in PEM format.
        • passphrase: string — Optional passphrase.
      • privateKeyEngine: string — Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
      • privateKeyIdentifier: string — Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
      • maxVersion: SecureVersion — Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
      • minVersion: SecureVersion — Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
      • passphrase: string — Shared passphrase used for a single private key and/or a PFX.
      • pfx — PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
        • buf: string | Buffer — PFX or PKCS12 encoded private key and certificate chain.
        • passphrase: string — Optional passphrase.
      • secureOptions: number — Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
      • secureProtocol: string — Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
      • sessionIdContext: string — Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
      • ticketKeys: Buffer — 48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information. 48-bytes of cryptographically strong pseudo-random data.
      • sessionTimeout: number — The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
      • handshakeTimeout: number — Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).
      • pskCallback: typeof pskCallback
      • pskIdentityHint: string — hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.
      • secureContext — An optional TLS context object from tls.createSecureContext()
        • context: any
      • enableTrace: boolean — When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.
      • requestCert: boolean — If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
      • ALPNProtocols: string[] | Uint8Array | Uint8Array[] — An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
      • SNICallback: function(servername: string, cb: function(err: Error, ctx: SecureContext) => void) => void — SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
      • rejectUnauthorized: boolean — If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
      • IncomingMessage: typeof IncomingMessage
      • ServerResponse: typeof ServerResponse
      • maxHeaderSize: number — Optionally overrides the value of [--max-http-header-size][] for requests received by this server, i.e. the maximum length of request headers in bytes.
      • insecureHTTPParser: boolean — Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.
      • delay: number — 延时刷新的等待时间（毫秒）
    		WebServerOptions & {apis?: {[name: string]: function(request: HTTPRequest, response: HTTPResponse, server: DevServer) => void} // 自定义服务器接口liveReload?: false | true | LiveReloadServerOptions & {delay?: number // 延时刷新的等待时间（毫秒）} // 是否开启实时刷新}
    继承自 BuilderOptions 接口的属性
    属性名说明类型
    baseDir

    配置文件中所有路径的基路径

    		string
    ignore

    监听和生成的忽略列表

    		Pattern
    srcDir

    存放源码的文件夹路径

    		string
    outDir

    构建生成的文件夹路径

    		string
    assetsDir

    静态资源文件夹路径

    		string
    homePageName

    设置项目主页文件名

    示例
    "README"
    		string
    mainFileName

    设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言

    		string
    outDefaultFile

    设置输出的默认文件名

    		string
    noExtension

    设置输出 HTML 文件名时删除扩展名

    		boolean
    fs

    使用的文件系统

    		FileSystem
    locale

    使用的语言（如 en-US）

    		string
    compilers

    自定义编译器列表

    		Compiler[]
    logger

    日志记录器的选项

    展开子属性
    • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
    • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
    • colors: boolean — 是否打印带颜色控制符的日志
    • emoji: boolean — 是否打印图形表情
    • timestamp: boolean — 是否打印时间戳
    • fullPath: boolean — 是否打印完整绝对路径
    • baseDir: string — 打印相对路径时使用的基路径
    • codeFrame: boolean — 是否打印代码片段
    • persistent: boolean — 是否禁止清屏
    • progress: boolean — 是否打印进度条
    • spinnerFrames: string[] — 进度指示器的所有桢
    • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
    • hideCursor: boolean — 是否需要隐藏控制台光标
    • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
    • successIcon: string — 在成功日志前追加的前缀
    • warningIcon: string — 在警告日志前追加的前缀
    • errorIcon: string — 在错误日志前追加的前缀
    • fatalIcon: string — 在致命错误日志前追加的前缀
    		LoggerOptions
    sourceMap

    开发时是否启用源映射

    		boolean
    sourceMapRoot

    源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径

    		string
    optimize

    发布时是否优化生成的代码

    		boolean
    ts

    内置 TypeScript 编译器的附加选项

    		any
    sass

    内置 Sass 编译器的附加选项

    		any
    less

    内置 Less 编译器的附加选项

    		any
    webpack

    内置 Webpack 编译器的附加选项

    		any
    md

    内置 Markdown 编译器的附加选项

    		any
    doc

    内置文档编译器的附加选项

    展开子属性
    • baseURL: string — 生成的页面中引用资源的根地址
    • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
    • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
    • version: string — 项目版本
    • versions: array — 其它版本链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • navbar: array — 顶部导航条链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • children: array — 子菜单
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
    • footer: array — 底部链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • copyright: string — 底部版权声明
    • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
    • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
    • backToTop: boolean — 是否插入返回顶部链接
    • introDescription: string — 项目描述
    • introButtons: array — 项目描述后的按钮
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • features: array — 项目优势说明链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
      • description: string — 描述文案
    • links: array — 友情链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
    • support — 支持/赞助链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • packageName: string — 发布的包名
    • repository: string — 项目仓库地址(HTTPS 协议)
    • repositoryPath: string — 项目根目录在仓库中的路径
    • branch: string — 项目仓库分支
    • readCommits: (files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    		DocCompilerOptions
    modules

    配置供代码加载的内置模块

    		{[name: string]: string}
    build

    一次性构建时额外设置的选项

    展开子属性
    • baseDir: string — 配置文件中所有路径的基路径
    • ignore: Pattern — 监听和生成的忽略列表
    • srcDir: string — 存放源码的文件夹路径
    • outDir: string — 构建生成的文件夹路径
    • assetsDir: string — 静态资源文件夹路径
    • homePageName: string — 设置项目主页文件名
    • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
    • outDefaultFile: string — 设置输出的默认文件名
    • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
    • fs: FileSystem — 使用的文件系统
    • locale: string — 使用的语言（如 en-US）
    • compilers: Compiler[] — 自定义编译器列表
    • logger — 日志记录器的选项
      • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
      • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
      • colors: boolean — 是否打印带颜色控制符的日志
      • emoji: boolean — 是否打印图形表情
      • timestamp: boolean — 是否打印时间戳
      • fullPath: boolean — 是否打印完整绝对路径
      • baseDir: string — 打印相对路径时使用的基路径
      • codeFrame: boolean — 是否打印代码片段
      • persistent: boolean — 是否禁止清屏
      • progress: boolean — 是否打印进度条
      • spinnerFrames: string[] — 进度指示器的所有桢
      • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
      • hideCursor: boolean — 是否需要隐藏控制台光标
      • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
      • successIcon: string — 在成功日志前追加的前缀
      • warningIcon: string — 在警告日志前追加的前缀
      • errorIcon: string — 在错误日志前追加的前缀
      • fatalIcon: string — 在致命错误日志前追加的前缀
    • sourceMap: boolean — 开发时是否启用源映射
    • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
    • optimize: boolean — 发布时是否优化生成的代码
    • ts: any — 内置 TypeScript 编译器的附加选项
    • sass: any — 内置 Sass 编译器的附加选项
    • less: any — 内置 Less 编译器的附加选项
    • webpack: any — 内置 Webpack 编译器的附加选项
    • md: any — 内置 Markdown 编译器的附加选项
    • doc — 内置文档编译器的附加选项
      • baseURL: string — 生成的页面中引用资源的根地址
      • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
      • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
      • version: string — 项目版本
      • versions: array — 其它版本链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • navbar: array — 顶部导航条链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • children: array — 子菜单
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
      • footer: array — 底部链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • copyright: string — 底部版权声明
      • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
      • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
      • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
      • backToTop: boolean — 是否插入返回顶部链接
      • introDescription: string — 项目描述
      • introButtons: array — 项目描述后的按钮
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • features: array — 项目优势说明链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
        • description: string — 描述文案
      • links: array — 友情链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
      • support — 支持/赞助链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • packageName: string — 发布的包名
      • repository: string — 项目仓库地址(HTTPS 协议)
      • repositoryPath: string — 项目根目录在仓库中的路径
      • branch: string — 项目仓库分支
      • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    • modules: {[name: string]: string} — 配置供代码加载的内置模块
    • build: (Circular)BuilderOptions — 一次性构建时额外设置的选项
    • plugins: (string | BuilderPlugin)[] — 所有附加插件
    		BuilderOptions
    plugins

    所有附加插件

    		(string | BuilderPlugin)[]

    查看源码
    (共 5 行)    ExtendedAsset 接口

    表示扩展的资源

    继承：Asset

    属性

    属性名说明类型
    hash(可选)

    资源的哈希值

    		string
    继承自 Asset 接口的属性
    属性名说明类型
    type

    资源的类型

    		AssetType
    content(可选)

    资源的内容，可以是文件的内容或重定向的地址

    		string | Buffer
    sourceMap(可选)

    如果当前资源存在源映射，则为关联的源映射资源

    展开子属性
    • type: AssetType — 资源的类型
    • content: string | Buffer — 资源的内容，可以是文件的内容或重定向的地址
    • sourceMap: (Circular)Asset — 如果当前资源存在源映射，则为关联的源映射资源
    • errors: array — 构建时产生的所有错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建
    		Asset
    errors(可选)

    构建时产生的所有错误

    展开子属性
    • source: string — 日志的来源
    • message: string — 日志的信息
    • fileName: string — 日志相关的文件名
    • line: number — 日志相关的行号（从 0 开始）
    • column: number — 日志相关的列号（从 0 开始）
    • endLine: number — 日志相关的结束行号（从 0 开始）
    • endColumn: number — 日志相关的结束列号（从 0 开始）
    • detail: string — 日志的详情
    • codeFrame: string — 日志相关的源代码片段
    • stack: string — 错误堆栈信息
    		LogEntry[]
    dependencies(可选)

    构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建

    		(string | DependencyCallback)[]

    查看源码
    (共 4 行)    version

    读取当前程序的版本号

    返回值
    类型：any

    查看源码
    (共 87 行)    BuilderOptions 接口

    表示构建器的选项

    属性

    属性名说明类型
    baseDir

    配置文件中所有路径的基路径

    		string
    ignore

    监听和生成的忽略列表

    		Pattern
    srcDir

    存放源码的文件夹路径

    		string
    outDir

    构建生成的文件夹路径

    		string
    assetsDir

    静态资源文件夹路径

    		string
    homePageName

    设置项目主页文件名

    示例
    "README"
    		string
    mainFileName

    设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言

    		string
    outDefaultFile

    设置输出的默认文件名

    		string
    noExtension

    设置输出 HTML 文件名时删除扩展名

    		boolean
    fs

    使用的文件系统

    		FileSystem
    locale

    使用的语言（如 en-US）

    		string
    compilers

    自定义编译器列表

    		Compiler[]
    logger

    日志记录器的选项

    展开子属性
    • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
    • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
    • colors: boolean — 是否打印带颜色控制符的日志
    • emoji: boolean — 是否打印图形表情
    • timestamp: boolean — 是否打印时间戳
    • fullPath: boolean — 是否打印完整绝对路径
    • baseDir: string — 打印相对路径时使用的基路径
    • codeFrame: boolean — 是否打印代码片段
    • persistent: boolean — 是否禁止清屏
    • progress: boolean — 是否打印进度条
    • spinnerFrames: string[] — 进度指示器的所有桢
    • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
    • hideCursor: boolean — 是否需要隐藏控制台光标
    • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
    • successIcon: string — 在成功日志前追加的前缀
    • warningIcon: string — 在警告日志前追加的前缀
    • errorIcon: string — 在错误日志前追加的前缀
    • fatalIcon: string — 在致命错误日志前追加的前缀
    		LoggerOptions
    sourceMap

    开发时是否启用源映射

    		boolean
    sourceMapRoot

    源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径

    		string
    optimize

    发布时是否优化生成的代码

    		boolean
    ts

    内置 TypeScript 编译器的附加选项

    		any
    sass

    内置 Sass 编译器的附加选项

    		any
    less

    内置 Less 编译器的附加选项

    		any
    webpack

    内置 Webpack 编译器的附加选项

    		any
    md

    内置 Markdown 编译器的附加选项

    		any
    doc

    内置文档编译器的附加选项

    展开子属性
    • baseURL: string — 生成的页面中引用资源的根地址
    • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
    • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
    • version: string — 项目版本
    • versions: array — 其它版本链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • navbar: array — 顶部导航条链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • children: array — 子菜单
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
    • footer: array — 底部链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • copyright: string — 底部版权声明
    • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
    • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
    • backToTop: boolean — 是否插入返回顶部链接
    • introDescription: string — 项目描述
    • introButtons: array — 项目描述后的按钮
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • features: array — 项目优势说明链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
      • description: string — 描述文案
    • links: array — 友情链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
    • support — 支持/赞助链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • packageName: string — 发布的包名
    • repository: string — 项目仓库地址(HTTPS 协议)
    • repositoryPath: string — 项目根目录在仓库中的路径
    • branch: string — 项目仓库分支
    • readCommits: (files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    		DocCompilerOptions
    modules

    配置供代码加载的内置模块

    		{[name: string]: string}
    build

    一次性构建时额外设置的选项

    展开子属性
    • baseDir: string — 配置文件中所有路径的基路径
    • ignore: Pattern — 监听和生成的忽略列表
    • srcDir: string — 存放源码的文件夹路径
    • outDir: string — 构建生成的文件夹路径
    • assetsDir: string — 静态资源文件夹路径
    • homePageName: string — 设置项目主页文件名
    • mainFileName: string — 设置文件夹的主文件名（不含扩展名），其中 <dir> 表示文件夹名本身，<locale> 表示当前语言
    • outDefaultFile: string — 设置输出的默认文件名
    • noExtension: boolean — 设置输出 HTML 文件名时删除扩展名
    • fs: FileSystem — 使用的文件系统
    • locale: string — 使用的语言（如 en-US）
    • compilers: Compiler[] — 自定义编译器列表
    • logger — 日志记录器的选项
      • logLevel: "error" | "warning" | LogLevel.trace | ... 12 more ...LogLevel.debug | LogLevel.log | LogLevel.info | LogLevel.success | LogLevel.warning | LogLevel.error | LogLevel.fatal | LogLevel.silent | "trace" | "debug" | "log" | "info" | "fatal" | "silent" — 允许打印的最低日志等级
      • ignore: RegExp | (function(log: string | Error | LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean) — 判断是否忽略指定日志的正则表达式或回调函数
      • colors: boolean — 是否打印带颜色控制符的日志
      • emoji: boolean — 是否打印图形表情
      • timestamp: boolean — 是否打印时间戳
      • fullPath: boolean — 是否打印完整绝对路径
      • baseDir: string — 打印相对路径时使用的基路径
      • codeFrame: boolean — 是否打印代码片段
      • persistent: boolean — 是否禁止清屏
      • progress: boolean — 是否打印进度条
      • spinnerFrames: string[] — 进度指示器的所有桢
      • spinnerInterval: number — 进度指示器自动切换桢的毫秒数
      • hideCursor: boolean — 是否需要隐藏控制台光标
      • errorOrWarningCounter: number | false — 在错误或警告前追加的起始编号，设为 false 则不追加编号
      • successIcon: string — 在成功日志前追加的前缀
      • warningIcon: string — 在警告日志前追加的前缀
      • errorIcon: string — 在错误日志前追加的前缀
      • fatalIcon: string — 在致命错误日志前追加的前缀
    • sourceMap: boolean — 开发时是否启用源映射
    • sourceMapRoot: string — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径
    • optimize: boolean — 发布时是否优化生成的代码
    • ts: any — 内置 TypeScript 编译器的附加选项
    • sass: any — 内置 Sass 编译器的附加选项
    • less: any — 内置 Less 编译器的附加选项
    • webpack: any — 内置 Webpack 编译器的附加选项
    • md: any — 内置 Markdown 编译器的附加选项
    • doc — 内置文档编译器的附加选项
      • baseURL: string — 生成的页面中引用资源的根地址
      • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
      • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
      • version: string — 项目版本
      • versions: array — 其它版本链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • navbar: array — 顶部导航条链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • children: array — 子菜单
          • label: string — 链接文案
          • href: string — 链接地址
          • title: string — 鼠标悬停时的工具提示
      • footer: array — 底部链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • copyright: string — 底部版权声明
      • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
      • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
      • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
      • backToTop: boolean — 是否插入返回顶部链接
      • introDescription: string — 项目描述
      • introButtons: array — 项目描述后的按钮
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • features: array — 项目优势说明链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
        • description: string — 描述文案
      • links: array — 友情链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
        • icon: string — 图标
      • support — 支持/赞助链接
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
      • packageName: string — 发布的包名
      • repository: string — 项目仓库地址(HTTPS 协议)
      • repositoryPath: string — 项目根目录在仓库中的路径
      • branch: string — 项目仓库分支
      • readCommits: function(files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    • modules: {[name: string]: string} — 配置供代码加载的内置模块
    • build: (Circular)BuilderOptions — 一次性构建时额外设置的选项
    • plugins: (string | BuilderPlugin)[] — 所有附加插件
    		BuilderOptions
    plugins

    所有附加插件

    		(string | BuilderPlugin)[]

    查看源码
    (共 18 行)    Compiler 接口

    表示一个编译器

    属性

    属性名说明类型
    inExts

    输入的文件扩展名(含点)

    		string[]
    outExt

    输出的文件扩展名(含点)

    		string
    use(可选)

    编译器的源路径

    		string

    方法

    Compiler查看源码
    (共 9 行)    compile(可选)

    编译指定的模块

    参数
    参数名说明类型
    content

    模块的源内容

    		string
    path

    模块的源绝对路径

    		string
    outPath

    生成的目标绝对路径

    		string
    builder

    当前的构建器对象

    		Builder
    返回值
    类型：CompileResult | Promise<CompileResult>

    返回编译的结果对象

    查看源码
    (共 11 行)    CompileResult 接口

    表示编译结果

    属性

    属性名说明类型
    content

    生成的内容

    		string | Buffer
    sourceMap

    生成的源映射

    		string | Buffer
    errors

    生成时产生的错误

    展开子属性
    • source: string — 日志的来源
    • message: string — 日志的信息
    • fileName: string — 日志相关的文件名
    • line: number — 日志相关的行号（从 0 开始）
    • column: number — 日志相关的列号（从 0 开始）
    • endLine: number — 日志相关的结束行号（从 0 开始）
    • endColumn: number — 日志相关的结束列号（从 0 开始）
    • detail: string — 日志的详情
    • codeFrame: string — 日志相关的源代码片段
    • stack: string — 错误堆栈信息
    		LogEntry[]
    dependencies

    生成所依赖的文件路径，当任一依赖变化后需要重新生成

    		(string | DependencyCallback)[]

    查看源码
    (共 6 行)    DependencyCallback 类型

    表示检测依赖的回调函数

    同：(path: string, updateType: AssetUpdateType) => boolean

    查看源码
    (共 2 行)    BuilderPlugin 类型

    表示一个构建器插件

    同：(builder: Builder) => void

    查看源码
    (共 13 行)    Asset 接口

    表示一个资源

    属性

    属性名说明类型
    type

    资源的类型

    		AssetType
    content(可选)

    资源的内容，可以是文件的内容或重定向的地址

    		string | Buffer
    sourceMap(可选)

    如果当前资源存在源映射，则为关联的源映射资源

    展开子属性
    • type: AssetType — 资源的类型
    • content: string | Buffer — 资源的内容，可以是文件的内容或重定向的地址
    • sourceMap: (Circular)Asset — 如果当前资源存在源映射，则为关联的源映射资源
    • errors: array — 构建时产生的所有错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建
    		Asset
    errors(可选)

    构建时产生的所有错误

    展开子属性
    • source: string — 日志的来源
    • message: string — 日志的信息
    • fileName: string — 日志相关的文件名
    • line: number — 日志相关的行号（从 0 开始）
    • column: number — 日志相关的列号（从 0 开始）
    • endLine: number — 日志相关的结束行号（从 0 开始）
    • endColumn: number — 日志相关的结束列号（从 0 开始）
    • detail: string — 日志的详情
    • codeFrame: string — 日志相关的源代码片段
    • stack: string — 错误堆栈信息
    		LogEntry[]
    dependencies(可选)

    构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建

    		(string | DependencyCallback)[]

    查看源码
    (共 9 行)    AssetType 枚举只读

    表示资源的类型

    成员

    枚举名说明值
    notFound

    资源不存在

    		0
    file

    当前资源是一个文件

    		1
    redirect

    当前资源需要外部重定向到另一个资源

    		2

    查看源码
    (共 9 行)    AssetUpdateType 枚举只读

    表示资源更新的类型

    成员

    枚举名说明值
    created

    资源被创建

    		0
    changed

    资源被修改

    		1
    deleted

    资源被删除

    		2