keinBot/flumm-fetch-cookies
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme: rename parameters according to source

Browse Source
This commit is contained in:
jkhsjdhjs 2019-11-28 20:45:19 +01:00
parent e79b3a0237
commit 2b1c15c64b
Signed by: jkhsjdhjs
GPG Key ID: BAC6ADBAB7D576CC
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -95,7 +95,7 @@ Returns an iterator over all valid (non-expired) cookies.
#### *cookiesAll() #### *cookiesAll()
Returns an iterator over all cookies currently stored. Returns an iterator over all cookies currently stored.
#### *cookiesValidForRequest(url) #### *cookiesValidForRequest(requestURL)
Returns an iterator over all cookies valid for a request to `url`. Returns an iterator over all cookies valid for a request to `url`.
#### deleteExpired(sessionEnded) #### deleteExpired(sessionEnded)
@ -122,7 +122,7 @@ An abstract representation of a cookie.
- `secure` A boolean value representing the cookie's secure attribute. If set the cookie will only be used for `https` requests. - `secure` A boolean value representing the cookie's secure attribute. If set the cookie will only be used for `https` requests.
- `subdomains` A boolean value specifying whether the cookie should be used for requests to subdomains of `domain` or not. - `subdomains` A boolean value specifying whether the cookie should be used for requests to subdomains of `domain` or not.
#### new Cookie(str, url) #### new Cookie(str, requestURL)
Creates a cookie instance from the string representation of a cookie as send by a webserver. Creates a cookie instance from the string representation of a cookie as send by a webserver.
- `str` The string representation of a cookie. - `str` The string representation of a cookie.
- `url` The url the cookie has been received from. - `url` The url the cookie has been received from.
@ -139,7 +139,7 @@ Serializes the cookie, transforming it to `name=value` so it can be used in requ
Returns whether the cookie has expired or not. Returns whether the cookie has expired or not.
- `sessionEnded`: A boolean that specifies whether the current session has ended, meaning if set to `true`, the function will return `true` for session cookies. - `sessionEnded`: A boolean that specifies whether the current session has ended, meaning if set to `true`, the function will return `true` for session cookies.
#### isValidForRequest(url) #### isValidForRequest(requestURL)
Returns whether the cookie is valid for a request to `url`. Returns whether the cookie is valid for a request to `url`.
### Class: CookieParseError ### Class: CookieParseError