2016-09-15 12:45:58 +00:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > early< / title >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "assets/css/main.css" >
< script src = "assets/js/modernizr.js" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "assets/js/search.js" data-base = "." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "index.html" class = "title" > early< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< input type = "checkbox" id = "tsd-filter-only-exported" / >
< label class = "tsd-widget" for = "tsd-filter-only-exported" > Only exported< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "globals.html" > Globals< / a >
< / li >
< / ul >
< h1 > early< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< div class = "tsd-panel tsd-typography" >
< h1 id = "early" > early< / h1 >
< p > minimal and fast loading animation for modules that need a little starting time.< / p >
2016-09-18 21:44:56 +00:00
< h2 id = "availabililty" > Availabililty< / h2 >
< p > < a href = "https://www.npmjs.com/package/early" > < img src = "https://push.rocks/assets/repo-button-npm.svg" alt = "npm" > < / a >
< a href = "https://gitlab.com/pushrocks/early" > < img src = "https://push.rocks/assets/repo-button-git.svg" alt = "git" > < / a >
< a href = "https://github.com/pushrocks/early" > < img src = "https://push.rocks/assets/repo-button-mirror.svg" alt = "git" > < / a >
< a href = "https://pushrocks.gitlab.io/early/" > < img src = "https://push.rocks/assets/repo-button-docs.svg" alt = "docs" > < / a > < / p >
< h2 id = "status-for-master" > Status for master< / h2 >
< p > < a href = "https://gitlab.com/pushrocks/early/commits/master" > < img src = "https://gitlab.com/pushrocks/early/badges/master/build.svg" alt = "build status" > < / a >
< a href = "https://gitlab.com/pushrocks/early/commits/master" > < img src = "https://gitlab.com/pushrocks/early/badges/master/coverage.svg" alt = "coverage report" > < / a >
< a href = "https://david-dm.org/pushrocks/early" > < img src = "https://david-dm.org/pushrocks/early.svg" alt = "Dependency Status" > < / a >
< a href = "https://www.bithound.io/github/pushrocks/early/master/dependencies/npm" > < img src = "https://www.bithound.io/github/pushrocks/early/badges/dependencies.svg" alt = "bitHound Dependencies" > < / a >
< a href = "https://www.bithound.io/github/pushrocks/early" > < img src = "https://www.bithound.io/github/pushrocks/early/badges/code.svg" alt = "bitHound Code" > < / a >
< a href = "https://nodejs.org/dist/latest-v6.x/docs/api/" > < img src = "https://img.shields.io/badge/TypeScript-2.x-blue.svg" alt = "TypeScript" > < / a >
< a href = "https://nodejs.org/dist/latest-v6.x/docs/api/" > < img src = "https://img.shields.io/badge/node->=%206.x.x-blue.svg" alt = "node" > < / a >
< a href = "http://standardjs.com/" > < img src = "https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt = "JavaScript Style Guide" > < / a > < / p >
2016-09-15 12:45:58 +00:00
< h2 id = "usage" > Usage< / h2 >
< pre > < code class = "lang-typescript" > < span class = "hljs-comment" > // Put the following at the start of your module< / span >
< span class = "hljs-keyword" > import< / span > * as early from < span class = "hljs-string" > "early"< / span > ;
early.start(< span class = "hljs-string" > "myModuleName"< / span > );
< span class = "hljs-comment" > /*
do your loading stuff
*/< / span >
2016-09-15 12:59:22 +00:00
early.stop().then((loadingTime:< span class = "hljs-built_in" > number< / span > ) => { < span class = "hljs-comment" > // loadingTime in milliseconds< / span >
}); < span class = "hljs-comment" > // stop "early" when your module is ready< / span >
2016-09-15 12:45:58 +00:00
< / code > < / pre >
< p > early runs in its own process: The loader animation runs smoothly even when your event queue of your currently loading module is working heavily.< / p >
< / div >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = "globals " >
< a href = "globals.html" > < em > Globals< / em > < / a >
< / li >
< li class = "label tsd-is-external" >
< span > Internals< / span >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/_ts_early_child_.html" > "ts/early.child"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/_ts_index_.html" > "ts/index"< / a >
< / li >
< li class = "label tsd-is-external" >
< span > Externals< / span >
< / li >
< li class = " tsd-kind-external-module tsd-is-external" >
< a href = "modules/_node_modules_typings_global_custom_d_.html" > "node_< wbr > modules/typings-< wbr > global/custom.d"< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-module" > < span class = "tsd-kind-icon" > Module< / span > < / li >
< li class = "tsd-kind-object-literal" > < span class = "tsd-kind-icon" > Object literal< / span > < / li >
< li class = "tsd-kind-variable" > < span class = "tsd-kind-icon" > Variable< / span > < / li >
< li class = "tsd-kind-function" > < span class = "tsd-kind-icon" > Function< / span > < / li >
< li class = "tsd-kind-function tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Function with type parameter< / span > < / li >
< li class = "tsd-kind-index-signature" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< li class = "tsd-kind-type-alias" > < span class = "tsd-kind-icon" > Type alias< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-enum" > < span class = "tsd-kind-icon" > Enumeration< / span > < / li >
< li class = "tsd-kind-enum-member" > < span class = "tsd-kind-icon" > Enumeration member< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-interface" > < span class = "tsd-kind-icon" > Interface< / span > < / li >
< li class = "tsd-kind-interface tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Interface with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-class" > < span class = "tsd-kind-icon" > Class< / span > < / li >
< li class = "tsd-kind-class tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Class with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Accessor< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-call-signature tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "http://typedoc.io" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "assets/js/main.js" > < / script >
< script > if ( location . protocol == 'file:' ) document . write ( '<script src="assets/js/search.js"><' + '/script>' ) ; < / script >
< / body >
< / html >
