TypeScript基础入门之Javascript文件类型检查(四)
栏目: JavaScript · 发布时间: 6年前
内容简介:继续上篇文章【@param使用与@type相同的类型语法,但添加了参数名称。 通过用方括号括起名称,也可以声明该参数是可选的:同样,对于函数的返回类型:
继续上篇文章【 TypeScript基础入门之Javascript文件类型检查(三) 】
@param 和 @returns
@param使用与@type相同的类型语法,但添加了参数名称。 通过用方括号括起名称,也可以声明该参数是可选的:
// Parameters may be declared in a variety of syntactic forms /** * @param {string} p1 - A string param. * @param {string=} p2 - An optional param (Closure syntax) * @param {string} [p3] - Another optional param (JSDoc syntax). * @param {string} [p4="test"] - An optional param with a default value * @return {string} This is the result */ function stringsStringStrings(p1, p2, p3, p4){ // TODO }
同样,对于函数的返回类型:
/** * @return {PromiseLike<string>} */ function ps(){} /** * @returns {{ a: string, b: number }} - May use '@returns' as well as '@return' */ function ab(){}
@typedef, @callback, 和 @param
@typedef可用于定义复杂类型。 类似的语法适用于@param。
/** * @typedef {Object} SpecialType - creates a new type named 'SpecialType' * @property {string} prop1 - a string property of SpecialType * @property {number} prop2 - a number property of SpecialType * @property {number=} prop3 - an optional number property of SpecialType * @prop {number} [prop4] - an optional number property of SpecialType * @prop {number} [prop5=42] - an optional number property of SpecialType with default */ /** @type {SpecialType} */ var specialTypeObject;
您可以在第一行使用对象或对象。
/** * @typedef {object} SpecialType1 - creates a new type named 'SpecialType' * @property {string} prop1 - a string property of SpecialType * @property {number} prop2 - a number property of SpecialType * @property {number=} prop3 - an optional number property of SpecialType */ /** @type {SpecialType1} */ var specialTypeObject1;
@param允许一次性类型规范使用类似的语法。 请注意,嵌套属性名称必须以参数名称为前缀:
/** * @param {Object} options - The shape is the same as SpecialType above * @param {string} options.prop1 * @param {number} options.prop2 * @param {number=} options.prop3 * @param {number} [options.prop4] * @param {number} [options.prop5=42] */ function special(options) { return (options.prop4 || 1001) + options.prop5; }
@callback类似于@typedef,但它指定了一个函数类型而不是一个对象类型:
/** * @callback Predicate * @param {string} data * @param {number} [index] * @returns {boolean} */ /** @type {Predicate} */ const ok = s => !(s.length % 2);
当然,任何这些类型都可以在单行@typedef中使用Typescript语法声明:
/** @typedef {{ prop1: string, prop2: string, prop3?: number }} SpecialType */ /** @typedef {(data: string, index?: number) => boolean} Predicate */
@template
您可以使用@template标记声明泛型类型:
/** * @template T * @param {T} p1 - A generic parameter that flows through to the return type * @return {T} */ function id(x){ return x }
使用逗号或多个标签声明多个类型参数:
/** * @template T,U,V * @template W,X */
您还可以在类型参数名称之前指定类型约束。 只限列表中的第一个类型参数:
/** * @template {string} K - K must be a string or string literal * @template {{ serious(): string }} Seriousalizable - must have a serious method * @param {K} key * @param {Seriousalizable} object */ function seriousalize(key, object) { // ???? }
未完待续...
以上所述就是小编给大家介绍的《TypeScript基础入门之Javascript文件类型检查(四)》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
猜你喜欢:- TypeScript基础入门之Javascript文件类型检查(一)
- TypeScript基础入门之Javascript文件类型检查(二)
- TypeScript基础入门之Javascript文件类型检查(三)
- TypeScript基础入门之Javascript文件类型检查(五)
- elasticsearch学习笔记(五)——快速入门案例实战电商网站商品管理:集群健康检查,文档的CRUD
- k8s与健康检查--grpc服务健康检查最佳实践
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。