44 lines
2.4 KiB
Markdown
44 lines
2.4 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 } from 'smartsystem'
|
|
|
|
import * as _myPlugin from 'myPlugin' // plugin does not get loaded here at runtime
|
|
let myPluginLazy = new LazyModule<typeof _myPlugin>('myPlugin')
|
|
|
|
import * as _anotherPlugin from 'anotherPlugin' // plugin does not get loaded here at runtime
|
|
let anotherPluginLazy = new LazyModule<typeof _anotherPlugin>('anotherPlugin')
|
|
|
|
myPluginLazy.whenLoaded.then(myPlugin => {
|
|
/* do something with myPlugin.
|
|
myPlugin receives the typings flow from LazyModule class
|
|
This does NOT load the module during runtime
|
|
The promise whenLoaded will be resolved whenever load() is called for the first time */
|
|
})
|
|
|
|
myPluginLazy.load().then(myPlugin => {
|
|
/* do something with myPlugin.
|
|
myPlugin receives the typings flow from LazyModule class
|
|
This DOES LOAD the module */
|
|
})
|
|
``` |