2016-10-06 17:28:00 +00:00
|
|
|
# smartsystem
|
|
|
|
|
simplifies lazy loading with TypeScript
|
|
|
|
|
|
|
|
|
|
## Availabililty
|
2017-05-13 08:33:34 +00:00
|
|
|
[](https://www.npmjs.com/package/smartsystem)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartsystem)
|
|
|
|
|
[](https://github.com/pushrocks/smartsystem)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartsystem/)
|
2016-10-06 17:28:00 +00:00
|
|
|
|
|
|
|
|
## Status for master
|
2017-05-13 08:33:34 +00:00
|
|
|
[](https://GitLab.com/pushrocks/smartsystem/commits/master)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartsystem/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/smartsystem)
|
2016-10-06 17:28:00 +00:00
|
|
|
[](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
|
|
|
|
|
|
2016-10-14 01:27:52 +00:00
|
|
|
smartsystem supports both npm and SystemJs as module loader.
|
|
|
|
|
|
2016-12-10 21:12:24 +00:00
|
|
|
```javascript
|
2016-10-12 12:01:15 +00:00
|
|
|
import { LazyModule } from 'smartsystem'
|
2016-10-06 17:28:00 +00:00
|
|
|
|
2017-05-13 08:33:34 +00:00
|
|
|
// plugin does not get loaded here at runtime
|
|
|
|
|
import * as _myPlugin from 'myPlugin'
|
2016-10-06 17:28:00 +00:00
|
|
|
|
2017-05-13 08:33:34 +00:00
|
|
|
// define the lazy module
|
|
|
|
|
let myLazyModule = new LazyModule<typeof _myPlugin>('myPlugin', __dirname)
|
|
|
|
|
|
|
|
|
|
// set the loader, defaults to npm anyway, can be systemjs alternatively
|
|
|
|
|
myLazyModule.setLoader('npm')
|
|
|
|
|
|
|
|
|
|
// another plugin
|
2016-10-12 12:09:58 +00:00
|
|
|
import * as _anotherPlugin from 'anotherPlugin' // plugin does not get loaded here at runtime
|
2017-05-13 08:33:34 +00:00
|
|
|
|
|
|
|
|
// define lazy module
|
|
|
|
|
let anotherLazyModule = new LazyModule<typeof _anotherPlugin>('anotherPlugin', __dirname)
|
2016-10-14 02:08:38 +00:00
|
|
|
anotherPluginLazy.setLoader('systemjs') // sets the loader to systemjs
|
2016-10-06 17:28:00 +00:00
|
|
|
|
2017-05-13 08:33:34 +00:00
|
|
|
myLazyModule.whenLoaded.then(myPlugin => {
|
2016-10-12 12:01:15 +00:00
|
|
|
/* 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 */
|
|
|
|
|
})
|
|
|
|
|
|
2017-05-13 08:33:34 +00:00
|
|
|
myLazyModule.load().then(myPlugin => {
|
2016-10-12 12:01:15 +00:00
|
|
|
/* do something with myPlugin.
|
|
|
|
|
myPlugin receives the typings flow from LazyModule class
|
|
|
|
|
This DOES LOAD the module */
|
|
|
|
|
})
|
2016-12-11 10:00:58 +00:00
|
|
|
```
|
|
|
|
|
|
2017-05-13 08:33:34 +00:00
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
