UNPKG

18 kBJSONView Raw
1{"id":0,"name":"aurelia-templating-router","kind":1,"kindString":"Project","flags":{},"originalName":"","children":[{"id":83,"name":"RouteHref","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Helper custom attribute to help associate an element with a route by name"},"children":[{"id":89,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/route-href.ts","line":60,"character":2}],"signatures":[{"id":90,"name":"new RouteHref","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":91,"name":"router","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}},{"id":92,"name":"element","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Element","package":"typescript","name":"Element"}}],"type":{"type":"reference","id":83,"name":"RouteHref"}}]},{"id":98,"name":"attribute","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Target property on a custom element if this attribute is put on a custom element\nOR an attribute if this attribute is put on a normal element"},"sources":[{"fileName":"src/route-href.ts","line":58,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":94,"name":"element","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Element this attribute is associated with"},"sources":[{"fileName":"src/route-href.ts","line":39,"character":11}],"type":{"type":"reference","qualifiedName":"Element","package":"typescript","name":"Element"}},{"id":97,"name":"params","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Parameters of this attribute to generate URL."},"sources":[{"fileName":"src/route-href.ts","line":52,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"qualifiedName":"Record","package":"typescript","name":"Record"}},{"id":96,"name":"route","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Name of the route this attribute refers to. This name should exist in the current router hierarchy"},"sources":[{"fileName":"src/route-href.ts","line":47,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":93,"name":"router","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Current router of this attribute"},"sources":[{"fileName":"src/route-href.ts","line":34,"character":11}],"type":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}},{"id":103,"name":"attributeChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/route-href.ts","line":78,"character":2}],"signatures":[{"id":104,"name":"attributeChanged","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":105,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":106,"name":"previous","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":99,"name":"bind","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/route-href.ts","line":69,"character":2}],"signatures":[{"id":100,"name":"bind","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]},{"id":107,"name":"processChange","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/route-href.ts","line":86,"character":2}],"signatures":[{"id":108,"name":"processChange","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":101,"name":"unbind","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/route-href.ts","line":74,"character":2}],"signatures":[{"id":102,"name":"unbind","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]},{"id":84,"name":"inject","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"src/route-href.ts","line":14,"character":9}],"signatures":[{"id":85,"name":"inject","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reflection","declaration":{"id":86,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":87,"name":"prototype","kind":1024,"kindString":"Property","flags":{"isExternal":true},"sources":[{"fileName":"node_modules/typescript/lib/lib.dom.d.ts","line":4878,"character":4}],"type":{"type":"reference","qualifiedName":"Element","package":"typescript","name":"Element"}}],"groups":[{"title":"Properties","kind":1024,"children":[87]}]}},{"type":"query","queryType":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}}]}}}]}],"groups":[{"title":"Constructors","kind":512,"children":[89]},{"title":"Properties","kind":1024,"children":[98,94,97,96,93]},{"title":"Methods","kind":2048,"children":[103,99,107,101,84]}],"sources":[{"fileName":"src/route-href.ts","line":11,"character":13}]},{"id":22,"name":"RouterView","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Implementation of Aurelia Router ViewPort. Responsible for loading route, composing and swapping routes views"},"children":[{"id":29,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/router-view.ts","line":154,"character":2}],"signatures":[{"id":30,"name":"new RouterView","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":31,"name":"element","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Element","package":"typescript","name":"Element"}},{"id":32,"name":"container","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Container","package":"aurelia-dependency-injection","name":"Container"}},{"id":33,"name":"viewSlot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"ViewSlot","package":"aurelia-templating","name":"ViewSlot"}},{"id":34,"name":"router","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}},{"id":35,"name":"viewLocator","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"ViewLocator","package":"aurelia-templating","name":"ViewLocator"}},{"id":36,"name":"compositionTransaction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"CompositionTransaction","package":"aurelia-templating","name":"CompositionTransaction"}},{"id":37,"name":"compositionEngine","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"CompositionEngine","package":"aurelia-templating","name":"CompositionEngine"}}],"type":{"type":"reference","id":22,"name":"RouterView"}}]},{"id":44,"name":"container","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Container at this <router-view/> level"},"sources":[{"fileName":"src/router-view.ts","line":98,"character":2}],"type":{"type":"reference","qualifiedName":"Container","package":"aurelia-dependency-injection","name":"Container"}},{"id":42,"name":"element","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Element associated with this <router-view/> custom element"},"sources":[{"fileName":"src/router-view.ts","line":88,"character":11}],"type":{"type":"reference","qualifiedName":"Element","package":"typescript","name":"Element"}},{"id":41,"name":"layoutModel","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Layout model used to activate layout view model, if specified with `layoutViewModel`"},"sources":[{"fileName":"src/router-view.ts","line":83,"character":2}],"type":{"type":"intrinsic","name":"any"}},{"id":39,"name":"layoutView","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Layout view used for this router-view layout, if no layout-viewmodel specified"},"sources":[{"fileName":"src/router-view.ts","line":72,"character":2}],"type":{"type":"intrinsic","name":"any"}},{"id":40,"name":"layoutViewModel","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Layout view model used as binding context for this router-view layout\nActual type would be {string | Constructable | object}"},"sources":[{"fileName":"src/router-view.ts","line":78,"character":2}],"type":{"type":"intrinsic","name":"any"}},{"id":43,"name":"router","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Current router associated with this <router-view/>"},"sources":[{"fileName":"src/router-view.ts","line":93,"character":11}],"type":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}},{"id":38,"name":"swapOrder","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Swapping order when going to a new route. By default, supports 3 value: before, after, with\n- before = new in -> old out\n- after = old out -> new in\n- with = new in + old out","text":"These values are defined by swapStrategies export in aurelia-templating/ aurelia-framework\nCan be extended there and used here\n"},"sources":[{"fileName":"src/router-view.ts","line":67,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":"before"},{"type":"literal","value":"after"},{"type":"literal","value":"with"}]}},{"id":57,"name":"bind","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/router-view.ts","line":190,"character":2}],"signatures":[{"id":58,"name":"bind","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":59,"name":"bindingContext","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":60,"name":"overrideContext","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"OverrideContext","package":"aurelia-binding","name":"OverrideContext"}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":54,"name":"created","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/router-view.ts","line":186,"character":2}],"signatures":[{"id":55,"name":"created","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":56,"name":"owningView","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"View","package":"aurelia-templating","name":"View"}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":61,"name":"process","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/router-view.ts","line":200,"character":2}],"signatures":[{"id":62,"name":"process","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Implementation of `aurelia-router` ViewPort interface, responsible for templating related part in routing Pipeline"},"parameters":[{"id":63,"name":"$viewPortInstruction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":64,"name":"waitToSwap","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":65,"name":"swap","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/router-view.ts","line":265,"character":2}],"signatures":[{"id":66,"name":"swap","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":67,"name":"$viewPortInstruction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}]}}]}],"groups":[{"title":"Constructors","kind":512,"children":[29]},{"title":"Properties","kind":1024,"children":[44,42,41,39,40,43,38]},{"title":"Methods","kind":2048,"children":[57,54,61,65]}],"sources":[{"fileName":"src/router-view.ts","line":36,"character":13}]},{"id":70,"name":"RouterViewLocator","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Locator which finds the nearest RouterView, relative to the current dependency injection container."},"children":[{"id":71,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/router-view.ts","line":375,"character":2}],"signatures":[{"id":72,"name":"new RouterViewLocator","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of the RouterViewLocator class."},"type":{"type":"reference","id":70,"name":"RouterViewLocator"}}]},{"id":73,"name":"promise","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/router-view.ts","line":367,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}},{"id":74,"name":"resolve","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/router-view.ts","line":370,"character":2}],"type":{"type":"reflection","declaration":{"id":75,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":76,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":77,"name":"val","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":78,"name":"findNearest","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/router-view.ts","line":383,"character":2}],"signatures":[{"id":79,"name":"findNearest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Finds the nearest RouterView instance.","returns":"A promise that will be resolved with the located RouterView instance.\n"},"type":{"type":"reference","typeArguments":[{"type":"reference","id":22,"name":"RouterView"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[71]},{"title":"Properties","kind":1024,"children":[73,74]},{"title":"Methods","kind":2048,"children":[78]}],"sources":[{"fileName":"src/router-view.ts","line":364,"character":13}]},{"id":4,"name":"TemplatingRouteLoader","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Default implementation of `RouteLoader` used for loading component based on a route config"},"children":[{"id":6,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/route-loader.ts","line":23,"character":2}],"signatures":[{"id":7,"name":"new TemplatingRouteLoader","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":8,"name":"compositionEngine","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"CompositionEngine","package":"aurelia-templating","name":"CompositionEngine"}}],"type":{"type":"reference","id":4,"name":"TemplatingRouteLoader"},"overwrites":{"type":"reference","name":"RouteLoader.constructor"}}],"overwrites":{"type":"reference","name":"RouteLoader.constructor"}},{"id":17,"name":"loadRoute","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/route-loader.ts","line":86,"character":2}],"signatures":[{"id":18,"name":"loadRoute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Load corresponding component of a route config of a navigation instruction"},"parameters":[{"id":19,"name":"router","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Router","package":"aurelia-router","name":"Router"}},{"id":20,"name":"config","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"RouteConfig","package":"aurelia-router","name":"RouteConfig"}},{"id":21,"name":"navInstruction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"NavigationInstruction","package":"aurelia-router","name":"NavigationInstruction"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"overwrites":{"type":"reference","name":"RouteLoader.loadRoute"}}],"overwrites":{"type":"reference","name":"RouteLoader.loadRoute"}}],"groups":[{"title":"Constructors","kind":512,"children":[6]},{"title":"Methods","kind":2048,"children":[17]}],"sources":[{"fileName":"src/route-loader.ts","line":15,"character":13}],"extendedTypes":[{"type":"reference","qualifiedName":"RouteLoader","package":"aurelia-router","name":"RouteLoader"}]},{"id":1,"name":"configure","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/aurelia-templating-router.ts","line":7,"character":16}],"signatures":[{"id":2,"name":"configure","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":3,"name":"config","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"IFrameworkConfiguration"}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Classes","kind":128,"children":[83,22,70,4]},{"title":"Functions","kind":64,"children":[1]}],"sources":[{"fileName":"src/aurelia-templating-router.ts","line":1,"character":0}]}
\No newline at end of file