37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
|
# smartsystem
|
||
|
|
simplifies lazy loading with TypeScript
|
||
|
|
|
||
|
|
## Availabililty
|
||
|
|
[](https://www.npmjs.com/package/smartsystem)
|
||
|
|
[](https://gitlab.com/pushrocks/smartsystem)
|
||
|
|
[](https://github.com/pushrocks/smartsystem)
|
||
|
|
[](https://pushrocks.gitlab.io/smartsystem/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
[](https://gitlab.com/pushrocks/smartsystem/commits/master)
|
||
|
|
[](https://gitlab.com/pushrocks/smartsystem/commits/master)
|
||
|
|
[](https://david-dm.org/pushrocks/smartsystem)
|
||
|
|
[](https://www.bithound.io/github/pushrocks/smartsystem/master/dependencies/npm)
|
||
|
|
[](https://www.bithound.io/github/pushrocks/smartsystem)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](http://standardjs.com/)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
We recommend the use of TypeScript for best Intellisense
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
import {LazyModule, loadNow } from 'smartsystem'
|
||
|
|
|
||
|
|
import * as myPluginType from 'myPlugin' // plugin does not get loaded here at runtime
|
||
|
|
let myPluginPromised = LazyModule<typeof myPlugin>('myPlugin')
|
||
|
|
|
||
|
|
import * as anotherPluginType from 'anotherPlugin' // plugin does not get loaded here at runtime
|
||
|
|
let anotherPluginPromised = LazyModule<typeof anotherPlugin>('anotherPlugin')
|
||
|
|
|
||
|
|
myPluginPromised.then(myPlugin => { /* do something with myPlugin */ })
|
||
|
|
myPlugin.also(anotherPluginPromised).then((m,a) => {}) // also takes multiple other plugins
|
||
|
|
|
||
|
|
loadNow.only('myPlugin') // loads myPlugin and resolved the lazy promise
|
||
|
|
loadNow.also('myPlugin') // loads myPlugin and any chained 'also' modules
|
||
|
|
```
|