如何阅读visual studio代码intellisense语法提示,为运营商提供任何文档?

时间:2017-11-06 01:14:46

标签: node.js visual-studio

像VS一样的VSC提供了语法/签名提示。我了解表示数据类型

myText: string  // : means datatype of myText is string
myStuff: any    // any means can be any data type.

有时很难猜出运算符的含义,例如Node的请求(), enter image description here

我的理解是

  1. const request表示我可以定义任何变量,例如const x=request(...)var x=request(...)
  2. request.RequestAPI表示它是一个API调用。
  3. options:定义此参数是{...}
  4. 形式的典型对象选项
  5. (request.UriOptions & request.CoreOptions)我理解开头和结尾部分,它们必须是Uri和Core的枚举,但是&是什么?这是否意味着我需要同时提供Uri AND Core?
  6. |此管道的意思是 OR ?如果是,则它会在管道之前复制零件。
  7. callback?: request.RequestCallback,所以在这里我必须提供一个回调,它将被输入(或运行)为RequestCallback,但什么是?:
  8. 这些约定是否有任何文件?

1 个答案:

答案 0 :(得分:0)

我想发表评论,因为我不知道完整的答案,但这里有一些有用的信息:

您可能会看到DefinitelyTyped的定义:https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/request/index.d.ts#L29

请查看此内容以了解定义文件语法:http://www.typescriptlang.org/docs/handbook/declaration-files/by-example.html

你可以解释这样的定义:

const request:有一个名为 request 的常量,它实现了接口request.RequestAPI(也可以直接调用,然后为此)接受options类型的参数(request.UriOptions & request.CoreOptions) | (request.UrlOptions & request.CoreOptions)和可选参数callback(因此类型为?的{​​{1}}。函数返回request.RequestCallback

  • request.Request通常表示
  • 管道&通常表示,没有重复 URI vs 网址
  • |"返回"
  • 您在所有内容前面看到=>,因为它是命名空间(我的措辞可能在此处)

requestUriOptionsUrlOptions的定义被埋没了一点。我不是节点用户,所以我不知道你可以传递什么请求。 例如,CoreOptions可以是名为&#34的字符串参数; url"或UrlOptions(来自url)。见https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/request/index.d.ts#L162