Skip to content

Commit fa16d4a

Browse files
IamLizuljharb
andauthored
docs: clarify error behavior for parameter and array limit
Co-authored-by: Jordan Harband <[email protected]>
1 parent b5e89b7 commit fa16d4a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ var limited = qs.parse('a=b&c=d', { parameterLimit: 1 });
135135
assert.deepEqual(limited, { a: 'b' });
136136
```
137137

138-
If you want an error to be thrown whenever the parameter limit is exceeded, set the `throwOnLimitExceeded` option to `true`. This option will generate a descriptive error if the query string exceeds the parameterLimit.
138+
If you want an error to be thrown whenever the a limit is exceeded (eg, `parameterLimit`, `arrayLimit`), set the `throwOnLimitExceeded` option to `true`. This option will generate a descriptive error if the query string exceeds a configured limit.
139139
```javascript
140140
try {
141141
qs.parse('a=1&b=2&c=3&d=4', { parameterLimit: 3, throwOnLimitExceeded: true });

0 commit comments

Comments
 (0)