push.rocks/smartsystem
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Philipp Kunz 2016-10-14 03:27:52 +02:00
parent 1d2c073206
commit 18d79cb403
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -20,14 +20,18 @@ simplifies lazy loading with TypeScript
## Usage ## Usage
We recommend the use of TypeScript for best Intellisense We recommend the use of TypeScript for best Intellisense
smartsystem supports both npm and SystemJs as module loader.
```typescript ```typescript
import { LazyModule } from 'smartsystem' import { LazyModule } from 'smartsystem'
import * as _myPlugin from 'myPlugin' // plugin does not get loaded here at runtime import * as _myPlugin from 'myPlugin' // plugin does not get loaded here at runtime
let myPluginLazy = new LazyModule<typeof _myPlugin>('myPlugin') let myPluginLazy = new LazyModule<typeof _myPlugin>('myPlugin')
let myPluginLazy.setLoader('npm') // sets the loader, defaults to npm anyway
import * as _anotherPlugin from 'anotherPlugin' // plugin does not get loaded here at runtime import * as _anotherPlugin from 'anotherPlugin' // plugin does not get loaded here at runtime
let anotherPluginLazy = new LazyModule<typeof _anotherPlugin>('anotherPlugin') let anotherPluginLazy = new LazyModule<typeof _anotherPlugin>('anotherPlugin')
let anotherPluginLazy.setLoader('systemjs') // sets the loader to systemjs
myPluginLazy.whenLoaded.then(myPlugin => { myPluginLazy.whenLoaded.then(myPlugin => {
/* do something with myPlugin. /* do something with myPlugin.