ubdate
This commit is contained in:
81
node_modules/last-run/README.md
generated
vendored
Normal file
81
node_modules/last-run/README.md
generated
vendored
Normal file
@@ -0,0 +1,81 @@
|
||||
<p align="center">
|
||||
<a href="http://gulpjs.com">
|
||||
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
# last-run
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
|
||||
|
||||
Capture and retrieve the last time a function was run.
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var lastRun = require('last-run');
|
||||
|
||||
function myFunc(){}
|
||||
|
||||
myFunc();
|
||||
// capture the run after (or before) calling the function
|
||||
lastRun.capture(myFunc);
|
||||
|
||||
// retrieve the last run time
|
||||
lastRun(myFunc);
|
||||
//-> outputs the Date.now() when capture was called
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
__Note: this module uses a WeakMap shim, and throws on non-extensible functions on platforms that
|
||||
don't have a native WeakMap implementation__
|
||||
|
||||
### lastRun(fn, [timeResolution]) => [Timestamp]
|
||||
|
||||
Takes a function (`fn`) and returns a timestamp of the last time the function was captured.
|
||||
|
||||
Returns undefined if the function has not been captured.
|
||||
|
||||
The timestamp is always given in millisecond but the time resolution can be reduced (rounded down).
|
||||
The use case is to be able to compare a build time to a file time attribute.
|
||||
On node v0.10 or with file system like HFS or FAT, `fs.stat` time attributes like `mtime` precision is one second.
|
||||
|
||||
Assuming `lastRun(fn)` returns 1426000001111, `lastRun(fn, 1000)` returns 1426000001000.
|
||||
|
||||
The default time resolution is 1000 on node v0.10, 0 on node 0.11+ and iojs.
|
||||
More information at [`default-resolution`][default-resolution] and
|
||||
[undertaker PR #17][undertaker-17].
|
||||
|
||||
### lastRun.capture(fn, [timestamp])
|
||||
|
||||
Takes a function (`fn`) and captures the current timestamp with `Date.now()`.
|
||||
If passed the optional timestamp, captures that time instead of `Date.now()`.
|
||||
The captured timestamp can then be retrieved using the `lastRun` function.
|
||||
|
||||
### lastRun.release(fn)
|
||||
|
||||
Takes a function (`fn`) and removes the last run timestamp for it.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
[default-resolution]: https://github.com/gulpjs/default-resolution
|
||||
[undertaker-17]: https://github.com/gulpjs/undertaker/pull/17#issuecomment-82374512
|
||||
|
||||
[downloads-image]: http://img.shields.io/npm/dm/last-run.svg
|
||||
[npm-url]: https://www.npmjs.com/package/last-run
|
||||
[npm-image]: http://img.shields.io/npm/v/last-run.svg
|
||||
|
||||
[travis-url]: https://travis-ci.org/gulpjs/last-run
|
||||
[travis-image]: http://img.shields.io/travis/gulpjs/last-run.svg?label=travis-ci
|
||||
|
||||
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/last-run
|
||||
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/last-run.svg?label=appveyor
|
||||
|
||||
[coveralls-url]: https://coveralls.io/r/gulpjs/last-run
|
||||
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/last-run/master.svg
|
||||
|
||||
[gitter-url]: https://gitter.im/gulpjs/gulp
|
||||
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg
|
||||
Reference in New Issue
Block a user