Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

httpCRq and related class documentation incomplete #1620

Closed
SpenceKonde opened this issue Jun 13, 2018 · 2 comments
Closed

httpCRq and related class documentation incomplete #1620

SpenceKonde opened this issue Jun 13, 2018 · 2 comments

Comments

@SpenceKonde
Copy link

http://www.espruino.com/Reference#httpCRq

Lists 4 methods/fields - drain, end, error and write.

It apparently also has a headers field which is not mentioned in the reference. It seems likely that other fields of this and/or httpCRs/httpSRq/httpSRs may also be undocumented, as none of the others mention any facility for interacting with headers.

http://forum.espruino.com/conversations/321747/
@wilberforce
Copy link
Member

https://github.com/espruino/Espruino/blob/master/libs/network/http/jswrap_http.c#L284

@gfwilliams gfwilliams transferred this issue from espruino/EspruinoDocs Feb 21, 2019
@gfwilliams
Copy link
Member

This can now fixed by adding lines like:

/*JSON{
    "type" : "property",
    "class" : "httpCRs",
    "name" : "headers",
    "generate" : false,
    "return" : ["JsVar", "A map of header name -> value" ]
}
Some more info here
*//*Documentation only*/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@gfwilliams @wilberforce @SpenceKonde