35 lines
1.9 KiB
Markdown
35 lines
1.9 KiB
Markdown
# early
|
|
minimal and fast loading animation for modules that need a little starting time.
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/early)
|
|
[](https://gitlab.com/pushrocks/early)
|
|
[](https://github.com/pushrocks/early)
|
|
[](https://pushrocks.gitlab.io/early/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/early/commits/master)
|
|
[](https://gitlab.com/pushrocks/early/commits/master)
|
|
[](https://david-dm.org/pushrocks/early)
|
|
[](https://www.bithound.io/github/pushrocks/early/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/early)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
// Put the following at the start of your module
|
|
import * as early from "early";
|
|
early.start("myModuleName");
|
|
/*
|
|
do your loading stuff
|
|
*/
|
|
early.stop().then((loadingTime:number) => { // loadingTime in milliseconds
|
|
|
|
}); // stop "early" when your module is ready
|
|
```
|
|
|
|
early runs in its own process: The loader animation runs smoothly even when your event queue of your currently loading module is working heavily.
|