Browse Source

Remove argument types from API docs

They're already mentioned in the usage section. It's pretty obvious and I don't think it's worth the amount of bloat they add.
pull/7/head
Luke Childs 8 years ago
parent
commit
b57b7af0c9
  1. 32
      README.md

32
README.md

@ -93,46 +93,14 @@ expired.on(headers)
Returns a boolean relating to whether the resource has expired or not. `true` means it's expired, `false` means it's fresh.
#### headers
Type: `string`, `object`<br>
String or object containing HTTP headers.
#### date
Type: `Date`<br>
Default: `new Date()`
Optional `Date` object to compare against.
### expired.in(headers, [date])
Returns the amount of milliseconds from the current date until the resource will expire. If the resource has already expired it will return a negative integer.
#### headers
Type: `string`, `object`<br>
String or object containing HTTP headers.
#### date
Type: `Date`<br>
Default: `new Date()`
Optional `Date` object to compare against.
### expired.on(headers)
Returns a JavaScript `Date` object for the date the resource will expire.
#### headers
Type: `string`, `object`<br>
String or object containing HTTP headers.
## License
MIT © Luke Childs

Loading…
Cancel
Save