aboutsummaryrefslogtreecommitdiff
path: root/node_modules/cookiejar/readme.md
diff options
context:
space:
mode:
authorAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
committerAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
commit29433e2f7dbd0e4a73d3c78ffe1005b922fb5982 (patch)
treeaa0ad3fe59468cbe452ee597e914839b68c01436 /node_modules/cookiejar/readme.md
parent878fefb4c4e1f12b804ae5c0def433fa873f4c8b (diff)
downloadAleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.gz
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.bz2
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.zip
Don't mind me i'm adding the discord.js files
Diffstat (limited to 'node_modules/cookiejar/readme.md')
-rw-r--r--node_modules/cookiejar/readme.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/node_modules/cookiejar/readme.md b/node_modules/cookiejar/readme.md
new file mode 100644
index 0000000..3d39ec6
--- /dev/null
+++ b/node_modules/cookiejar/readme.md
@@ -0,0 +1,57 @@
+#CookieJar
+
+Simple robust cookie library
+
+##Exports
+
+###CookieAccessInfo(domain,path,secure,script)
+
+ class to determine matching qualities of a cookie
+
+#####Properties
+
+* String domain - domain to match
+* String path - path to match
+* Boolean secure - access is secure (ssl generally)
+* Boolean script - access is from a script
+
+
+###Cookie(cookiestr_or_cookie, request_domain, request_path)
+
+ turns input into a Cookie (singleton if given a Cookie)
+ the `request_domain` argument is used to default the domain if it is not explicit in the cookie string
+ the `request_path` argument is used to set the path if it is not explicit in a cookie String.
+
+ explicit domains/paths will cascade, implied domains/paths must *exactly* match (see http://en.wikipedia.org/wiki/HTTP_cookie#Domain_and_Pat)
+
+#####Properties
+
+* String name - name of the cookie
+* String value - string associated with the cookie
+* String domain - domain to match (on a cookie a '.' at the start means a wildcard matching anything ending in the rest)
+* Boolean explicit_domain - if the domain was explicitly set via the cookie string
+* String path - base path to match (matches any path starting with this '/' is root)
+* Boolean explicit_path - if the path was explicitly set via the cookie string
+* Boolean noscript - if it should be kept from scripts
+* Boolean secure - should it only be transmitted over secure means
+* Number expiration_date - number of millis since 1970 at which this should be removed
+
+#####Methods
+
+* String toString() - the __set-cookie:__ string for this cookie
+* String toValueString() - the __cookie:__ string for this cookie
+* Cookie parse(cookiestr, request_domain, request_path) - parses the string onto this cookie or a new one if called directly
+* Boolean matches(access_info) - returns true if the access_info allows retrieval of this cookie
+* Boolean collidesWith(cookie) - returns true if the cookies cannot exist in the same space (domain and path match)
+
+
+###CookieJar()
+
+ class to hold numerous cookies from multiple domains correctly
+
+#####Methods
+
+* Cookie setCookie(cookie, request_domain, request_path) - add a cookie to the jar
+* Cookie[] setCookies(cookiestr_or_list, request_domain, request_path) - add a large number of cookies to the jar
+* Cookie getCookie(cookie_name,access_info) - get a cookie with the name and access_info matching
+* Cookie[] getCookies(access_info) - grab all cookies matching this access_info