Skip to content

Commit

Permalink
Remove argument types from API docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lukechilds committed Jan 7, 2017
1 parent 0f5a5a8 commit a4f347c
Showing 1 changed file with 0 additions and 32 deletions.
32 changes: 0 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit a4f347c

Please sign in to comment.