request.jsdoc 794 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. /**
  2. * 继承 koa 的 Request
  3. * @class Request
  4. * @see http://koajs.com/#request
  5. */
  6. // 文档注释
  7. /**
  8. * Request header
  9. * @member {Object} Request#header
  10. */
  11. /**
  12. * Request headers
  13. * @member {Object} Request#headers
  14. */
  15. /**
  16. * Request HTTP Method, 比如: GET, POST, PATCH, PUT, DELETE
  17. * @member {String} Request#method
  18. */
  19. /**
  20. * 完整的请求 URL 地址
  21. * @member {String} Request#url
  22. */
  23. /**
  24. * 完整的请求 URL 地址
  25. * @member {String} Request#originalUrl
  26. */
  27. /**
  28. * 完整的请求 URL 地址,的路径部分(不包含域名)
  29. * @member {String} Request#path
  30. */
  31. /**
  32. * 请求的 GET 参数
  33. * @member {String} Request#querystring
  34. * @example
  35. * GET http://127.0.0.1:7001?name=Foo&age=20
  36. * ```js
  37. * this.request.querystring
  38. * => 'name=Foo&age=20'
  39. * ```
  40. */