Skip to content

Commit 623c499

Browse files
committed
Makes it clear the xOptions object is only accessible in the arguments of the success callbacks as of 2.4.0.
1 parent 3aa6ba9 commit 623c499

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Lifetime of this cache is page-based which means it gets erased at each page rel
125125

126126
#### success - `function` (`undefined`)
127127

128-
A function to be called if the request succeeds. The function gets passed three arguments: The JSON object returned from the server, a string describing the status (always `"success"`) and the `xOptions` object.
128+
A function to be called if the request succeeds. The function gets passed three arguments: The JSON object returned from the server, a string describing the status (always `"success"`) and, *_as of version 2.4.0_* the `xOptions` object.
129129

130130
```js
131131
function (json, textStatus, xOptions) {

0 commit comments

Comments
 (0)