Skip to content

Commit fdc507f

Browse files
committed
chore(HyperRequest): Add missing docblocks
1 parent 8d3c169 commit fdc507f

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

models/HyperRequest.cfc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ component accessors="true" {
8383

8484
/**
8585
* The format to serialize the body.
86-
* e.g. `json` or `formFields`
86+
* e.g. `json`, `formFields`, or `xml`
8787
*/
8888
property name="bodyFormat" default="json";
8989

@@ -914,6 +914,12 @@ component accessors="true" {
914914
return this;
915915
}
916916

917+
/**
918+
* Send the HTTP request asynchronously and return a ColdBox Future that resolves to a HyperResponse
919+
*
920+
* @throws MissingAsyncManager
921+
* @returns Future< HyperResponse >
922+
*/
917923
function sendAsync() {
918924
if ( isNull( variables.asyncManager ) ) {
919925
throw( type = "MissingAsyncManager", message = "No asyncManager set!" );
@@ -1166,6 +1172,11 @@ component accessors="true" {
11661172
return getBodyFormat() == "json" ? serializeJSON( getBody() ) : getBody();
11671173
}
11681174

1175+
/**
1176+
* Returns a struct representing this HyperRequest.
1177+
*
1178+
* @return struct
1179+
*/
11691180
public struct function getMemento() {
11701181
return {
11711182
"requestID" : getRequestID(),

tests/specs/unit/HyperRequestSpec.cfc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ component extends="testbox.system.BaseSpec" {
2424
"files" : variables.req.getFiles(),
2525
"bodyFormat" : variables.req.getBodyFormat(),
2626
"body" : variables.req.getBody(),
27-
"referrer" : "",
27+
"referrerId" : "",
2828
"throwOnError" : variables.req.getThrowOnError(),
2929
"timeout" : variables.req.getTimeout(),
3030
"maximumRedirects" : variables.req.getMaximumRedirects(),

0 commit comments

Comments
 (0)