| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213 |
- // Type definitions for Angular v2.0.0-alpha.37
- // Project: http://angular.io/
- // Definitions by: angular team <https://github.com/angular/>
- // Definitions: https://github.com/borisyankov/DefinitelyTyped
- // ***********************************************************
- // This file is generated by the Angular build process.
- // Please do not create manual edits or send pull requests
- // modifying this file.
- // ***********************************************************
- // angular2/angular2 depends transitively on these libraries.
- // If you don't have them installed you can install them using TSD
- // https://github.com/DefinitelyTyped/tsd
- ///<reference path="../es6-promise/es6-promise.d.ts"/>
- ///<reference path="../rx/rx.d.ts"/>
- // angular2/web_worker/worker depends transitively on these libraries.
- // If you don't have them installed you can install them using TSD
- // https://github.com/DefinitelyTyped/tsd
- ///<reference path="../es6-promise/es6-promise.d.ts"/>
- ///<reference path="../rx/rx.d.ts"/>
- // angular2/web_worker/ui depends transitively on these libraries.
- // If you don't have them installed you can install them using TSD
- // https://github.com/DefinitelyTyped/tsd
- ///<reference path="../es6-promise/es6-promise.d.ts"/>
- ///<reference path="../rx/rx.d.ts"/>
- interface Map<K,V> {}
- interface StringMap<K,V> extends Map<K,V> {}
- declare module ng {
- // See https://github.com/Microsoft/TypeScript/issues/1168
- class BaseException /* extends Error */ {
- message: string;
- stack: string;
- toString(): string;
- }
- interface InjectableReference {}
- }
- declare module ngWorker {
- // See https://github.com/Microsoft/TypeScript/issues/1168
- class BaseException /* extends Error */ {
- message: string;
- stack: string;
- toString(): string;
- }
- interface InjectableReference {}
- }
- declare module ngUi {
- // See https://github.com/Microsoft/TypeScript/issues/1168
- class BaseException /* extends Error */ {
- message: string;
- stack: string;
- toString(): string;
- }
- interface InjectableReference {}
- }
- /**
- * The `angular2` is the single place to import all of the individual types.
- */
- declare module ng {
- /**
- * Bootstrapping for Angular applications.
- *
- * You instantiate an Angular application by explicitly specifying a component to use as the root
- * component for your
- * application via the `bootstrap()` method.
- *
- * ## Simple Example
- *
- * Assuming this `index.html`:
- *
- * ```html
- * <html>
- * <!-- load Angular script tags here. -->
- * <body>
- * <my-app>loading...</my-app>
- * </body>
- * </html>
- * ```
- *
- * An application is bootstrapped inside an existing browser DOM, typically `index.html`. Unlike
- * Angular 1, Angular 2
- * does not compile/process bindings in `index.html`. This is mainly for security reasons, as well
- * as architectural
- * changes in Angular 2. This means that `index.html` can safely be processed using server-side
- * technologies such as
- * bindings. Bindings can thus use double-curly `{{ syntax }}` without collision from Angular 2
- * component double-curly
- * `{{ syntax }}`.
- *
- * We can use this script code:
- *
- * ```
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: 'Hello {{ name }}!'
- * })
- * class MyApp {
- * name:string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- *
- * main() {
- * return bootstrap(MyApp);
- * }
- * ```
- *
- * When the app developer invokes `bootstrap()` with the root component `MyApp` as its argument,
- * Angular performs the
- * following tasks:
- *
- * 1. It uses the component's `selector` property to locate the DOM element which needs to be
- * upgraded into
- * the angular component.
- * 2. It creates a new child injector (from the platform injector). Optionally, you can also
- * override the injector configuration for an app by
- * invoking `bootstrap` with the `componentInjectableBindings` argument.
- * 3. It creates a new `Zone` and connects it to the angular application's change detection domain
- * instance.
- * 4. It creates a shadow DOM on the selected component's host element and loads the template into
- * it.
- * 5. It instantiates the specified component.
- * 6. Finally, Angular performs change detection to apply the initial data bindings for the
- * application.
- *
- *
- * ## Instantiating Multiple Applications on a Single Page
- *
- * There are two ways to do this.
- *
- *
- * ### Isolated Applications
- *
- * Angular creates a new application each time that the `bootstrap()` method is invoked. When
- * multiple applications
- * are created for a page, Angular treats each application as independent within an isolated change
- * detection and
- * `Zone` domain. If you need to share data between applications, use the strategy described in the
- * next
- * section, "Applications That Share Change Detection."
- *
- *
- * ### Applications That Share Change Detection
- *
- * If you need to bootstrap multiple applications that share common data, the applications must
- * share a common
- * change detection and zone. To do that, create a meta-component that lists the application
- * components in its template.
- * By only invoking the `bootstrap()` method once, with the meta-component as its argument, you
- * ensure that only a
- * single change detection zone is created and therefore data can be shared across the applications.
- *
- *
- * ## Platform Injector
- *
- * When working within a browser window, there are many singleton resources: cookies, title,
- * location, and others.
- * Angular services that represent these resources must likewise be shared across all Angular
- * applications that
- * occupy the same browser window. For this reason, Angular creates exactly one global platform
- * injector which stores
- * all shared services, and each angular application injector has the platform injector as its
- * parent.
- *
- * Each application has its own private injector as well. When there are multiple applications on a
- * page, Angular treats
- * each application injector's services as private to that application.
- *
- *
- * # API
- * - `appComponentType`: The root component which should act as the application. This is a reference
- * to a `Type`
- * which is annotated with `@Component(...)`.
- * - `componentInjectableBindings`: An additional set of bindings that can be added to the app
- * injector
- * to override default injection behavior.
- * - `errorReporter`: `function(exception:any, stackTrace:string)` a default error reporter for
- * unhandled exceptions.
- *
- * Returns a `Promise` of {@link ApplicationRef}.
- */
- function bootstrap(appComponentType: /*Type*/ any, componentInjectableBindings?: Array<Type | Binding | any[]>) : Promise<ApplicationRef> ;
- /**
- * Declare reusable UI building blocks for an application.
- *
- * Each Angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@Component`
- * annotation specifies when a component is instantiated, and which properties and hostListeners it
- * binds to.
- *
- * When a component is instantiated, Angular
- * - creates a shadow DOM for the component.
- * - loads the selected template into the shadow DOM.
- * - creates all the injectable objects configured with `bindings` and `viewBindings`.
- *
- * All template expressions and statements are then evaluated against the component instance.
- *
- * For details on the `@View` annotation, see {@link ViewMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!'
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ComponentMetadata extends DirectiveMetadata {
- /**
- * Defines the used change detection strategy.
- *
- * When a component is instantiated, Angular creates a change detector, which is responsible for
- * propagating the component's bindings.
- *
- * The `changeDetection` property defines, whether the change detection will be checked every time
- * or only when the component tells it to do so.
- */
- changeDetection: ChangeDetectionStrategy;
- /**
- * Defines the set of injectable objects that are visible to its view dom children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'needs-greeter'
- * })
- * class NeedsGreeter {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- *
- * @Component({
- * selector: 'greet',
- * viewBindings: [
- * Greeter
- * ]
- * })
- * @View({
- * template: `<needs-greeter></needs-greeter>`,
- * directives: [NeedsGreeter]
- * })
- * class HelloWorld {
- * }
- *
- * ```
- */
- viewBindings: any[];
- }
- /**
- * Directives allow you to attach behavior to elements in the DOM.
- *
- * {@link DirectiveMetadata}s with an embedded view are called {@link ComponentMetadata}s.
- *
- * A directive consists of a single directive annotation and a controller class. When the
- * directive's `selector` matches
- * elements in the DOM, the following steps occur:
- *
- * 1. For each directive, the `ElementInjector` attempts to resolve the directive's constructor
- * arguments.
- * 2. Angular instantiates directives for each matched element using `ElementInjector` in a
- * depth-first order,
- * as declared in the HTML.
- *
- * ## Understanding How Injection Works
- *
- * There are three stages of injection resolution.
- * - *Pre-existing Injectors*:
- * - The terminal {@link Injector} cannot resolve dependencies. It either throws an error or, if
- * the dependency was
- * specified as `@Optional`, returns `null`.
- * - The platform injector resolves browser singleton resources, such as: cookies, title,
- * location, and others.
- * - *Component Injectors*: Each component instance has its own {@link Injector}, and they follow
- * the same parent-child hierarchy
- * as the component instances in the DOM.
- * - *Element Injectors*: Each component instance has a Shadow DOM. Within the Shadow DOM each
- * element has an `ElementInjector`
- * which follow the same parent-child hierarchy as the DOM elements themselves.
- *
- * When a template is instantiated, it also must instantiate the corresponding directives in a
- * depth-first order. The
- * current `ElementInjector` resolves the constructor dependencies for each directive.
- *
- * Angular then resolves dependencies as follows, according to the order in which they appear in the
- * {@link ViewMetadata}:
- *
- * 1. Dependencies on the current element
- * 2. Dependencies on element injectors and their parents until it encounters a Shadow DOM boundary
- * 3. Dependencies on component injectors and their parents until it encounters the root component
- * 4. Dependencies on pre-existing injectors
- *
- *
- * The `ElementInjector` can inject other directives, element-specific special objects, or it can
- * delegate to the parent
- * injector.
- *
- * To inject other directives, declare the constructor parameter as:
- * - `directive:DirectiveType`: a directive on the current element only
- * - `@Host() directive:DirectiveType`: any directive that matches the type between the current
- * element and the
- * Shadow DOM root.
- * - `@Query(DirectiveType) query:QueryList<DirectiveType>`: A live collection of direct child
- * directives.
- * - `@QueryDescendants(DirectiveType) query:QueryList<DirectiveType>`: A live collection of any
- * child directives.
- *
- * To inject element-specific special objects, declare the constructor parameter as:
- * - `element: ElementRef` to obtain a reference to logical element in the view.
- * - `viewContainer: ViewContainerRef` to control child template instantiation, for
- * {@link DirectiveMetadata} directives only
- * - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
- *
- * ## Example
- *
- * The following example demonstrates how dependency injection resolves constructor arguments in
- * practice.
- *
- *
- * Assume this HTML template:
- *
- * ```
- * <div dependency="1">
- * <div dependency="2">
- * <div dependency="3" my-directive>
- * <div dependency="4">
- * <div dependency="5"></div>
- * </div>
- * <div dependency="6"></div>
- * </div>
- * </div>
- * </div>
- * ```
- *
- * With the following `dependency` decorator and `SomeService` injectable class.
- *
- * ```
- * @Injectable()
- * class SomeService {
- * }
- *
- * @Directive({
- * selector: '[dependency]',
- * properties: [
- * 'id: dependency'
- * ]
- * })
- * class Dependency {
- * id:string;
- * }
- * ```
- *
- * Let's step through the different ways in which `MyDirective` could be declared...
- *
- *
- * ### No injection
- *
- * Here the constructor is declared with no arguments, therefore nothing is injected into
- * `MyDirective`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor() {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with no dependencies.
- *
- *
- * ### Component-level injection
- *
- * Directives can inject any injectable instance from the closest component injector or any of its
- * parents.
- *
- * Here, the constructor declares a parameter, `someService`, and injects the `SomeService` type
- * from the parent
- * component's injector.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(someService: SomeService) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a dependency on `SomeService`.
- *
- *
- * ### Injecting a directive from the current element
- *
- * Directives can inject other directives declared on the current element.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(dependency: Dependency) {
- * expect(dependency.id).toEqual(3);
- * }
- * }
- * ```
- * This directive would be instantiated with `Dependency` declared at the same element, in this case
- * `dependency="3"`.
- *
- * ### Injecting a directive from any ancestor elements
- *
- * Directives can inject other directives declared on any ancestor element (in the current Shadow
- * DOM), i.e. on the current element, the
- * parent element, or its parents.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Host() dependency: Dependency) {
- * expect(dependency.id).toEqual(2);
- * }
- * }
- * ```
- *
- * `@Host` checks the current element, the parent, as well as its parents recursively. If
- * `dependency="2"` didn't
- * exist on the direct parent, this injection would
- * have returned
- * `dependency="1"`.
- *
- *
- * ### Injecting a live collection of direct child directives
- *
- *
- * A directive can also query for other child directives. Since parent directives are instantiated
- * before child directives, a directive can't simply inject the list of child directives. Instead,
- * the directive injects a {@link QueryList}, which updates its contents as children are added,
- * removed, or moved by a directive that uses a {@link ViewContainerRef} such as a `ng-for`, an
- * `ng-if`, or an `ng-switch`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency) dependencies:QueryList<Dependency>) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a {@link QueryList} which contains `Dependency` 4 and
- * 6. Here, `Dependency` 5 would not be included, because it is not a direct child.
- *
- * ### Injecting a live collection of descendant directives
- *
- * By passing the descendant flag to `@Query` above, we can include the children of the child
- * elements.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency, {descendants: true}) dependencies:QueryList<Dependency>) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a Query which would contain `Dependency` 4, 5 and 6.
- *
- * ### Optional injection
- *
- * The normal behavior of directives is to return an error when a specified dependency cannot be
- * resolved. If you
- * would like to inject `null` on unresolved dependency instead, you can annotate that dependency
- * with `@Optional()`.
- * This explicitly permits the author of a template to treat some of the surrounding directives as
- * optional.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Optional() dependency:Dependency) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a `Dependency` directive found on the current element.
- * If none can be
- * found, the injector supplies `null` instead of throwing an error.
- *
- * ## Example
- *
- * Here we use a decorator directive to simply define basic tool-tip behavior.
- *
- * ```
- * @Directive({
- * selector: '[tooltip]',
- * properties: [
- * 'text: tooltip'
- * ],
- * host: {
- * '(mouseenter)': 'onMouseEnter()',
- * '(mouseleave)': 'onMouseLeave()'
- * }
- * })
- * class Tooltip{
- * text:string;
- * overlay:Overlay; // NOT YET IMPLEMENTED
- * overlayManager:OverlayManager; // NOT YET IMPLEMENTED
- *
- * constructor(overlayManager:OverlayManager) {
- * this.overlay = overlay;
- * }
- *
- * onMouseEnter() {
- * // exact signature to be determined
- * this.overlay = this.overlayManager.open(text, ...);
- * }
- *
- * onMouseLeave() {
- * this.overlay.close();
- * this.overlay = null;
- * }
- * }
- * ```
- * In our HTML template, we can then add this behavior to a `<div>` or any other element with the
- * `tooltip` selector,
- * like so:
- *
- * ```
- * <div tooltip="some text here"></div>
- * ```
- *
- * Directives can also control the instantiation, destruction, and positioning of inline template
- * elements:
- *
- * A directive uses a {@link ViewContainerRef} to instantiate, insert, move, and destroy views at
- * runtime.
- * The {@link ViewContainerRef} is created as a result of `<template>` element, and represents a
- * location in the current view
- * where these actions are performed.
- *
- * Views are always created as children of the current {@link ViewMetadata}, and as siblings of the
- * `<template>` element. Thus a
- * directive in a child view cannot inject the directive that created it.
- *
- * Since directives that create views via ViewContainers are common in Angular, and using the full
- * `<template>` element syntax is wordy, Angular
- * also supports a shorthand notation: `<li *foo="bar">` and `<li template="foo: bar">` are
- * equivalent.
- *
- * Thus,
- *
- * ```
- * <ul>
- * <li *foo="bar" title="text"></li>
- * </ul>
- * ```
- *
- * Expands in use to:
- *
- * ```
- * <ul>
- * <template [foo]="bar">
- * <li title="text"></li>
- * </template>
- * </ul>
- * ```
- *
- * Notice that although the shorthand places `*foo="bar"` within the `<li>` element, the binding for
- * the directive
- * controller is correctly instantiated on the `<template>` element rather than the `<li>` element.
- *
- *
- * ## Example
- *
- * Let's suppose we want to implement the `unless` behavior, to conditionally include a template.
- *
- * Here is a simple directive that triggers on an `unless` selector:
- *
- * ```
- * @Directive({
- * selector: '[unless]',
- * properties: ['unless']
- * })
- * export class Unless {
- * viewContainer: ViewContainerRef;
- * templateRef: TemplateRef;
- * prevCondition: boolean;
- *
- * constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef) {
- * this.viewContainer = viewContainer;
- * this.templateRef = templateRef;
- * this.prevCondition = null;
- * }
- *
- * set unless(newCondition) {
- * if (newCondition && (isBlank(this.prevCondition) || !this.prevCondition)) {
- * this.prevCondition = true;
- * this.viewContainer.clear();
- * } else if (!newCondition && (isBlank(this.prevCondition) || this.prevCondition)) {
- * this.prevCondition = false;
- * this.viewContainer.create(this.templateRef);
- * }
- * }
- * }
- * ```
- *
- * We can then use this `unless` selector in a template:
- * ```
- * <ul>
- * <li *unless="expr"></li>
- * </ul>
- * ```
- *
- * Once the directive instantiates the child view, the shorthand notation for the template expands
- * and the result is:
- *
- * ```
- * <ul>
- * <template [unless]="exp">
- * <li></li>
- * </template>
- * <li></li>
- * </ul>
- * ```
- *
- * Note also that although the `<li></li>` template still exists inside the `<template></template>`,
- * the instantiated
- * view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
- */
- class DirectiveMetadata extends InjectableMetadata {
- /**
- * The CSS selector that triggers the instantiation of a directive.
- *
- * Angular only allows directives to trigger on CSS selectors that do not cross element
- * boundaries.
- *
- * `selector` may be declared as one of the following:
- *
- * - `element-name`: select by element name.
- * - `.class`: select by class name.
- * - `[attribute]`: select by attribute name.
- * - `[attribute=value]`: select by attribute name and value.
- * - `:not(sub_selector)`: select only if the element does not match the `sub_selector`.
- * - `selector1, selector2`: select if either `selector1` or `selector2` matches.
- *
- *
- * ## Example
- *
- * Suppose we have a directive with an `input[type=text]` selector.
- *
- * And the following HTML:
- *
- * ```html
- * <form>
- * <input type="text">
- * <input type="radio">
- * <form>
- * ```
- *
- * The directive would only be instantiated on the `<input type="text">` element.
- */
- selector: string;
- /**
- * Enumerates the set of properties that accept data binding for a directive.
- *
- * The `properties` property defines a set of `directiveProperty` to `bindingProperty`
- * configuration:
- *
- * - `directiveProperty` specifies the component property where the value is written.
- * - `bindingProperty` specifies the DOM property where the value is read from.
- *
- * You can include a {@link PipeMetadata} when specifying a `bindingProperty` to allow for data
- * transformation and structural change detection of the value. These pipes will be evaluated in
- * the context of this component.
- *
- * ## Syntax
- *
- * There is no need to specify both `directiveProperty` and `bindingProperty` when they both have
- * the same value.
- *
- * ```
- * @Directive({
- * properties: [
- * 'propertyName', // shorthand notation for 'propertyName: propertyName'
- * 'directiveProperty1: bindingProperty1',
- * 'directiveProperty2: bindingProperty2 | pipe1 | ...',
- * ...
- * ]
- * }
- * ```
- *
- *
- * ## Basic Property Binding
- *
- * We can easily build a simple `Tooltip` directive that exposes a `tooltip` property, which can
- * be used in templates with standard Angular syntax. For example:
- *
- * ```
- * @Directive({
- * selector: '[tooltip]',
- * properties: [
- * 'text: tooltip'
- * ]
- * })
- * class Tooltip {
- * set text(value: string) {
- * // This will get called every time with the new value when the 'tooltip' property changes
- * }
- * }
- * ```
- *
- * We can then bind to the `tooltip' property as either an expression (`someExpression`) or as a
- * string literal, as shown in the HTML template below:
- *
- * ```html
- * <div [tooltip]="someExpression">...</div>
- * <div tooltip="Some Text">...</div>
- * ```
- *
- * Whenever the `someExpression` expression changes, the `properties` declaration instructs
- * Angular to update the `Tooltip`'s `text` property.
- *
- * ### Bindings With Pipes
- *
- * You can use pipes in bindings, as follows:
- *
- * ```html
- * <div [class-set]="someExpression | somePipe">
- * ```
- */
- properties: string[];
- /**
- * Enumerates the set of emitted events.
- *
- * ## Syntax
- *
- * ```
- * @Component({
- * events: ['statusChange']
- * })
- * class TaskComponent {
- * statusChange: EventEmitter;
- *
- * constructor() {
- * this.statusChange = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.statusChange.next('completed');
- * }
- * }
- * ```
- *
- * Use `propertyName: eventName` when the event emitter property name is different from the name
- * of the emitted event:
- *
- * ```
- * @Component({
- * events: ['status: statusChange']
- * })
- * class TaskComponent {
- * status: EventEmitter;
- *
- * constructor() {
- * this.status = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.status.next('completed');
- * }
- * }
- * ```
- */
- events: string[];
- /**
- * Specifiy the events, actions, properties and attributes related to the host element.
- *
- * ## Events
- *
- * Specifies which DOM hostListeners a directive listens to via a set of `(event)` to `method`
- * key-value pairs:
- *
- * - `event1`: the DOM event that the directive listens to.
- * - `statement`: the statement to execute when the event occurs.
- * If the evalutation of the statement returns `false`, then `preventDefault`is applied on the DOM
- * event.
- *
- * To listen to global events, a target must be added to the event name.
- * The target can be `window`, `document` or `body`.
- *
- * When writing a directive event binding, you can also refer to the following local variables:
- * - `$event`: Current event object which triggered the event.
- * - `$target`: The source of the event. This will be either a DOM element or an Angular
- * directive. (will be implemented in later release)
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * host: {
- * '(event1)': 'onMethod1(arguments)',
- * '(target:event2)': 'onMethod2(arguments)',
- * ...
- * }
- * }
- * ```
- *
- * ## Basic Event Binding:
- *
- * Suppose you want to write a directive that reacts to `change` events in the DOM and on
- * `resize` events in window.
- * You would define the event binding as follows:
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '(change)': 'onChange($event)',
- * '(window:resize)': 'onResize($event)'
- * }
- * })
- * class InputDirective {
- * onChange(event:Event) {
- * // invoked when the input element fires the 'change' event
- * }
- * onResize(event:Event) {
- * // invoked when the window fires the 'resize' event
- * }
- * }
- * ```
- *
- * ## Properties
- *
- * Specifies which DOM properties a directives updates.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '[prop]': 'expression'
- * }
- * })
- * class InputDirective {
- * value:string;
- * }
- * ```
- *
- * In this example the prop property of the host element is updated with the expression value
- * every time it changes.
- *
- * ## Attributes
- *
- * Specifies static attributes that should be propagated to a host element. Attributes specified
- * in `hostAttributes` are propagated only if a given attribute is not present on a host element.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: '[my-button]',
- * host: {
- * 'role': 'button'
- * }
- * })
- * class MyButton {
- * }
- * ```
- *
- * In this example using `my-button` directive (ex.: `<div my-button></div>`) on a host element
- * (here: `<div>` ) will ensure that this element will get the "button" role.
- */
- host: StringMap<string, string>;
- /**
- * Specifies which lifecycle should be notified to the directive.
- *
- * See {@link LifecycleEvent} for details.
- */
- lifecycle: LifecycleEvent[];
- /**
- * If set to false the compiler does not compile the children of this directive.
- */
- compileChildren: boolean;
- /**
- * Defines the set of injectable objects that are visible to a Directive and its light dom
- * children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'greet',
- * bindings: [
- * Greeter
- * ]
- * })
- * class HelloWorld {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- * ```
- */
- bindings: any[];
- /**
- * Defines the name that can be used in the template to assign this directive to a variable.
- *
- * ## Simple Example
- *
- * ```
- * @Directive({
- * selector: 'child-dir',
- * exportAs: 'child'
- * })
- * class ChildDir {
- * }
- *
- * @Component({
- * selector: 'main',
- * })
- * @View({
- * template: `<child-dir #c="child"></child-dir>`,
- * directives: [ChildDir]
- * })
- * class MainComponent {
- * }
- *
- * ```
- */
- exportAs: string;
- }
- /**
- * Declare reusable pipe function.
- *
- * ## Example
- *
- * ```
- * @Pipe({
- * name: 'lowercase'
- * })
- * class Lowercase {
- * transform(v, args) { return v.toLowerCase(); }
- * }
- * ```
- */
- class PipeMetadata extends InjectableMetadata {
- name: string;
- }
- /**
- * Lifecycle events are guaranteed to be called in the following order:
- * - `OnChanges` (if any bindings have changed),
- * - `OnInit` (after the first check only),
- * - `DoCheck`,
- * - `AfterContentChecked`
- * - `AfterContentChecked`
- * - `OnDestroy` (at the very end before destruction)
- */
- enum LifecycleEvent {
- /**
- * Notify a directive when it has been checked the first time.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only once.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.OnInit]
- * })
- * class ClassSet {
- * onInit() {
- * }
- * }
- * ```
- */
- OnInit,
- /**
- * Notify a directive whenever a {@link ViewMetadata} that contains it is destroyed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * ...,
- * lifecycle: [LifecycleEvent.OnDestroy]
- * })
- * class ClassSet {
- * onDestroy() {
- * // invoked to notify directive of the containing view destruction.
- * }
- * }
- * ```
- */
- OnDestroy,
- /**
- * Notify a directive when any of its bindings have changed.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only if at least one of the directive's bindings has changed.
- *
- * ## Example:
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * properties: [
- * 'propA',
- * 'propB'
- * ],
- * lifecycle: [LifecycleEvent.OnChanges]
- * })
- * class ClassSet {
- * propA;
- * propB;
- * onChanges(changes:{[idx: string, PropertyUpdate]}) {
- * // This will get called after any of the properties have been updated.
- * if (changes['propA']) {
- * // if propA was updated
- * }
- * if (changes['propA']) {
- * // if propB was updated
- * }
- * }
- * }
- * ```
- */
- OnChanges,
- /**
- * Notify a directive when it has been checked.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked every time even when none of the directive's bindings has changed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.DoCheck]
- * })
- * class ClassSet {
- * doCheck() {
- * }
- * }
- * ```
- */
- DoCheck,
- /**
- * Notify a directive when the bindings of all its content children have been checked the first
- * time (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentInit]
- * })
- * class ClassSet {
- *
- * afterContentInit() {
- * }
- *
- * }
- * ```
- */
- AfterContentInit,
- /**
- * Notify a directive when the bindings of all its content children have been checked (whether
- * they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentChecked]
- * })
- * class ClassSet {
- *
- * afterContentChecked() {
- * }
- *
- * }
- * ```
- */
- AfterContentChecked,
- /**
- * Notify a directive when the bindings of all its view children have been checked the first time
- * (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewInit]
- * })
- * class ClassSet {
- *
- * afterViewInit() {
- * }
- *
- * }
- * ```
- */
- AfterViewInit,
- /**
- * Notify a directive when the bindings of all its view children have been checked (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewChecked]
- * })
- * class ClassSet {
- *
- * afterViewChecked() {
- * }
- *
- * }
- * ```
- */
- AfterViewChecked
- }
- /**
- * Declares the available HTML templates for an application.
- *
- * Each angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@View` annotation specifies the HTML template to use, and lists the directives that are active
- * within the template.
- *
- * When a component is instantiated, the template is loaded into the component's shadow root, and
- * the expressions and statements in the template are evaluated against the component.
- *
- * For details on the `@Component` annotation, see {@link ComponentMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!',
- * directives: [GreetUser, Bold]
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ViewMetadata {
- /**
- * Specifies a template URL for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- templateUrl: string;
- /**
- * Specifies an inline template for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- template: string;
- /**
- * Specifies stylesheet URLs for an angular component.
- */
- styleUrls: string[];
- /**
- * Specifies an inline stylesheet for an angular component.
- */
- styles: string[];
- /**
- * Specifies a list of directives that can be used within a template.
- *
- * Directives must be listed explicitly to provide proper component encapsulation.
- *
- * ## Example
- *
- * ```javascript
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * directives: [For]
- * template: '
- * <ul>
- * <li *ng-for="#item of items">{{item}}</li>
- * </ul>'
- * })
- * class MyComponent {
- * }
- * ```
- */
- directives: Array<Type | any | any[]>;
- pipes: Array<Type | any | any[]>;
- /**
- * Specify how the template and the styles should be encapsulated.
- * The default is {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} if the view
- * has styles,
- * otherwise {@link ViewEncapsulation#None `ViewEncapsulation.None`}.
- */
- encapsulation: ViewEncapsulation;
- }
- /**
- * How the template and styles of a view should be encapsulated.
- */
- enum ViewEncapsulation {
- /**
- * Emulate scoping of styles by preprocessing the style rules
- * and adding additional attributes to elements. This is the default.
- */
- Emulated,
- /**
- * Uses the native mechanism of the renderer. For the DOM this means creating a ShadowRoot.
- */
- Native,
- /**
- * Don't scope the template nor the styles.
- */
- None
- }
- /**
- * Specifies that a {@link QueryList} should be injected.
- *
- * See {@link QueryList} for usage and example.
- */
- class QueryMetadata extends DependencyMetadata {
- descendants: boolean;
- isViewQuery: any;
- selector: any;
- isVarBindingQuery: boolean;
- varBindings: string[];
- toString(): string;
- }
- /**
- * Specifies that a constant attribute value should be injected.
- *
- * The directive can inject constant string literals of host element attributes.
- *
- * ## Example
- *
- * Suppose we have an `<input>` element and want to know its `type`.
- *
- * ```html
- * <input type="text">
- * ```
- *
- * A decorator can inject string literal `text` like so:
- *
- * ```javascript
- * @Directive({
- * selector: `input'
- * })
- * class InputDirective {
- * constructor(@Attribute('type') type) {
- * // type would be `text` in this example
- * }
- * }
- * ```
- */
- class AttributeMetadata extends DependencyMetadata {
- attributeName: string;
- token: any;
- toString(): string;
- }
- /**
- * {@link AttributeMetadata} factory function.
- */
- var Attribute : AttributeFactory ;
- /**
- * {@link AttributeMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Attribute, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Attribute('title') title: string) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Attribute('title'), function(title) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(title) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Attribute('title')]
- * ]
- * ```
- */
- interface AttributeFactory {
- new(name: string): AttributeMetadata;
- (name: string): TypeDecorator;
- }
- /**
- * {@link ComponentMetadata} factory function.
- */
- var Component : ComponentFactory ;
- /**
- * Interface for the {@link ComponentMetadata} decorator function.
- *
- * See {@link ComponentFactory}.
- */
- interface ComponentDecorator extends TypeDecorator {
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- pipes?: Array<Type | any | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link ComponentAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ComponentFactory {
- new(obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentMetadata;
- (obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentDecorator;
- }
- /**
- * {@link DirectiveMetadata} factory function.
- */
- var Directive : DirectiveFactory ;
- /**
- * Interface for the {@link DirectiveMetadata} decorator function.
- *
- * See {@link DirectiveFactory}.
- */
- interface DirectiveDecorator extends TypeDecorator {
- }
- /**
- * {@link DirectiveMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Directive} from "angular2/angular2";
- *
- * @Directive({...})
- * class MyDirective {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyDirective = ng
- * .Directive({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyDirective = function() {
- * ...
- * };
- *
- * MyDirective.annotations = [
- * new ng.Directive({...})
- * ]
- * ```
- */
- interface DirectiveFactory {
- new(obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveMetadata;
- (obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveDecorator;
- }
- /**
- * {@link ViewMetadata} factory function.
- */
- var View : ViewFactory ;
- /**
- * Interface for the {@link ViewMetadata} decorator function.
- *
- * See {@link ViewFactory}.
- */
- interface ViewDecorator extends TypeDecorator {
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- pipes?: Array<Type | any | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link ViewAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ViewFactory {
- new(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewMetadata;
- (obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link QueryMetadata} factory function.
- */
- var Query : QueryFactory ;
- /**
- * {@link QueryMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Query, QueryList, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Query(SomeType) queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Query(SomeType), function(queryList) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(queryList) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Query(SomeType)]
- * ]
- * ```
- */
- interface QueryFactory {
- new(selector: Type | string, {descendants}?: {descendants?: boolean}): QueryMetadata;
- (selector: Type | string, {descendants}?: {descendants?: boolean}): ParameterDecorator;
- }
- /**
- * {@link di/ViewQueryMetadata} factory function.
- */
- var ViewQuery : QueryFactory ;
- /**
- * {@link PipeMetadata} factory function.
- */
- var Pipe : PipeFactory ;
- /**
- * {@link PipeMetadata} factory for creating decorators.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Pipe} from "angular2/angular2";
- *
- * @Pipe({...})
- * class MyPipe {
- * constructor() {
- * ...
- * }
- *
- * transform(v, args) {}
- * }
- * ```
- */
- interface PipeFactory {
- new(obj: {
- name: string,
- }): any;
- (obj: {name: string}): any;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentInit `LifeCycleEvent.afterContentInit`}
- * called when the bindings of all its content children have been checked the first time.
- */
- interface AfterContentInit {
- afterContentInit(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentChecked `LifeCycleEvent.afterContentChecked`}
- * called when the bindings of all its content children have been checked.
- */
- interface AfterContentChecked {
- afterContentChecked(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewInit `LifeCycleEvent.afterViewInit`}
- * called when the bindings of all its view children have been checked the first time.
- */
- interface AfterViewInit {
- afterViewInit(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewChecked `LifeCycleEvent.afterViewChecked`}
- * called when the bindings of all its view children have been checked.
- */
- interface AfterViewChecked {
- afterViewChecked(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnChanges `LifeCycleEvent.OnChanges`}
- * called after all of component's bound properties are updated.
- */
- interface OnChanges {
- onChanges(changes: StringMap<string, any>): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnDestroy `LifeCycleEvent.OnDestroy`}
- * called when a directive is being destroyed.
- */
- interface OnDestroy {
- onDestroy(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnInit `LifeCycleEvent.OnInit`}
- * called when a directive is being checked the first time.
- */
- interface OnInit {
- onInit(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#DoCheck `LifeCycleEvent.DoCheck`}
- * called when a directive is being checked.
- */
- interface DoCheck {
- doCheck(): boolean;
- }
- /**
- * Provides a way for expressing ES6 classes with parameter annotations in ES5.
- *
- * ## Basic Example
- *
- * ```
- * var Greeter = ng.Class({
- * constructor: function(name) {
- * this.name = name;
- * },
- *
- * greet: function() {
- * alert('Hello ' + this.name + '!');
- * }
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class Greeter {
- * constructor(name) {
- * this.name = name;
- * }
- *
- * greet() {
- * alert('Hello ' + this.name + '!');
- * }
- * }
- * ```
- *
- * or equivalent to ES5:
- *
- * ```
- * var Greeter = function (name) {
- * this.name = name;
- * }
- *
- * Greeter.prototype.greet = function () {
- * alert('Hello ' + this.name + '!');
- * }
- * ```
- *
- * ## Example with parameter annotations
- *
- * ```
- * var MyService = neg.Class({
- * constructor: [String, [new Query(), QueryList], function(name, queryList) {
- * ...
- * }];
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class MyService {
- * constructor(name: string, @Query() queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example with inheritance
- *
- * ```
- * var Shape = ng.Class({
- * constructor: (color) {
- * this.color = color;
- * }
- * });
- *
- * var Square = ng.Class({
- * extends: Shape,
- * constructor: function(color, size) {
- * Shape.call(this, color);
- * this.size = size;
- * }
- * });
- * ```
- */
- function Class(clsDef: ClassDefinition) : Type ;
- /**
- * Declares the interface to be used with {@link Class}.
- */
- interface ClassDefinition {
- /**
- * Optional argument for specifying the superclass.
- */
- extends?: Type;
- /**
- * Required constructor function for a class.
- *
- * The function may be optionally wrapped in an `Array`, in which case additional parameter
- * annotations may be specified.
- * The number of arguments and the number of parameter annotations must match.
- *
- * See {@link Class} for example of usage.
- */
- constructor: (Function | any[]);
- }
- /**
- * An interface implemented by all Angular type decorators, which allows them to be used as ES7
- * decorators as well as
- * Angular DSL syntax.
- *
- * DSL syntax:
- *
- * ```
- * var MyClass = ng
- * .Component({...})
- * .View({...})
- * .Class({...});
- * ```
- *
- * ES7 syntax:
- *
- * ```
- * @ng.Component({...})
- * @ng.View({...})
- * class MyClass {...}
- * ```
- */
- interface TypeDecorator {
- /**
- * Invoke as ES7 decorator.
- */
- <T extends Type>(type: T): T;
- /**
- * Storage for the accumulated annotations so far used by the DSL syntax.
- *
- * Used by {@link Class} to annotate the generated class.
- */
- annotations: any[];
- /**
- * Generate a class from the definition and annotate it with {@link TypeDecorator#annotations}.
- */
- Class(obj: ClassDefinition): Type;
- }
- enum ChangeDetectionStrategy {
- /**
- * `CheckedOnce` means that after calling detectChanges the mode of the change detector
- * will become `Checked`.
- */
- CheckOnce,
- /**
- * `Checked` means that the change detector should be skipped until its mode changes to
- * `CheckOnce`.
- */
- Checked,
- /**
- * `CheckAlways` means that after calling detectChanges the mode of the change detector
- * will remain `CheckAlways`.
- */
- CheckAlways,
- /**
- * `Detached` means that the change detector sub tree is not a part of the main tree and
- * should be skipped.
- */
- Detached,
- /**
- * `OnPush` means that the change detector's mode will be set to `CheckOnce` during hydration.
- */
- OnPush,
- /**
- * `Default` means that the change detector's mode will be set to `CheckAlways` during hydration.
- */
- Default,
- /**
- * This is an experimental feature. Works only in Dart.
- */
- OnPushObserve
- }
- /**
- * An error thrown if application changes model breaking the top-down data flow.
- *
- * Angular expects that the data flows from top (root) component to child (leaf) components.
- * This is known as directed acyclic graph. This allows Angular to only execute change detection
- * once and prevents loops in change detection data flow.
- *
- * This exception is only thrown in dev mode.
- */
- class ExpressionChangedAfterItHasBeenCheckedException extends BaseException {
- }
- /**
- * Thrown when an expression evaluation raises an exception.
- *
- * This error wraps the original exception, this is done to attach expression location information.
- */
- class ChangeDetectionError extends BaseException {
- /**
- * Location of the expression.
- */
- location: string;
- }
- interface ChangeDetector {
- parent: ChangeDetector;
- mode: ChangeDetectionStrategy;
- ref: ChangeDetectorRef;
- addChild(cd: ChangeDetector): void;
- addShadowDomChild(cd: ChangeDetector): void;
- removeChild(cd: ChangeDetector): void;
- removeShadowDomChild(cd: ChangeDetector): void;
- remove(): void;
- hydrate(context: any, locals: Locals, directives: any, pipes: any): void;
- dehydrate(): void;
- markPathToRootAsCheckOnce(): void;
- handleEvent(eventName: string, elIndex: number, locals: Locals): void;
- detectChanges(): void;
- checkNoChanges(): void;
- }
- class Locals {
- parent: Locals;
- current: Map<any, any>;
- contains(name: string): boolean;
- get(name: string): any;
- set(name: string, value: any): void;
- clearValues(): void;
- }
- /**
- * Controls change detection.
- *
- * {@link ChangeDetectorRef} allows requesting checks for detectors that rely on observables. It
- * also allows detaching and attaching change detector subtrees.
- */
- interface ChangeDetectorRef {
- /**
- * Request to check all OnPush ancestors.
- */
- markForCheck(): void;
- /**
- * Detaches the change detector from the change detector tree.
- *
- * The detached change detector will not be checked until it is reattached.
- */
- detach(): void;
- /**
- * Reattach the change detector to the change detector tree.
- *
- * This also requests a check of this change detector. This reattached change detector will be
- * checked during the next change detection run.
- */
- reattach(): void;
- }
- /**
- * Indicates that the result of a {@link PipeMetadata} transformation has changed even though the
- * reference
- * has not changed.
- *
- * The wrapped value will be unwrapped by change detection, and the unwrapped value will be stored.
- *
- * Example:
- *
- * ```
- * if (this._latestValue === this._latestReturnedValue) {
- * return this._latestReturnedValue;
- * } else {
- * this._latestReturnedValue = this._latestValue;
- * return WrappedValue.wrap(this._latestValue); // this will force update
- * }
- * ```
- */
- class WrappedValue {
- static wrap(value: any): WrappedValue;
- wrapped: any;
- }
- /**
- * An interface which all pipes must implement.
- *
- * #Example
- *
- * ```
- * class DoublePipe implements PipeTransform {
- * transform(value, args = []) {
- * return `${value}${value}`;
- * }
- * }
- * ```
- */
- interface PipeTransform {
- transform(value: any, args: any[]): any;
- }
- /**
- * An interface that stateful pipes should implement.
- *
- * #Example
- *
- * ```
- * class StatefulPipe implements PipeTransform, PipeOnDestroy {
- * connection;
- *
- * onDestroy() {
- * this.connection.release();
- * }
- *
- * transform(value, args = []) {
- * this.connection = createConnection();
- * // ...
- * return someValue;
- * }
- * }
- * ```
- */
- interface PipeOnDestroy {
- onDestroy(): void;
- }
- /**
- * A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
- */
- class IterableDiffers {
- static create(factories: IterableDifferFactory[], parent?: IterableDiffers): IterableDiffers;
- /**
- * Takes an array of {@link IterableDifferFactory} and returns a binding used to extend the
- * inherited {@link IterableDiffers} instance with the provided factories and return a new
- * {@link IterableDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link IterableDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * IterableDiffers.extend([new ImmutableListDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: IterableDifferFactory[]): Binding;
- factories: IterableDifferFactory[];
- find(iterable: Object): IterableDifferFactory;
- }
- interface IterableDiffer {
- diff(object: Object): any;
- onDestroy(): void;
- }
- /**
- * Provides a factory for {@link IterableDiffer}.
- */
- interface IterableDifferFactory {
- supports(objects: Object): boolean;
- create(cdRef: ChangeDetectorRef): IterableDiffer;
- }
- /**
- * A repository of different Map diffing strategies used by NgClass, NgStyle, and others.
- */
- class KeyValueDiffers {
- static create(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers;
- /**
- * Takes an array of {@link KeyValueDifferFactory} and returns a binding used to extend the
- * inherited {@link KeyValueDiffers} instance with the provided factories and return a new
- * {@link KeyValueDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link KeyValueDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * KeyValueDiffers.extend([new ImmutableMapDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: KeyValueDifferFactory[]): Binding;
- factories: KeyValueDifferFactory[];
- find(kv: Object): KeyValueDifferFactory;
- }
- interface KeyValueDiffer {
- diff(object: Object): void;
- onDestroy(): void;
- }
- /**
- * Provides a factory for {@link KeyValueDiffer}.
- */
- interface KeyValueDifferFactory {
- supports(objects: Object): boolean;
- create(cdRef: ChangeDetectorRef): KeyValueDiffer;
- }
- /**
- * An opaque token representing the application root type in the {@link Injector}.
- *
- * ```
- * @Component(...)
- * @View(...)
- * class MyApp {
- * ...
- * }
- *
- * bootstrap(MyApp).then((appRef:ApplicationRef) {
- * expect(appRef.injector.get(appComponentTypeToken)).toEqual(MyApp);
- * });
- *
- * ```
- */
- const APP_COMPONENT : OpaqueToken ;
- /**
- * Runtime representation of a type.
- *
- * In JavaScript a Type is a constructor function.
- */
- interface Type extends Function {
- new(...args: any[]): any;
- }
- /**
- * Represents a Angular's representation of an Application.
- *
- * `ApplicationRef` represents a running application instance. Use it to retrieve the host
- * component, injector,
- * or dispose of an application.
- */
- interface ApplicationRef {
- /**
- * Returns the current {@link ComponentMetadata} type.
- */
- hostComponentType: Type;
- /**
- * Returns the current {@link ComponentMetadata} instance.
- */
- hostComponent: any;
- /**
- * Dispose (un-load) the application.
- */
- dispose(): void;
- /**
- * Returns the root application {@link Injector}.
- */
- injector: Injector;
- }
- /**
- * Specifies app root url for the application.
- *
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class AppRootUrl {
- /**
- * Returns the base URL of the currently running application.
- */
- value: any;
- }
- /**
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class UrlResolver {
- /**
- * Resolves the `url` given the `baseUrl`:
- * - when the `url` is null, the `baseUrl` is returned,
- * - if `url` is relative ('path/to/here', './path/to/here'), the resolved url is a combination of
- * `baseUrl` and `url`,
- * - if `url` is absolute (it has a scheme: 'http://', 'https://' or start with '/'), the `url` is
- * returned as is (ignoring the `baseUrl`)
- *
- * @param {string} baseUrl
- * @param {string} url
- * @returns {string} the resolved URL
- */
- resolve(baseUrl: string, url: string): string;
- }
- /**
- * Resolve a `Type` from a {@link ComponentMetadata} into a URL.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class ComponentUrlMapper {
- /**
- * Returns the base URL to the component source file.
- * The returned URL could be:
- * - an absolute URL,
- * - a path relative to the application
- */
- getUrl(component: Type): string;
- }
- /**
- * Resolve a `Type` for {@link DirectiveMetadata}.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class DirectiveResolver {
- /**
- * Return {@link DirectiveMetadata} for a given `Type`.
- */
- resolve(type: Type): DirectiveMetadata;
- }
- /**
- * ## URL Resolution
- *
- * ```
- * var appRootUrl: AppRootUrl = ...;
- * var componentUrlMapper: ComponentUrlMapper = ...;
- * var urlResolver: UrlResolver = ...;
- *
- * var componentType: Type = ...;
- * var componentAnnotation: ComponentAnnotation = ...;
- * var viewAnnotation: ViewAnnotation = ...;
- *
- * // Resolving a URL
- *
- * var url = viewAnnotation.templateUrl;
- * var componentUrl = componentUrlMapper.getUrl(componentType);
- * var componentResolvedUrl = urlResolver.resolve(appRootUrl.value, componentUrl);
- * var templateResolvedUrl = urlResolver.resolve(componetResolvedUrl, url);
- * ```
- */
- interface Compiler {
- compileInHost(componentTypeOrBinding: Type | Binding): Promise<ProtoViewRef>;
- }
- /**
- * Entry point for creating, moving views in the view hierarchy and destroying views.
- * This manager contains all recursion and delegates to helper methods
- * in AppViewManagerUtils and the Renderer, so unit tests get simpler.
- */
- interface AppViewManager {
- /**
- * Returns a {@link ViewContainerRef} at the {@link ElementRef} location.
- */
- getViewContainer(location: ElementRef): ViewContainerRef;
- /**
- * Return the first child element of the host element view.
- */
- getHostElement(hostViewRef: HostViewRef): ElementRef;
- /**
- * Returns an ElementRef for the element with the given variable name
- * in the current view.
- *
- * - `hostLocation`: {@link ElementRef} of any element in the View which defines the scope of
- * search.
- * - `variableName`: Name of the variable to locate.
- * - Returns {@link ElementRef} of the found element or null. (Throws if not found.)
- */
- getNamedElementInComponentView(hostLocation: ElementRef, variableName: string): ElementRef;
- /**
- * Returns the component instance for a given element.
- *
- * The component is the execution context as seen by an expression at that {@link ElementRef}
- * location.
- */
- getComponent(hostLocation: ElementRef): any;
- /**
- * Load component view into existing element.
- *
- * Use this if a host element is already in the DOM and it is necessary to upgrade
- * the element into Angular component by attaching a view but reusing the existing element.
- *
- * - `hostProtoViewRef`: {@link ProtoViewRef} Proto view to use in creating a view for this
- * component.
- * - `overrideSelector`: (optional) selector to use in locating the existing element to load
- * the view into. If not specified use the selector in the component definition of the
- * `hostProtoView`.
- * - injector: {@link Injector} to use as parent injector for the view.
- *
- * See {@link AppViewManager#destroyRootHostView}.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- *
- * }
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<some-component></some-component>)
- * `
- * })
- * class MyApp {
- * viewRef: ng.ViewRef;
- *
- * constructor(public appViewManager: ng.AppViewManager, compiler: ng.Compiler) {
- * compiler.compileInHost(ChildComponent).then((protoView: ng.ProtoViewRef) => {
- * this.viewRef = appViewManager.createRootHostView(protoView, 'some-component', null);
- * })
- * }
- *
- * onDestroy() {
- * this.appViewManager.destroyRootHostView(this.viewRef);
- * this.viewRef = null;
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- */
- createRootHostView(hostProtoViewRef: ProtoViewRef, overrideSelector: string, injector: Injector): HostViewRef;
- /**
- * Remove the View created with {@link AppViewManager#createRootHostView}.
- */
- destroyRootHostView(hostViewRef: HostViewRef): void;
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createEmbeddedViewInContainer(viewContainerLocation: ElementRef, atIndex: number, templateRef: TemplateRef): ViewRef;
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createHostViewInContainer(viewContainerLocation: ElementRef, atIndex: number, protoViewRef: ProtoViewRef, imperativelyCreatedInjector: ResolvedBinding[]): HostViewRef;
- /**
- * See {@link AppViewManager#createViewInContainer}.
- */
- destroyViewInContainer(viewContainerLocation: ElementRef, atIndex: number): void;
- /**
- * See {@link AppViewManager#detachViewInContainer}.
- */
- attachViewInContainer(viewContainerLocation: ElementRef, atIndex: number, viewRef: ViewRef): ViewRef;
- /**
- * See {@link AppViewManager#attachViewInContainer}.
- */
- detachViewInContainer(viewContainerLocation: ElementRef, atIndex: number): ViewRef;
- }
- /**
- * An iterable and observable live list of components in the DOM.
- *
- * A QueryList contains a live list of child directives in the DOM of a directive.
- * The directives are kept in depth-first pre-order traversal of the DOM.
- *
- * The `QueryList` is iterable, therefore it can be used in both javascript code with `for..of` loop
- * as well as in template with `*ng-for="of"` directive.
- *
- * QueryList is updated as part of the change-detection cycle of a directive. Since change detection
- * happens after construction of a directive, QueryList will always be empty when observed in the
- * constructor.
- *
- *
- * NOTE: In the future this class will implement an `Observable` interface. For now it uses a plain
- * list of observable callbacks.
- *
- * # Example:
- *
- * Assume that `<tabs>` component would like to get a list its children which are `<pane>`
- * components as shown in this example:
- *
- * ```html
- * <tabs>
- * <pane title="Overview">...</pane>
- * <pane *ng-for="#o of objects" [title]="o.title">{{o.text}}</pane>
- * </tabs>
- * ```
- *
- * In the above example the list of `<tabs>` elements needs to get a list of `<pane>` elements so
- * that it could render tabs with the correct titles and in the correct order.
- *
- * A possible solution would be for a `<pane>` to inject `<tabs>` component and then register itself
- * with `<tabs>` component's on `hydrate` and deregister on `dehydrate` event. While a reasonable
- * approach, this would only work partialy since `*ng-for` could rearrange the list of `<pane>`
- * components which would not be reported to `<tabs>` component and thus the list of `<pane>`
- * components would be out of sync with respect to the list of `<pane>` elements.
- *
- * A preferred solution is to inject a `QueryList` which is a live list of directives in the
- * component`s light DOM.
- *
- * ```javascript
- * @Component({
- * selector: 'tabs'
- * })
- * @View({
- * template: `
- * <ul>
- * <li *ng-for="#pane of panes">{{pane.title}}</li>
- * </ul>
- * <content></content>
- * `
- * })
- * class Tabs {
- * panes: QueryList<Pane>
- *
- * constructor(@Query(Pane) panes:QueryList<Pane>) {
- * this.panes = panes;
- * }
- * }
- *
- * @Component({
- * selector: 'pane',
- * properties: ['title']
- * })
- * @View(...)
- * class Pane {
- * title:string;
- * }
- * ```
- */
- class QueryList<T> {
- reset(newList: T[]): void;
- add(obj: T): void;
- fireCallbacks(): void;
- onChange(callback: () => void): void;
- removeCallback(callback: () => void): void;
- toString(): string;
- length: number;
- first: T;
- last: T;
- map<U>(fn: (item: T) => U): U[];
- }
- /**
- * Service for dynamically loading a Component into an arbitrary position in the internal Angular
- * application tree.
- */
- class DynamicComponentLoader {
- /**
- * Loads a root component that is placed at the first element that matches the component's
- * selector.
- *
- * - `typeOrBinding` `Type` \ {@link Binding} - representing the component to load.
- * - `overrideSelector` (optional) selector to load the component at (or use
- * `@Component.selector`) The selector can be anywhere (i.e. outside the current component.)
- * - `injector` {@link Injector} - optional injector to use for the component.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<child id="child"></child>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, injector: ng.Injector) {
- * dynamicComponentLoader.loadAsRoot(ChildComponent, '#child', injector);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <child id="child">
- * Child
- * </child>
- * )
- * </my-app>
- * ```
- */
- loadAsRoot(typeOrBinding: Type | Binding, overrideSelector: string, injector: Injector): Promise<ComponentRef>;
- /**
- * Loads a component into the component view of the provided ElementRef next to the element
- * with the given name.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<div #child></div>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <div #child="" class="ng-binding"></div>
- * <child-component class="ng-binding">Child</child-component>
- * )
- * </my-app>
- * ```
- */
- loadIntoLocation(typeOrBinding: Type | Binding, hostLocation: ElementRef, anchorName: string, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
- /**
- * Loads a component next to the provided ElementRef.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `Parent`
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>Parent</my-app>
- * <child-component>Child</child-component>
- * ```
- */
- loadNextToLocation(typeOrBinding: Type | Binding, location: ElementRef, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
- }
- /**
- * Provides access to explicitly trigger change detection in an application.
- *
- * By default, `Zone` triggers change detection in Angular on each virtual machine (VM) turn. When
- * testing, or in some
- * limited application use cases, a developer can also trigger change detection with the
- * `lifecycle.tick()` method.
- *
- * Each Angular application has a single `LifeCycle` instance.
- *
- * # Example
- *
- * This is a contrived example, since the bootstrap automatically runs inside of the `Zone`, which
- * invokes
- * `lifecycle.tick()` on your behalf.
- *
- * ```javascript
- * bootstrap(MyApp).then((ref:ComponentRef) => {
- * var lifeCycle = ref.injector.get(LifeCycle);
- * var myApp = ref.instance;
- *
- * ref.doSomething();
- * lifecycle.tick();
- * });
- * ```
- */
- class LifeCycle {
- /**
- * @private
- */
- registerWith(zone: NgZone, changeDetector?: ChangeDetector): void;
- /**
- * Invoke this method to explicitly process change detection and its side-effects.
- *
- * In development mode, `tick()` also performs a second change detection cycle to ensure that no
- * further
- * changes are detected. If additional changes are picked up during this second cycle, bindings
- * in
- * the app have
- * side-effects that cannot be resolved in a single change detection pass. In this case, Angular
- * throws an error,
- * since an Angular application can only have one change detection pass during which all change
- * detection must
- * complete.
- */
- tick(): void;
- }
- /**
- * Reference to the element.
- *
- * Represents an opaque reference to the underlying element. The element is a DOM ELement in
- * a Browser, but may represent other types on other rendering platforms. In the browser the
- * `ElementRef` can be sent to the web-worker. Web Workers can not have references to the
- * DOM Elements.
- */
- class ElementRef implements RenderElementRef {
- /**
- * Reference to the {@link ViewRef} where the `ElementRef` is inside of.
- */
- parentView: ViewRef;
- /**
- * Index of the element inside the {@link ViewRef}.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- boundElementIndex: number;
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
- renderView: RenderViewRef;
- /**
- * Returns the native Element implementation.
- *
- * In the browser this represents the DOM Element.
- *
- * The `nativeElement` can be used as an escape hatch when direct DOM manipulation is needed. Use
- * this with caution, as it creates tight coupling between your application and the Browser, which
- * will not work in WebWorkers.
- *
- * NOTE: This method will return null in the webworker scenario!
- */
- nativeElement: any;
- }
- /**
- * Reference to a template within a component.
- *
- * Represents an opaque reference to the underlying template that can
- * be instantiated using the {@link ViewContainerRef}.
- */
- class TemplateRef {
- /**
- * The location of the template
- */
- elementRef: ElementRef;
- protoViewRef: ProtoViewRef;
- /**
- * Whether this template has a local variable with the given name
- */
- hasLocal(name: string): boolean;
- }
- /**
- * A reference to an Angular View.
- *
- * A View is a fundamental building block of Application UI. A View is the smallest set of
- * elements which are created and destroyed together. A View can change properties on the elements
- * within the view, but it can not change the structure of those elements.
- *
- * To change structure of the elements, the Views can contain zero or more {@link ViewContainerRef}s
- * which allow the views to be nested.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- *
- * The outter/inner {@link ProtoViewRef}s are then assembled into views like so:
- *
- * ```
- * <!-- ViewRef: outer-0 -->
- * Count: 2
- * <ul>
- * <template view-container-ref></template>
- * <!-- ViewRef: inner-1 --><li>first</li><!-- /ViewRef: inner-1 -->
- * <!-- ViewRef: inner-2 --><li>second</li><!-- /ViewRef: inner-2 -->
- * </ul>
- * <!-- /ViewRef: outer-0 -->
- * ```
- */
- interface ViewRef extends HostViewRef {
- /**
- * Return `RenderViewRef`
- */
- render: RenderViewRef;
- /**
- * Return `RenderFragmentRef`
- */
- renderFragment: RenderFragmentRef;
- /**
- * Set local variable in a view.
- *
- * - `contextName` - Name of the local variable in a view.
- * - `value` - Value for the local variable in a view.
- */
- setLocal(contextName: string, value: any): void;
- }
- interface HostViewRef {
- }
- /**
- * A reference to an Angular ProtoView.
- *
- * A ProtoView is a reference to a template for easy creation of views.
- * (See {@link AppViewManager#createViewInContainer `AppViewManager#createViewInContainer`} and
- * {@link AppViewManager#createRootHostView `AppViewManager#createRootHostView`}).
- *
- * A `ProtoView` is a factory for creating `View`s.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- */
- interface ProtoViewRef {
- }
- /**
- * A location where {@link ViewRef}s can be attached.
- *
- * A `ViewContainerRef` represents a location in a {@link ViewRef} where other child
- * {@link ViewRef}s can be inserted. Adding and removing views is the only way of structurally
- * changing the rendered DOM of the application.
- */
- interface ViewContainerRef {
- viewManager: AppViewManager;
- element: ElementRef;
- /**
- * Remove all {@link ViewRef}s at current location.
- */
- clear(): void;
- /**
- * Return a {@link ViewRef} at specific index.
- */
- get(index: number): ViewRef;
- /**
- * Returns number of {@link ViewRef}s currently attached at this location.
- */
- length: number;
- /**
- * Create and insert a {@link ViewRef} into the view-container.
- *
- * - `protoViewRef` (optional) {@link ProtoViewRef} - The `ProtoView` to use for creating
- * `View` to be inserted at this location. If `ViewContainer` is created at a location
- * of inline template, then `protoViewRef` is the `ProtoView` of the template.
- * - `atIndex` (optional) `number` - location of insertion point. (Or at the end if unspecified.)
- * - `context` (optional) {@link ElementRef} - Context (for expression evaluation) from the
- * {@link ElementRef} location. (Or current context if unspecified.)
- * - `bindings` (optional) Array of {@link ResolvedBinding} - Used for configuring
- * `ElementInjector`.
- *
- * Returns newly created {@link ViewRef}.
- */
- createEmbeddedView(templateRef: TemplateRef, atIndex?: number): ViewRef;
- createHostView(protoViewRef?: ProtoViewRef, atIndex?: number, dynamicallyCreatedBindings?: ResolvedBinding[]): HostViewRef;
- /**
- * Insert a {@link ViewRef} at specefic index.
- *
- * The index is location at which the {@link ViewRef} should be attached. If omitted it is
- * inserted at the end.
- *
- * Returns the inserted {@link ViewRef}.
- */
- insert(viewRef: ViewRef, atIndex?: number): ViewRef;
- /**
- * Return the index of already inserted {@link ViewRef}.
- */
- indexOf(viewRef: ViewRef): number;
- /**
- * Remove a {@link ViewRef} at specific index.
- *
- * If the index is omitted last {@link ViewRef} is removed.
- */
- remove(atIndex?: number): void;
- /**
- * The method can be used together with insert to implement a view move, i.e.
- * moving the dom nodes while the directives in the view stay intact.
- */
- detach(atIndex?: number): ViewRef;
- }
- /**
- * Angular's reference to a component instance.
- *
- * `ComponentRef` represents a component instance lifecycle and meta information.
- */
- interface ComponentRef {
- /**
- * Location of the component host element.
- */
- location: ElementRef;
- /**
- * Instance of component.
- */
- instance: any;
- /**
- * Returns the host {@link ViewRef}.
- */
- hostView: HostViewRef;
- /**
- * Dispose of the component instance.
- */
- dispose(): void;
- }
- /**
- * A wrapper around zones that lets you schedule tasks after it has executed a task.
- *
- * The wrapper maintains an "inner" and an "mount" `Zone`. The application code will executes
- * in the "inner" zone unless `runOutsideAngular` is explicitely called.
- *
- * A typical application will create a singleton `NgZone`. The outer `Zone` is a fork of the root
- * `Zone`. The default `onTurnDone` runs the Angular change detection.
- */
- class NgZone {
- /**
- * Sets the zone hook that is called just before Angular event turn starts.
- * It is called once per browser event.
- */
- overrideOnTurnStart(onTurnStartFn: Function): void;
- /**
- * Sets the zone hook that is called immediately after Angular processes
- * all pending microtasks.
- */
- overrideOnTurnDone(onTurnDoneFn: Function): void;
- /**
- * Sets the zone hook that is called immediately after the last turn in
- * an event completes. At this point Angular will no longer attempt to
- * sync the UI. Any changes to the data model will not be reflected in the
- * DOM. `onEventDoneFn` is executed outside Angular zone.
- *
- * This hook is useful for validating application state (e.g. in a test).
- */
- overrideOnEventDone(onEventDoneFn: Function, opt_waitForAsync: boolean): void;
- /**
- * Sets the zone hook that is called when an error is uncaught in the
- * Angular zone. The first argument is the error. The second argument is
- * the stack trace.
- */
- overrideOnErrorHandler(errorHandlingFn: Function): void;
- /**
- * Runs `fn` in the inner zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to make use of the
- * Angular's auto digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.run(() => {
- * // the change detection will run after this function and the microtasks it enqueues have
- * executed.
- * });
- * ```
- */
- run(fn: () => any): any;
- /**
- * Runs `fn` in the outer zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to escape Angular's
- * auto-digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.runOutsideAngular(() => {
- * element.onClick(() => {
- * // Clicking on the element would not trigger the change detection
- * });
- * });
- * ```
- */
- runOutsideAngular(fn: () => any): any;
- }
- class Observable {
- observer(generator: any): Object;
- }
- /**
- * Use Rx.Observable but provides an adapter to make it work as specified here:
- * https://github.com/jhusain/observable-spec
- *
- * Once a reference implementation of the spec is available, switch to it.
- */
- class EventEmitter extends Observable {
- observer(generator: any): Rx.IDisposable;
- toRx(): Rx.Observable<any>;
- next(value: any): void;
- throw(error: any): void;
- return(value?: any): void;
- }
- /**
- * A parameter metadata that specifies a dependency.
- *
- * ```
- * class AComponent {
- * constructor(@Inject(MyService) aService:MyService) {}
- * }
- * ```
- */
- class InjectMetadata {
- token: any;
- toString(): string;
- }
- /**
- * A parameter metadata that marks a dependency as optional. {@link Injector} provides `null` if
- * the dependency is not found.
- *
- * ```
- * class AComponent {
- * constructor(@Optional() aService:MyService) {
- * this.aService = aService;
- * }
- * }
- * ```
- */
- class OptionalMetadata {
- toString(): string;
- }
- /**
- * A marker metadata that marks a class as available to `Injector` for creation. Used by tooling
- * for generating constructor stubs.
- *
- * ```
- * class NeedsService {
- * constructor(svc:UsefulService) {}
- * }
- *
- * @Injectable
- * class UsefulService {}
- * ```
- */
- class InjectableMetadata {
- }
- /**
- * Specifies that an injector should retrieve a dependency from itself.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Self() dependency:Dependency) {}
- * }
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * var nd = inj.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(Dependency);
- * ```
- */
- class SelfMetadata {
- toString(): string;
- }
- /**
- * Specifies that an injector should retrieve a dependency from any injector until reaching the
- * closest host.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Host() dependency:Dependency) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Dependency).toClass(HostDependency)
- * ]);
- * var child = parent.resolveAndCreateChild([]);
- * var grandChild = child.resolveAndCreateChild([NeedsDependency, Depedency]);
- * var nd = grandChild.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(HostDependency);
- * ```
- */
- class HostMetadata {
- toString(): string;
- }
- /**
- * Specifies that the dependency resolution should start from the parent injector.
- *
- * ## Example
- *
- *
- * ```
- * class Service {}
- *
- * class ParentService implements Service {
- * }
- *
- * class ChildService implements Service {
- * constructor(public @SkipSelf() parentService:Service) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Service).toClass(ParentService)
- * ]);
- * var child = parent.resolveAndCreateChild([
- * bind(Service).toClass(ChildSerice)
- * ]);
- * var s = child.get(Service);
- * expect(s).toBeAnInstanceOf(ChildService);
- * expect(s.parentService).toBeAnInstanceOf(ParentService);
- * ```
- */
- class SkipSelfMetadata {
- toString(): string;
- }
- /**
- * `DependencyMetadata is used by the framework to extend DI.
- *
- * Only metadata implementing `DependencyMetadata` are added to the list of dependency
- * properties.
- *
- * For example:
- *
- * ```
- * class Exclude extends DependencyMetadata {}
- * class NotDependencyProperty {}
- *
- * class AComponent {
- * constructor(@Exclude @NotDependencyProperty aService:AService) {}
- * }
- * ```
- *
- * will create the following dependency:
- *
- * ```
- * new Dependency(Key.get(AService), [new Exclude()])
- * ```
- *
- * The framework can use `new Exclude()` to handle the `aService` dependency
- * in a specific way.
- */
- class DependencyMetadata {
- token: any;
- }
- /**
- * Allows to refer to references which are not yet defined.
- *
- * This situation arises when the key which we need te refer to for the purposes of DI is declared,
- * but not yet defined.
- *
- * ## Example:
- *
- * ```
- * class Door {
- * // Incorrect way to refer to a reference which is defined later.
- * // This fails because `Lock` is undefined at this point.
- * constructor(lock:Lock) { }
- *
- * // Correct way to refer to a reference which is defined later.
- * // The reference needs to be captured in a closure.
- * constructor(@Inject(forwardRef(() => Lock)) lock:Lock) { }
- * }
- *
- * // Only at this point the lock is defined.
- * class Lock {
- * }
- * ```
- */
- function forwardRef(forwardRefFn: ForwardRefFn) : Type ;
- /**
- * Lazily retrieve the reference value.
- *
- * See: {@link forwardRef}
- */
- function resolveForwardRef(type: any) : any ;
- interface ForwardRefFn {
- (): any;
- }
- /**
- * A dependency injection container used for resolving dependencies.
- *
- * An `Injector` is a replacement for a `new` operator, which can automatically resolve the
- * constructor dependencies.
- * In typical use, application code asks for the dependencies in the constructor and they are
- * resolved by the `Injector`.
- *
- * ## Example:
- *
- * Suppose that we want to inject an `Engine` into class `Car`, we would define it like this:
- *
- * ```javascript
- * class Engine {
- * }
- *
- * class Car {
- * constructor(@Inject(Engine) engine) {
- * }
- * }
- *
- * ```
- *
- * Next we need to write the code that creates and instantiates the `Injector`. We then ask for the
- * `root` object, `Car`, so that the `Injector` can recursively build all of that object's
- * dependencies.
- *
- * ```javascript
- * main() {
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- *
- * // Get a reference to the `root` object, which will recursively instantiate the tree.
- * var car = injector.get(Car);
- * }
- * ```
- * Notice that we don't use the `new` operator because we explicitly want to have the `Injector`
- * resolve all of the object's dependencies automatically.
- */
- class Injector {
- /**
- * Turns a list of binding definitions into an internal resolved list of resolved bindings.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- *
- * The returned list is sparse, indexed by `id` for the {@link Key}. It is generally not useful to
- * application code
- * other than for passing it to {@link Injector} functions that require resolved binding lists,
- * such as
- * `fromResolvedBindings` and `createChildFromResolved`.
- */
- static resolve(bindings: Array<Type | Binding | any[]>): ResolvedBinding[];
- /**
- * Resolves bindings and creates an injector based on those bindings. This function is slower than
- * the corresponding `fromResolvedBindings` because it needs to resolve bindings first. See
- * `resolve`
- * for the {@link Injector}.
- *
- * Prefer `fromResolvedBindings` in performance-critical code that creates lots of injectors.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more
- * bindings.
- * @param `depProvider`
- */
- static resolveAndCreate(bindings: Array<Type | Binding | any[]>, depProvider?: DependencyProvider): Injector;
- /**
- * Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
- * {@link Injector}.
- * @param `depProvider`
- */
- static fromResolvedBindings(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
- /**
- * Returns debug information about the injector.
- *
- * This information is included into exceptions thrown by the injector.
- */
- debugContext(): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually the `Type` of an object. (Same as the token used while setting up a
- * binding).
- * @returns an instance represented by the token. Throws if not found.
- */
- get(token: any): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually a `Type`. (Same as the token used while setting up a binding).
- * @returns an instance represented by the token. Returns `null` if not found.
- */
- getOptional(token: any): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `index`: index of an instance.
- * @returns an instance represented by the index. Throws if not found.
- */
- getAt(index: number): any;
- /**
- * Direct parent of this injector.
- */
- parent: Injector;
- /**
- * Internal. Do not use.
- *
- * We return `any` not to export the InjectorStrategy type.
- */
- internalStrategy: any;
- /**
- * Creates a child injector and loads a new set of bindings into it.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- * @param `depProvider`
- */
- resolveAndCreateChild(bindings: Array<Type | Binding | any[]>, depProvider?: DependencyProvider): Injector;
- /**
- * Creates a child injector and loads a new set of {@link ResolvedBinding}s into it.
- *
- * @param `bindings`: A sparse list of {@link ResolvedBinding}s.
- * See `resolve` for the {@link Injector}.
- * @param `depProvider`
- * @returns a new child {@link Injector}.
- */
- createChildFromResolved(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
- /**
- * Resolves a binding and instantiates an object in the context of the injector.
- *
- * @param `binding`: either a type or a binding.
- * @returns an object created using binding.
- */
- resolveAndInstantiate(binding: Type | Binding): any;
- /**
- * Instantiates an object using a resolved bindin in the context of the injector.
- *
- * @param `binding`: a resolved binding
- * @returns an object created using binding.
- */
- instantiateResolved(binding: ResolvedBinding): any;
- displayName: string;
- toString(): string;
- }
- class ProtoInjector {
- numberOfBindings: number;
- getBindingAtIndex(index: number): any;
- }
- class BindingWithVisibility {
- binding: ResolvedBinding;
- visibility: Visibility;
- getKeyId(): number;
- }
- /**
- * Used to provide dependencies that cannot be easily expressed as bindings.
- */
- interface DependencyProvider {
- getDependency(injector: Injector, binding: ResolvedBinding, dependency: Dependency): any;
- }
- enum Visibility {
- Public,
- Private,
- PublicAndPrivate
- }
- const UNDEFINED : Object ;
- /**
- * Describes how_ the {@link Injector} should instantiate a given token.
- *
- * See {@link bind}.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- class Binding {
- /**
- * Token used when retrieving this binding. Usually the `Type`.
- */
- token: any;
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass: Type;
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue: any;
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that {@link Injector} returns the same instance as if the alias token was used.
- * This is in contrast to `toClass` where a separate instance of `toClass` is returned.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias: any;
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory: Function;
- /**
- * Used in conjunction with `toFactory` and specifies a set of dependencies
- * (as `token`s) which should be injected into the factory function.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- dependencies: any[];
- /**
- * Converts the {@link Binding} into {@link ResolvedBinding}.
- *
- * {@link Injector} internally only uses {@link ResolvedBinding}, {@link Binding} contains
- * convenience binding syntax.
- */
- resolve(): ResolvedBinding;
- }
- /**
- * Helper class for the {@link bind} function.
- */
- class BindingBuilder {
- token: any;
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass(type: Type): Binding;
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(String).toValue('Hello')
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue(value: any): Binding;
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that we will return the same instance as if the alias token was used. (This is
- * in contrast to `toClass` where a separate instance of `toClass` will be returned.)
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias(aliasToken: /*Type*/ any): Binding;
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(Number).toFactory(() => { return 1+2; }),
- * bind(String).toFactory((v) => { return "Value: " + v; }, [Number])
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory(factoryFunction: Function, dependencies?: any[]): Binding;
- }
- /**
- * An internal resolved representation of a {@link Binding} used by the {@link Injector}.
- *
- * A {@link Binding} is resolved when it has a factory function. Binding to a class, alias, or
- * value, are just convenience methods, as {@link Injector} only operates on calling factory
- * functions.
- */
- class ResolvedBinding {
- /**
- * A key, usually a `Type`.
- */
- key: Key;
- /**
- * Factory function which can return an instance of an object represented by a key.
- */
- factory: Function;
- /**
- * Arguments (dependencies) to the `factory` function.
- */
- dependencies: Dependency[];
- }
- /**
- * @private
- */
- class Dependency {
- static fromKey(key: Key): Dependency;
- key: Key;
- optional: boolean;
- lowerBoundVisibility: any;
- upperBoundVisibility: any;
- properties: any[];
- }
- /**
- * Provides an API for imperatively constructing {@link Binding}s.
- *
- * This is only relevant for JavaScript. See {@link BindingBuilder}.
- *
- * ## Example
- *
- * ```javascript
- * bind(MyInterface).toClass(MyClass)
- *
- * ```
- */
- function bind(token: any) : BindingBuilder ;
- /**
- * A unique object used for retrieving items from the {@link Injector}.
- *
- * Keys have:
- * - a system-wide unique `id`.
- * - a `token`, usually the `Type` of the instance.
- *
- * Keys are used internally by the {@link Injector} because their system-wide unique `id`s allow the
- * injector to index in arrays rather than looking up items in maps.
- */
- class Key {
- /**
- * Retrieves a `Key` for a token.
- */
- static get(token: Object): Key;
- /**
- * @returns the number of keys registered in the system.
- */
- static numberOfKeys: number;
- token: Object;
- id: number;
- displayName: string;
- }
- /**
- * @private
- */
- class KeyRegistry {
- get(token: Object): Key;
- numberOfKeys: number;
- }
- /**
- * Type literals is a Dart-only feature. This is here only so we can x-compile
- * to multiple languages.
- */
- class TypeLiteral {
- type: any;
- }
- /**
- * Thrown when trying to retrieve a dependency by `Key` from {@link Injector}, but the
- * {@link Injector} does not have a {@link Binding} for {@link Key}.
- */
- class NoBindingError extends AbstractBindingError {
- }
- /**
- * Base class for all errors arising from misconfigured bindings.
- */
- class AbstractBindingError extends BaseException {
- name: string;
- message: string;
- keys: Key[];
- injectors: Injector[];
- constructResolvingMessage: Function;
- addKey(injector: Injector, key: Key): void;
- context: any;
- toString(): string;
- }
- /**
- * Thrown when dependencies form a cycle.
- *
- * ## Example:
- *
- * ```javascript
- * class A {
- * constructor(b:B) {}
- * }
- * class B {
- * constructor(a:A) {}
- * }
- * ```
- *
- * Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
- */
- class CyclicDependencyError extends AbstractBindingError {
- }
- /**
- * Thrown when a constructing type returns with an Error.
- *
- * The `InstantiationError` class contains the original error plus the dependency graph which caused
- * this object to be instantiated.
- */
- class InstantiationError extends AbstractBindingError {
- causeKey: Key;
- }
- /**
- * Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
- * creation.
- */
- class InvalidBindingError extends BaseException {
- message: string;
- toString(): string;
- }
- /**
- * Thrown when the class has no annotation information.
- *
- * Lack of annotation information prevents the {@link Injector} from determining which dependencies
- * need to be injected into the constructor.
- */
- class NoAnnotationError extends BaseException {
- name: string;
- message: string;
- toString(): string;
- }
- /**
- * Thrown when getting an object by index.
- */
- class OutOfBoundsError extends BaseException {
- message: string;
- toString(): string;
- }
- class OpaqueToken {
- toString(): string;
- }
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- interface InjectFactory {
- new(token: any): InjectMetadata;
- (token: any): any;
- }
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- interface OptionalFactory {
- new(): OptionalMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- interface InjectableFactory {
- new(): InjectableMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- interface SelfFactory {
- new(): SelfMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link HostMetadata}.
- */
- interface HostFactory {
- new(): HostMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- interface SkipSelfFactory {
- new(): SkipSelfMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- var Inject : InjectFactory ;
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- var Optional : OptionalFactory ;
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- var Injectable : InjectableFactory ;
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- var Self : SelfFactory ;
- /**
- * Factory for creating {@link HostMetadata}.
- */
- var Host : HostFactory ;
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- var SkipSelf : SkipSelfFactory ;
- /**
- * A collection of the Angular core directives that are likely to be used in each and every Angular
- * application.
- *
- * This collection can be used to quickly enumerate all the built-in directives in the `@View`
- * annotation. For example,
- * instead of writing:
- *
- * ```
- * import {NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- * one could import all the core directives at once:
- *
- * ```
- * import {CORE_DIRECTIVES} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [CORE_DIRECTIVES, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- */
- const CORE_DIRECTIVES : Type[] ;
- /**
- * Adds and removes CSS classes based on an {expression} value.
- *
- * The result of expression is used to add and remove CSS classes using the following logic,
- * based on expression's value type:
- * - {string} - all the CSS classes (space - separated) are added
- * - {Array} - all the CSS classes (Array elements) are added
- * - {Object} - each key corresponds to a CSS class name while values
- * are interpreted as {boolean} expression. If a given expression
- * evaluates to {true} a corresponding CSS class is added - otherwise
- * it is removed.
- *
- * # Example:
- *
- * ```
- * <div class="message" [ng-class]="{error: errorCount > 0}">
- * Please check errors.
- * </div>
- * ```
- */
- class NgClass {
- initialClasses: any;
- rawClass: any;
- doCheck(): void;
- onDestroy(): void;
- }
- /**
- * The `NgFor` directive instantiates a template once per item from an iterable. The context for
- * each instantiated template inherits from the outer context with the given loop variable set
- * to the current item from the iterable.
- *
- * It is possible to alias the `index` to a local variable that will be set to the current loop
- * iteration in the template context.
- *
- * When the contents of the iterator changes, `NgFor` makes the corresponding changes to the DOM:
- *
- * * When an item is added, a new instance of the template is added to the DOM.
- * * When an item is removed, its template instance is removed from the DOM.
- * * When items are reordered, their respective templates are reordered in the DOM.
- *
- * # Example
- *
- * ```
- * <ul>
- * <li *ng-for="#error of errors; #i = index">
- * Error {{i}} of {{errors.length}}: {{error.message}}
- * </li>
- * </ul>
- * ```
- *
- * # Syntax
- *
- * - `<li *ng-for="#item of items; #i = index">...</li>`
- * - `<li template="ng-for #item of items; #i = index">...</li>`
- * - `<template ng-for #item [ng-for-of]="items" #i="index"><li>...</li></template>`
- */
- class NgFor {
- static bulkRemove(tuples: RecordViewTuple[], viewContainer: ViewContainerRef): RecordViewTuple[];
- static bulkInsert(tuples: RecordViewTuple[], viewContainer: ViewContainerRef, templateRef: TemplateRef): RecordViewTuple[];
- viewContainer: ViewContainerRef;
- templateRef: TemplateRef;
- iterableDiffers: IterableDiffers;
- cdr: ChangeDetectorRef;
- ngForOf: any;
- doCheck(): void;
- }
- class RecordViewTuple {
- view: ViewRef;
- record: any;
- }
- /**
- * Removes or recreates a portion of the DOM tree based on an {expression}.
- *
- * If the expression assigned to `ng-if` evaluates to a false value then the element
- * is removed from the DOM, otherwise a clone of the element is reinserted into the DOM.
- *
- * # Example:
- *
- * ```
- * <div *ng-if="errorCount > 0" class="error">
- * <!-- Error message displayed when the errorCount property on the current context is greater
- * than 0. -->
- * {{errorCount}} errors detected
- * </div>
- * ```
- *
- * # Syntax
- *
- * - `<div *ng-if="condition">...</div>`
- * - `<div template="ng-if condition">...</div>`
- * - `<template [ng-if]="condition"><div>...</div></template>`
- */
- class NgIf {
- ngIf: any;
- }
- /**
- * The `NgNonBindable` directive tells Angular not to compile or bind the contents of the current
- * DOM element. This is useful if the element contains what appears to be Angular directives and
- * bindings but which should be ignored by Angular. This could be the case if you have a site that
- * displays snippets of code, for instance.
- *
- * Example:
- *
- * ```
- * <div>Normal: {{1 + 2}}</div> // output "Normal: 3"
- * <div ng-non-bindable>Ignored: {{1 + 2}}</div> // output "Ignored: {{1 + 2}}"
- * ```
- */
- class NgNonBindable {
- }
- /**
- * Adds or removes styles based on an {expression}.
- *
- * When the expression assigned to `ng-style` evaluates to an object, the corresponding element
- * styles are updated. Style names to update are taken from the object keys and values - from the
- * corresponding object values.
- *
- * # Example:
- *
- * ```
- * <div [ng-style]="{'text-align': alignExp}"></div>
- * ```
- *
- * In the above example the `text-align` style will be updated based on the `alignExp` value
- * changes.
- *
- * # Syntax
- *
- * - `<div [ng-style]="{'text-align': alignExp}"></div>`
- * - `<div [ng-style]="styleExp"></div>`
- */
- class NgStyle {
- rawStyle: any;
- doCheck(): void;
- }
- class SwitchView {
- create(): void;
- destroy(): void;
- }
- /**
- * The `NgSwitch` directive is used to conditionally swap DOM structure on your template based on a
- * scope expression.
- * Elements within `NgSwitch` but without `NgSwitchWhen` or `NgSwitchDefault` directives will be
- * preserved at the location as specified in the template.
- *
- * `NgSwitch` simply chooses nested elements and makes them visible based on which element matches
- * the value obtained from the evaluated expression. In other words, you define a container element
- * (where you place the directive), place an expression on the **`[ng-switch]="..."` attribute**),
- * define any inner elements inside of the directive and place a `[ng-switch-when]` attribute per
- * element.
- * The when attribute is used to inform NgSwitch which element to display when the expression is
- * evaluated. If a matching expression is not found via a when attribute then an element with the
- * default attribute is displayed.
- *
- * # Example:
- *
- * ```
- * <ANY [ng-switch]="expression">
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template ng-switch-default>...</template>
- * </ANY>
- * ```
- */
- class NgSwitch {
- ngSwitch: any;
- }
- /**
- * Defines a case statement as an expression.
- *
- * If multiple `NgSwitchWhen` match the `NgSwitch` value, all of them are displayed.
- *
- * Example:
- *
- * ```
- * // match against a context variable
- * <template [ng-switch-when]="contextVariable">...</template>
- *
- * // match against a constant string
- * <template ng-switch-when="stringValue">...</template>
- * ```
- */
- class NgSwitchWhen {
- ngSwitchWhen: any;
- }
- /**
- * Defines a default case statement.
- *
- * Default case statements are displayed when no `NgSwitchWhen` match the `ng-switch` value.
- *
- * Example:
- *
- * ```
- * <template ng-switch-default>...</template>
- * ```
- */
- class NgSwitchDefault {
- }
- /**
- * Omitting from external API doc as this is really an abstract internal concept.
- */
- class AbstractControl {
- validator: Function;
- value: any;
- status: string;
- valid: boolean;
- errors: StringMap<string, any>;
- pristine: boolean;
- dirty: boolean;
- touched: boolean;
- untouched: boolean;
- valueChanges: Observable;
- markAsTouched(): void;
- markAsDirty({onlySelf}?: {onlySelf?: boolean}): void;
- setParent(parent: ControlGroup | ControlArray): void;
- updateValidity({onlySelf}?: {onlySelf?: boolean}): void;
- updateValueAndValidity({onlySelf, emitEvent}?: {onlySelf?: boolean, emitEvent?: boolean}): void;
- find(path: Array<string | number>| string): AbstractControl;
- getError(errorCode: string, path?: string[]): any;
- hasError(errorCode: string, path?: string[]): boolean;
- }
- /**
- * Defines a part of a form that cannot be divided into other controls.
- *
- * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
- * with
- * {@link ControlGroup} and {@link ControlArray}.
- */
- class Control extends AbstractControl {
- updateValue(value: any, {onlySelf, emitEvent, emitModelToViewChange}?:
- {onlySelf?: boolean, emitEvent?: boolean, emitModelToViewChange?: boolean}): void;
- registerOnChange(fn: Function): void;
- }
- /**
- * Defines a part of a form, of fixed length, that can contain other controls.
- *
- * A ControlGroup aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlGroup` is one of the three fundamental building blocks used to define forms in Angular,
- * along with
- * {@link Control} and {@link ControlArray}. {@link ControlArray} can also contain other controls,
- * but is of variable
- * length.
- */
- class ControlGroup extends AbstractControl {
- controls: StringMap<string, AbstractControl>;
- addControl(name: string, c: AbstractControl): void;
- removeControl(name: string): void;
- include(controlName: string): void;
- exclude(controlName: string): void;
- contains(controlName: string): boolean;
- }
- /**
- * Defines a part of a form, of variable length, that can contain other controls.
- *
- * A `ControlArray` aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlArray` is one of the three fundamental building blocks used to define forms in Angular,
- * along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
- * other controls, but is of fixed length.
- */
- class ControlArray extends AbstractControl {
- controls: AbstractControl[];
- at(index: number): AbstractControl;
- push(control: AbstractControl): void;
- insert(index: number, control: AbstractControl): void;
- removeAt(index: number): void;
- length: number;
- }
- class AbstractControlDirective {
- control: AbstractControl;
- value: any;
- valid: boolean;
- errors: StringMap<string, any>;
- pristine: boolean;
- dirty: boolean;
- touched: boolean;
- untouched: boolean;
- }
- /**
- * An interface that {@link NgFormModel} and {@link NgForm} implement.
- *
- * Only used by the forms module.
- */
- interface Form {
- addControl(dir: NgControl): void;
- removeControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- }
- /**
- * A directive that contains a group of [NgControl].
- *
- * Only used by the forms module.
- */
- class ControlContainer extends AbstractControlDirective {
- name: string;
- formDirective: Form;
- path: string[];
- }
- /**
- * Creates and binds a control with a specified name to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the login and password controls.
- * We can work with each control separately: check its validity, get its value, listen to its
- * changes.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onLogIn(f.value)'>
- * Login <input type='text' ng-control='login' #l="form">
- * <div *ng-if="!l.valid">Login is invalid</div>
- *
- * Password <input type='password' ng-control='password'>
- *
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * onLogIn(value) {
- * // value === {login: 'some login', password: 'some password'}
- * }
- * }
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form (submit)='onLogIn()'>
- * Login <input type='text' ng-control='login' [(ng-model)]="credentials.login">
- * Password <input type='password' ng-control='password'
- * [(ng-model)]="credentials.password">
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * credentials: {login:string, password:string};
- *
- * onLogIn() {
- * // this.credentials.login === "some login"
- * // this.credentials.password === "some password"
- * }
- * }
- * ```
- */
- class NgControlName extends NgControl {
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- onDestroy(): void;
- viewToModelUpdate(newValue: any): void;
- path: string[];
- formDirective: any;
- control: Control;
- validator: Function;
- }
- /**
- * Binds an existing control to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control to an input element. When the value of the input element
- * changes, the value of
- * the control will reflect that change. Likewise, if the value of the control changes, the input
- * element reflects that
- * change.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl'>"
- * })
- * class LoginComp {
- * loginControl:Control;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl' [(ng-model)]='login'>"
- * })
- * class LoginComp {
- * loginControl:Control;
- * login:string;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- * ```
- */
- class NgFormControl extends NgControl {
- form: Control;
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- path: string[];
- control: Control;
- validator: Function;
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * Binds a domain model to the form.
- *
- * # Example
- * ```
- * @Component({selector: "search-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <input type='text' [(ng-model)]="searchQuery">
- * `})
- * class SearchComp {
- * searchQuery: string;
- * }
- * ```
- */
- class NgModel extends NgControl {
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- control: Control;
- path: string[];
- validator: Function;
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * An abstract class that all control directive extend.
- *
- * It binds a {@link Control} object to a DOM element.
- */
- class NgControl extends AbstractControlDirective {
- name: string;
- valueAccessor: ControlValueAccessor;
- validator: Function;
- path: string[];
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * Creates and binds a control group to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the credentials and personal control groups.
- * We can work with each group separately: check its validity, get its value, listen to its changes.
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgControlGroup extends ControlContainer {
- onInit(): void;
- onDestroy(): void;
- control: ControlGroup;
- path: string[];
- formDirective: Form;
- }
- /**
- * Binds an existing control group to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control group to the form element, and we bind the login and
- * password controls to the
- * login and password elements.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<form [ng-form-model]='loginForm'>" +
- * "Login <input type='text' ng-control='login'>" +
- * "Password <input type='password' ng-control='password'>" +
- * "<button (click)="onLogin()">Login</button>" +
- * "</form>"
- * })
- * class LoginComp {
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.loginForm.value
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<form [ng-form-model]='loginForm'>" +
- * "Login <input type='text' ng-control='login' [(ng-model)]='login'>" +
- * "Password <input type='password' ng-control='password' [(ng-model)]='password'>" +
- * "<button (click)="onLogin()">Login</button>" +
- * "</form>"
- * })
- * class LoginComp {
- * credentials:{login:string, password:string}
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.credentials.login === 'some login'
- * // this.credentials.password === 'some password'
- * }
- * }
- * ```
- */
- class NgFormModel extends ControlContainer implements Form {
- form: ControlGroup;
- directives: NgControl[];
- ngSubmit: any;
- onChanges(_: any): void;
- formDirective: Form;
- control: ControlGroup;
- path: string[];
- addControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- removeControl(dir: NgControl): void;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- onSubmit(): boolean;
- }
- /**
- * Creates and binds a form object to a DOM element.
- *
- * # Example
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgForm extends ControlContainer implements Form {
- form: ControlGroup;
- ngSubmit: any;
- formDirective: Form;
- control: ControlGroup;
- path: string[];
- controls: StringMap<string, AbstractControl>;
- addControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- removeControl(dir: NgControl): void;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- onSubmit(): boolean;
- }
- /**
- * A bridge between a control and a native element.
- *
- * Please see {@link DefaultValueAccessor} for more information.
- */
- interface ControlValueAccessor {
- writeValue(obj: any): void;
- registerOnChange(fn: any): void;
- registerOnTouched(fn: any): void;
- }
- /**
- * The default accessor for writing a value and listening to changes that is used by the
- * {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
- *
- * # Example
- * ```
- * <input type="text" [(ng-model)]="searchQuery">
- * ```
- */
- class DefaultValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: (_: any) => void): void;
- registerOnTouched(fn: () => void): void;
- }
- /**
- * The accessor for writing a value and listening to changes on a checkbox input element.
- *
- * # Example
- * ```
- * <input type="checkbox" [ng-control]="rememberLogin">
- * ```
- */
- class CheckboxControlValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: (_: any) => {}): void;
- registerOnTouched(fn: () => {}): void;
- }
- /**
- * Marks <option> as dynamic, so Angular can be notified when options change.
- *
- * #Example:
- *
- * ```
- * <select ng-control="city">
- * <option *ng-for="#c of cities" [value]="c"></option>
- * </select>
- * ```
- */
- class NgSelectOption {
- }
- /**
- * The accessor for writing a value and listening to changes on a select element.
- */
- class SelectControlValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- value: string;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: () => any): void;
- registerOnTouched(fn: () => any): void;
- }
- /**
- * A list of all the form directives used as part of a `@View` annotation.
- *
- * This is a shorthand for importing them each individually.
- */
- const FORM_DIRECTIVES : Type[] ;
- /**
- * Provides a set of validators used by form controls.
- *
- * # Example
- *
- * ```
- * var loginControl = new Control("", Validators.required)
- * ```
- */
- class Validators {
- static required(c:Control): StringMap<string, boolean>;
- static nullValidator(c: any): StringMap<string, boolean>;
- static compose(validators: Function[]): Function;
- static group(c:ControlGroup): StringMap<string, boolean>;
- static array(c:ControlArray): StringMap<string, boolean>;
- }
- class NgValidator {
- validator: Function;
- }
- class NgRequiredValidator extends NgValidator {
- validator: Function;
- }
- /**
- * Creates a form object from a user-specified configuration.
- *
- * # Example
- *
- * ```
- * import {Component, View, bootstrap} from 'angular2/angular2';
- * import {FormBuilder, Validators, FORM_DIRECTIVES, ControlGroup} from 'angular2/forms';
- *
- * @Component({
- * selector: 'login-comp',
- * viewBindings: [
- * FormBuilder
- * ]
- * })
- * @View({
- * template: `
- * <form [control-group]="loginForm">
- * Login <input control="login">
- *
- * <div control-group="passwordRetry">
- * Password <input type="password" control="password">
- * Confirm password <input type="password" control="passwordConfirmation">
- * </div>
- * </form>
- * `,
- * directives: [
- * FORM_DIRECTIVES
- * ]
- * })
- * class LoginComp {
- * loginForm: ControlGroup;
- *
- * constructor(builder: FormBuilder) {
- * this.loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- * }
- * }
- *
- * bootstrap(LoginComp)
- * ```
- *
- * This example creates a {@link ControlGroup} that consists of a `login` {@link Control}, and a
- * nested
- * {@link ControlGroup} that defines a `password` and a `passwordConfirmation` {@link Control}:
- *
- * ```
- * var loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- *
- * ```
- */
- class FormBuilder {
- group(controlsConfig: StringMap<string, any>, extra?: StringMap<string, any>): ControlGroup;
- control(value: Object, validator?: Function): Control;
- array(controlsConfig: any[], validator?: Function): ControlArray;
- }
- const FORM_BINDINGS : Type[] ;
- class RenderDirectiveMetadata {
- static DIRECTIVE_TYPE: any;
- static COMPONENT_TYPE: any;
- static create({id, selector, compileChildren, events, host, properties, readAttributes, type,
- callOnDestroy, callOnChanges, callDoCheck, callOnInit, callAfterContentInit,
- callAfterContentChecked, callAfterViewInit, callAfterViewChecked, changeDetection,
- exportAs}: {
- id?: string,
- selector?: string,
- compileChildren?: boolean,
- events?: string[],
- host?: Map<string, string>,
- properties?: string[],
- readAttributes?: string[],
- type?: number,
- callOnDestroy?: boolean,
- callOnChanges?: boolean,
- callDoCheck?: boolean,
- callOnInit?: boolean,
- callAfterContentInit?: boolean,
- callAfterContentChecked?: boolean,
- callAfterViewInit?: boolean,
- callAfterViewChecked?: boolean,
- changeDetection?: ChangeDetectionStrategy,
- exportAs?: string
- }): RenderDirectiveMetadata;
- id: any;
- selector: string;
- compileChildren: boolean;
- events: string[];
- properties: string[];
- readAttributes: string[];
- type: number;
- callOnDestroy: boolean;
- callOnChanges: boolean;
- callDoCheck: boolean;
- callOnInit: boolean;
- callAfterContentInit: boolean;
- callAfterContentChecked: boolean;
- callAfterViewInit: boolean;
- callAfterViewChecked: boolean;
- changeDetection: ChangeDetectionStrategy;
- exportAs: string;
- hostListeners: Map<string, string>;
- hostProperties: Map<string, string>;
- hostAttributes: Map<string, string>;
- }
- class DomRenderer extends Renderer {
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
- destroyView(viewRef: RenderViewRef): void;
- getNativeElementSync(location: RenderElementRef): any;
- getRootNodes(fragment: RenderFragmentRef): Node[];
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
- detachFragment(fragmentRef: RenderFragmentRef): void;
- hydrateView(viewRef: RenderViewRef): void;
- dehydrateView(viewRef: RenderViewRef): void;
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: any): void;
- }
- /**
- * A dispatcher for all events happening in a view.
- */
- interface RenderEventDispatcher {
- /**
- * Called when an event was triggered for a on-* attribute on an element.
- * @param {Map<string, any>} locals Locals to be used to evaluate the
- * event expressions
- * @return {boolean} False if `preventDefault` should be called on the DOM event.
- */
- dispatchRenderEvent(elementIndex: number, eventName: string, locals: Map<string, any>): boolean;
- }
- class Renderer {
- /**
- * Creates a root host view that includes the given element.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- *
- * @param {RenderProtoViewRef} hostProtoViewRef a RenderProtoViewRef of type
- * ProtoViewDto.HOST_VIEW_TYPE
- * @param {any} hostElementSelector css selector for the host element (will be queried against the
- * main document)
- * @return {RenderViewWithFragments} the created view including fragments
- */
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
- /**
- * Creates a regular view out of the given ProtoView.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- */
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
- /**
- * Destroys the given view after it has been dehydrated and detached
- */
- destroyView(viewRef: RenderViewRef): void;
- /**
- * Attaches a fragment after another fragment.
- */
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
- /**
- * Attaches a fragment after an element.
- */
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
- /**
- * Detaches a fragment.
- */
- detachFragment(fragmentRef: RenderFragmentRef): void;
- /**
- * Hydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- hydrateView(viewRef: RenderViewRef): void;
- /**
- * Dehydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- dehydrateView(viewRef: RenderViewRef): void;
- /**
- * Returns the native element at the given location.
- * Attention: In a WebWorker scenario, this should always return null!
- */
- getNativeElementSync(location: RenderElementRef): any;
- /**
- * Sets a property on an element.
- */
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
- /**
- * Sets an attribute on an element.
- */
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
- /**
- * Sets a class on an element.
- */
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
- /**
- * Sets a style on an element.
- */
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
- /**
- * Calls a method on an element.
- */
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
- /**
- * Sets the value of a text node.
- */
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
- /**
- * Sets the dispatcher for all events of the given view
- */
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: RenderEventDispatcher): void;
- }
- /**
- * Abstract reference to the element which can be marshaled across web-worker boundary.
- *
- * This interface is used by the Renderer API.
- */
- interface RenderElementRef {
- /**
- * Reference to the `RenderViewRef` where the `RenderElementRef` is inside of.
- */
- renderView: RenderViewRef;
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
- }
- class RenderViewRef {
- }
- class RenderProtoViewRef {
- }
- class RenderFragmentRef {
- }
- class RenderViewWithFragments {
- viewRef: RenderViewRef;
- fragmentRefs: RenderFragmentRef[];
- }
- class ViewDefinition {
- componentId: string;
- templateAbsUrl: string;
- template: string;
- directives: RenderDirectiveMetadata[];
- styleAbsUrls: string[];
- styles: string[];
- encapsulation: ViewEncapsulation;
- }
- const DOCUMENT : OpaqueToken ;
- /**
- * A unique id (string) for an angular application.
- */
- const APP_ID : OpaqueToken ;
- /**
- * Defines when a compiled template should be stored as a string
- * rather than keeping its Nodes to preserve memory.
- */
- const MAX_IN_MEMORY_ELEMENTS_PER_TEMPLATE : OpaqueToken ;
- /**
- * Create trace scope.
- *
- * Scopes must be strictly nested and are analogous to stack frames, but
- * do not have to follow the stack frames. Instead it is recommended that they follow logical
- * nesting. You may want to use
- * [Event
- * Signatures](http://google.github.io/tracing-framework/instrumenting-code.html#custom-events)
- * as they are defined in WTF.
- *
- * Used to mark scope entry. The return value is used to leave the scope.
- *
- * var myScope = wtfCreateScope('MyClass#myMethod(ascii someVal)');
- *
- * someMethod() {
- * var s = myScope('Foo'); // 'Foo' gets stored in tracing UI
- * // DO SOME WORK HERE
- * return wtfLeave(s, 123); // Return value 123
- * }
- *
- * Note, adding try-finally block around the work to ensure that `wtfLeave` gets called can
- * negatively impact the performance of your application. For this reason we recommend that
- * you don't add them to ensure that `wtfLeave` gets called. In production `wtfLeave` is a noop and
- * so try-finally block has no value. When debugging perf issues, skipping `wtfLeave`, do to
- * exception, will produce incorrect trace, but presence of exception signifies logic error which
- * needs to be fixed before the app should be profiled. Add try-finally only when you expect that
- * an exception is expected during normal execution while profiling.
- */
- var wtfCreateScope : WtfScopeFn ;
- /**
- * Used to mark end of Scope.
- *
- * - `scope` to end.
- * - `returnValue` (optional) to be passed to the WTF.
- *
- * Returns the `returnValue for easy chaining.
- */
- var wtfLeave : <T>(scope: any, returnValue?: T) => T ;
- /**
- * Used to mark Async start. Async are similar to scope but they don't have to be strictly nested.
- * The return value is used in the call to [endAsync]. Async ranges only work if WTF has been
- * enabled.
- *
- * someMethod() {
- * var s = wtfStartTimeRange('HTTP:GET', 'some.url');
- * var future = new Future.delay(5).then((_) {
- * wtfEndTimeRange(s);
- * });
- * }
- */
- var wtfStartTimeRange : (rangeType: string, action: string) => any ;
- /**
- * Ends a async time range operation.
- * [range] is the return value from [wtfStartTimeRange] Async ranges only work if WTF has been
- * enabled.
- */
- var wtfEndTimeRange : (range: any) => void ;
- interface WtfScopeFn {
- (arg0?: any, arg1?: any): any;
- }
- var ChangeDetectorRef: InjectableReference;
- var ApplicationRef: InjectableReference;
- var Compiler: InjectableReference;
- var AppViewManager: InjectableReference;
- var ViewRef: InjectableReference;
- var ProtoViewRef: InjectableReference;
- var ViewContainerRef: InjectableReference;
- var ComponentRef: InjectableReference;
- }
- declare module "angular2/angular2" {
- export = ng;
- }
- declare module ngWorker {
- /**
- * Declare reusable UI building blocks for an application.
- *
- * Each Angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@Component`
- * annotation specifies when a component is instantiated, and which properties and hostListeners it
- * binds to.
- *
- * When a component is instantiated, Angular
- * - creates a shadow DOM for the component.
- * - loads the selected template into the shadow DOM.
- * - creates all the injectable objects configured with `bindings` and `viewBindings`.
- *
- * All template expressions and statements are then evaluated against the component instance.
- *
- * For details on the `@View` annotation, see {@link ViewMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!'
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ComponentMetadata extends DirectiveMetadata {
- /**
- * Defines the used change detection strategy.
- *
- * When a component is instantiated, Angular creates a change detector, which is responsible for
- * propagating the component's bindings.
- *
- * The `changeDetection` property defines, whether the change detection will be checked every time
- * or only when the component tells it to do so.
- */
- changeDetection: ChangeDetectionStrategy;
- /**
- * Defines the set of injectable objects that are visible to its view dom children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'needs-greeter'
- * })
- * class NeedsGreeter {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- *
- * @Component({
- * selector: 'greet',
- * viewBindings: [
- * Greeter
- * ]
- * })
- * @View({
- * template: `<needs-greeter></needs-greeter>`,
- * directives: [NeedsGreeter]
- * })
- * class HelloWorld {
- * }
- *
- * ```
- */
- viewBindings: any[];
- }
- /**
- * Directives allow you to attach behavior to elements in the DOM.
- *
- * {@link DirectiveMetadata}s with an embedded view are called {@link ComponentMetadata}s.
- *
- * A directive consists of a single directive annotation and a controller class. When the
- * directive's `selector` matches
- * elements in the DOM, the following steps occur:
- *
- * 1. For each directive, the `ElementInjector` attempts to resolve the directive's constructor
- * arguments.
- * 2. Angular instantiates directives for each matched element using `ElementInjector` in a
- * depth-first order,
- * as declared in the HTML.
- *
- * ## Understanding How Injection Works
- *
- * There are three stages of injection resolution.
- * - *Pre-existing Injectors*:
- * - The terminal {@link Injector} cannot resolve dependencies. It either throws an error or, if
- * the dependency was
- * specified as `@Optional`, returns `null`.
- * - The platform injector resolves browser singleton resources, such as: cookies, title,
- * location, and others.
- * - *Component Injectors*: Each component instance has its own {@link Injector}, and they follow
- * the same parent-child hierarchy
- * as the component instances in the DOM.
- * - *Element Injectors*: Each component instance has a Shadow DOM. Within the Shadow DOM each
- * element has an `ElementInjector`
- * which follow the same parent-child hierarchy as the DOM elements themselves.
- *
- * When a template is instantiated, it also must instantiate the corresponding directives in a
- * depth-first order. The
- * current `ElementInjector` resolves the constructor dependencies for each directive.
- *
- * Angular then resolves dependencies as follows, according to the order in which they appear in the
- * {@link ViewMetadata}:
- *
- * 1. Dependencies on the current element
- * 2. Dependencies on element injectors and their parents until it encounters a Shadow DOM boundary
- * 3. Dependencies on component injectors and their parents until it encounters the root component
- * 4. Dependencies on pre-existing injectors
- *
- *
- * The `ElementInjector` can inject other directives, element-specific special objects, or it can
- * delegate to the parent
- * injector.
- *
- * To inject other directives, declare the constructor parameter as:
- * - `directive:DirectiveType`: a directive on the current element only
- * - `@Host() directive:DirectiveType`: any directive that matches the type between the current
- * element and the
- * Shadow DOM root.
- * - `@Query(DirectiveType) query:QueryList<DirectiveType>`: A live collection of direct child
- * directives.
- * - `@QueryDescendants(DirectiveType) query:QueryList<DirectiveType>`: A live collection of any
- * child directives.
- *
- * To inject element-specific special objects, declare the constructor parameter as:
- * - `element: ElementRef` to obtain a reference to logical element in the view.
- * - `viewContainer: ViewContainerRef` to control child template instantiation, for
- * {@link DirectiveMetadata} directives only
- * - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
- *
- * ## Example
- *
- * The following example demonstrates how dependency injection resolves constructor arguments in
- * practice.
- *
- *
- * Assume this HTML template:
- *
- * ```
- * <div dependency="1">
- * <div dependency="2">
- * <div dependency="3" my-directive>
- * <div dependency="4">
- * <div dependency="5"></div>
- * </div>
- * <div dependency="6"></div>
- * </div>
- * </div>
- * </div>
- * ```
- *
- * With the following `dependency` decorator and `SomeService` injectable class.
- *
- * ```
- * @Injectable()
- * class SomeService {
- * }
- *
- * @Directive({
- * selector: '[dependency]',
- * properties: [
- * 'id: dependency'
- * ]
- * })
- * class Dependency {
- * id:string;
- * }
- * ```
- *
- * Let's step through the different ways in which `MyDirective` could be declared...
- *
- *
- * ### No injection
- *
- * Here the constructor is declared with no arguments, therefore nothing is injected into
- * `MyDirective`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor() {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with no dependencies.
- *
- *
- * ### Component-level injection
- *
- * Directives can inject any injectable instance from the closest component injector or any of its
- * parents.
- *
- * Here, the constructor declares a parameter, `someService`, and injects the `SomeService` type
- * from the parent
- * component's injector.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(someService: SomeService) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a dependency on `SomeService`.
- *
- *
- * ### Injecting a directive from the current element
- *
- * Directives can inject other directives declared on the current element.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(dependency: Dependency) {
- * expect(dependency.id).toEqual(3);
- * }
- * }
- * ```
- * This directive would be instantiated with `Dependency` declared at the same element, in this case
- * `dependency="3"`.
- *
- * ### Injecting a directive from any ancestor elements
- *
- * Directives can inject other directives declared on any ancestor element (in the current Shadow
- * DOM), i.e. on the current element, the
- * parent element, or its parents.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Host() dependency: Dependency) {
- * expect(dependency.id).toEqual(2);
- * }
- * }
- * ```
- *
- * `@Host` checks the current element, the parent, as well as its parents recursively. If
- * `dependency="2"` didn't
- * exist on the direct parent, this injection would
- * have returned
- * `dependency="1"`.
- *
- *
- * ### Injecting a live collection of direct child directives
- *
- *
- * A directive can also query for other child directives. Since parent directives are instantiated
- * before child directives, a directive can't simply inject the list of child directives. Instead,
- * the directive injects a {@link QueryList}, which updates its contents as children are added,
- * removed, or moved by a directive that uses a {@link ViewContainerRef} such as a `ng-for`, an
- * `ng-if`, or an `ng-switch`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency) dependencies:QueryList<Dependency>) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a {@link QueryList} which contains `Dependency` 4 and
- * 6. Here, `Dependency` 5 would not be included, because it is not a direct child.
- *
- * ### Injecting a live collection of descendant directives
- *
- * By passing the descendant flag to `@Query` above, we can include the children of the child
- * elements.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency, {descendants: true}) dependencies:QueryList<Dependency>) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a Query which would contain `Dependency` 4, 5 and 6.
- *
- * ### Optional injection
- *
- * The normal behavior of directives is to return an error when a specified dependency cannot be
- * resolved. If you
- * would like to inject `null` on unresolved dependency instead, you can annotate that dependency
- * with `@Optional()`.
- * This explicitly permits the author of a template to treat some of the surrounding directives as
- * optional.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Optional() dependency:Dependency) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a `Dependency` directive found on the current element.
- * If none can be
- * found, the injector supplies `null` instead of throwing an error.
- *
- * ## Example
- *
- * Here we use a decorator directive to simply define basic tool-tip behavior.
- *
- * ```
- * @Directive({
- * selector: '[tooltip]',
- * properties: [
- * 'text: tooltip'
- * ],
- * host: {
- * '(mouseenter)': 'onMouseEnter()',
- * '(mouseleave)': 'onMouseLeave()'
- * }
- * })
- * class Tooltip{
- * text:string;
- * overlay:Overlay; // NOT YET IMPLEMENTED
- * overlayManager:OverlayManager; // NOT YET IMPLEMENTED
- *
- * constructor(overlayManager:OverlayManager) {
- * this.overlay = overlay;
- * }
- *
- * onMouseEnter() {
- * // exact signature to be determined
- * this.overlay = this.overlayManager.open(text, ...);
- * }
- *
- * onMouseLeave() {
- * this.overlay.close();
- * this.overlay = null;
- * }
- * }
- * ```
- * In our HTML template, we can then add this behavior to a `<div>` or any other element with the
- * `tooltip` selector,
- * like so:
- *
- * ```
- * <div tooltip="some text here"></div>
- * ```
- *
- * Directives can also control the instantiation, destruction, and positioning of inline template
- * elements:
- *
- * A directive uses a {@link ViewContainerRef} to instantiate, insert, move, and destroy views at
- * runtime.
- * The {@link ViewContainerRef} is created as a result of `<template>` element, and represents a
- * location in the current view
- * where these actions are performed.
- *
- * Views are always created as children of the current {@link ViewMetadata}, and as siblings of the
- * `<template>` element. Thus a
- * directive in a child view cannot inject the directive that created it.
- *
- * Since directives that create views via ViewContainers are common in Angular, and using the full
- * `<template>` element syntax is wordy, Angular
- * also supports a shorthand notation: `<li *foo="bar">` and `<li template="foo: bar">` are
- * equivalent.
- *
- * Thus,
- *
- * ```
- * <ul>
- * <li *foo="bar" title="text"></li>
- * </ul>
- * ```
- *
- * Expands in use to:
- *
- * ```
- * <ul>
- * <template [foo]="bar">
- * <li title="text"></li>
- * </template>
- * </ul>
- * ```
- *
- * Notice that although the shorthand places `*foo="bar"` within the `<li>` element, the binding for
- * the directive
- * controller is correctly instantiated on the `<template>` element rather than the `<li>` element.
- *
- *
- * ## Example
- *
- * Let's suppose we want to implement the `unless` behavior, to conditionally include a template.
- *
- * Here is a simple directive that triggers on an `unless` selector:
- *
- * ```
- * @Directive({
- * selector: '[unless]',
- * properties: ['unless']
- * })
- * export class Unless {
- * viewContainer: ViewContainerRef;
- * templateRef: TemplateRef;
- * prevCondition: boolean;
- *
- * constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef) {
- * this.viewContainer = viewContainer;
- * this.templateRef = templateRef;
- * this.prevCondition = null;
- * }
- *
- * set unless(newCondition) {
- * if (newCondition && (isBlank(this.prevCondition) || !this.prevCondition)) {
- * this.prevCondition = true;
- * this.viewContainer.clear();
- * } else if (!newCondition && (isBlank(this.prevCondition) || this.prevCondition)) {
- * this.prevCondition = false;
- * this.viewContainer.create(this.templateRef);
- * }
- * }
- * }
- * ```
- *
- * We can then use this `unless` selector in a template:
- * ```
- * <ul>
- * <li *unless="expr"></li>
- * </ul>
- * ```
- *
- * Once the directive instantiates the child view, the shorthand notation for the template expands
- * and the result is:
- *
- * ```
- * <ul>
- * <template [unless]="exp">
- * <li></li>
- * </template>
- * <li></li>
- * </ul>
- * ```
- *
- * Note also that although the `<li></li>` template still exists inside the `<template></template>`,
- * the instantiated
- * view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
- */
- class DirectiveMetadata extends InjectableMetadata {
- /**
- * The CSS selector that triggers the instantiation of a directive.
- *
- * Angular only allows directives to trigger on CSS selectors that do not cross element
- * boundaries.
- *
- * `selector` may be declared as one of the following:
- *
- * - `element-name`: select by element name.
- * - `.class`: select by class name.
- * - `[attribute]`: select by attribute name.
- * - `[attribute=value]`: select by attribute name and value.
- * - `:not(sub_selector)`: select only if the element does not match the `sub_selector`.
- * - `selector1, selector2`: select if either `selector1` or `selector2` matches.
- *
- *
- * ## Example
- *
- * Suppose we have a directive with an `input[type=text]` selector.
- *
- * And the following HTML:
- *
- * ```html
- * <form>
- * <input type="text">
- * <input type="radio">
- * <form>
- * ```
- *
- * The directive would only be instantiated on the `<input type="text">` element.
- */
- selector: string;
- /**
- * Enumerates the set of properties that accept data binding for a directive.
- *
- * The `properties` property defines a set of `directiveProperty` to `bindingProperty`
- * configuration:
- *
- * - `directiveProperty` specifies the component property where the value is written.
- * - `bindingProperty` specifies the DOM property where the value is read from.
- *
- * You can include a {@link PipeMetadata} when specifying a `bindingProperty` to allow for data
- * transformation and structural change detection of the value. These pipes will be evaluated in
- * the context of this component.
- *
- * ## Syntax
- *
- * There is no need to specify both `directiveProperty` and `bindingProperty` when they both have
- * the same value.
- *
- * ```
- * @Directive({
- * properties: [
- * 'propertyName', // shorthand notation for 'propertyName: propertyName'
- * 'directiveProperty1: bindingProperty1',
- * 'directiveProperty2: bindingProperty2 | pipe1 | ...',
- * ...
- * ]
- * }
- * ```
- *
- *
- * ## Basic Property Binding
- *
- * We can easily build a simple `Tooltip` directive that exposes a `tooltip` property, which can
- * be used in templates with standard Angular syntax. For example:
- *
- * ```
- * @Directive({
- * selector: '[tooltip]',
- * properties: [
- * 'text: tooltip'
- * ]
- * })
- * class Tooltip {
- * set text(value: string) {
- * // This will get called every time with the new value when the 'tooltip' property changes
- * }
- * }
- * ```
- *
- * We can then bind to the `tooltip' property as either an expression (`someExpression`) or as a
- * string literal, as shown in the HTML template below:
- *
- * ```html
- * <div [tooltip]="someExpression">...</div>
- * <div tooltip="Some Text">...</div>
- * ```
- *
- * Whenever the `someExpression` expression changes, the `properties` declaration instructs
- * Angular to update the `Tooltip`'s `text` property.
- *
- * ### Bindings With Pipes
- *
- * You can use pipes in bindings, as follows:
- *
- * ```html
- * <div [class-set]="someExpression | somePipe">
- * ```
- */
- properties: string[];
- /**
- * Enumerates the set of emitted events.
- *
- * ## Syntax
- *
- * ```
- * @Component({
- * events: ['statusChange']
- * })
- * class TaskComponent {
- * statusChange: EventEmitter;
- *
- * constructor() {
- * this.statusChange = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.statusChange.next('completed');
- * }
- * }
- * ```
- *
- * Use `propertyName: eventName` when the event emitter property name is different from the name
- * of the emitted event:
- *
- * ```
- * @Component({
- * events: ['status: statusChange']
- * })
- * class TaskComponent {
- * status: EventEmitter;
- *
- * constructor() {
- * this.status = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.status.next('completed');
- * }
- * }
- * ```
- */
- events: string[];
- /**
- * Specifiy the events, actions, properties and attributes related to the host element.
- *
- * ## Events
- *
- * Specifies which DOM hostListeners a directive listens to via a set of `(event)` to `method`
- * key-value pairs:
- *
- * - `event1`: the DOM event that the directive listens to.
- * - `statement`: the statement to execute when the event occurs.
- * If the evalutation of the statement returns `false`, then `preventDefault`is applied on the DOM
- * event.
- *
- * To listen to global events, a target must be added to the event name.
- * The target can be `window`, `document` or `body`.
- *
- * When writing a directive event binding, you can also refer to the following local variables:
- * - `$event`: Current event object which triggered the event.
- * - `$target`: The source of the event. This will be either a DOM element or an Angular
- * directive. (will be implemented in later release)
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * host: {
- * '(event1)': 'onMethod1(arguments)',
- * '(target:event2)': 'onMethod2(arguments)',
- * ...
- * }
- * }
- * ```
- *
- * ## Basic Event Binding:
- *
- * Suppose you want to write a directive that reacts to `change` events in the DOM and on
- * `resize` events in window.
- * You would define the event binding as follows:
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '(change)': 'onChange($event)',
- * '(window:resize)': 'onResize($event)'
- * }
- * })
- * class InputDirective {
- * onChange(event:Event) {
- * // invoked when the input element fires the 'change' event
- * }
- * onResize(event:Event) {
- * // invoked when the window fires the 'resize' event
- * }
- * }
- * ```
- *
- * ## Properties
- *
- * Specifies which DOM properties a directives updates.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '[prop]': 'expression'
- * }
- * })
- * class InputDirective {
- * value:string;
- * }
- * ```
- *
- * In this example the prop property of the host element is updated with the expression value
- * every time it changes.
- *
- * ## Attributes
- *
- * Specifies static attributes that should be propagated to a host element. Attributes specified
- * in `hostAttributes` are propagated only if a given attribute is not present on a host element.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: '[my-button]',
- * host: {
- * 'role': 'button'
- * }
- * })
- * class MyButton {
- * }
- * ```
- *
- * In this example using `my-button` directive (ex.: `<div my-button></div>`) on a host element
- * (here: `<div>` ) will ensure that this element will get the "button" role.
- */
- host: StringMap<string, string>;
- /**
- * Specifies which lifecycle should be notified to the directive.
- *
- * See {@link LifecycleEvent} for details.
- */
- lifecycle: LifecycleEvent[];
- /**
- * If set to false the compiler does not compile the children of this directive.
- */
- compileChildren: boolean;
- /**
- * Defines the set of injectable objects that are visible to a Directive and its light dom
- * children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'greet',
- * bindings: [
- * Greeter
- * ]
- * })
- * class HelloWorld {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- * ```
- */
- bindings: any[];
- /**
- * Defines the name that can be used in the template to assign this directive to a variable.
- *
- * ## Simple Example
- *
- * ```
- * @Directive({
- * selector: 'child-dir',
- * exportAs: 'child'
- * })
- * class ChildDir {
- * }
- *
- * @Component({
- * selector: 'main',
- * })
- * @View({
- * template: `<child-dir #c="child"></child-dir>`,
- * directives: [ChildDir]
- * })
- * class MainComponent {
- * }
- *
- * ```
- */
- exportAs: string;
- }
- /**
- * Declare reusable pipe function.
- *
- * ## Example
- *
- * ```
- * @Pipe({
- * name: 'lowercase'
- * })
- * class Lowercase {
- * transform(v, args) { return v.toLowerCase(); }
- * }
- * ```
- */
- class PipeMetadata extends InjectableMetadata {
- name: string;
- }
- /**
- * Lifecycle events are guaranteed to be called in the following order:
- * - `OnChanges` (if any bindings have changed),
- * - `OnInit` (after the first check only),
- * - `DoCheck`,
- * - `AfterContentChecked`
- * - `AfterContentChecked`
- * - `OnDestroy` (at the very end before destruction)
- */
- enum LifecycleEvent {
- /**
- * Notify a directive when it has been checked the first time.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only once.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.OnInit]
- * })
- * class ClassSet {
- * onInit() {
- * }
- * }
- * ```
- */
- OnInit,
- /**
- * Notify a directive whenever a {@link ViewMetadata} that contains it is destroyed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * ...,
- * lifecycle: [LifecycleEvent.OnDestroy]
- * })
- * class ClassSet {
- * onDestroy() {
- * // invoked to notify directive of the containing view destruction.
- * }
- * }
- * ```
- */
- OnDestroy,
- /**
- * Notify a directive when any of its bindings have changed.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only if at least one of the directive's bindings has changed.
- *
- * ## Example:
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * properties: [
- * 'propA',
- * 'propB'
- * ],
- * lifecycle: [LifecycleEvent.OnChanges]
- * })
- * class ClassSet {
- * propA;
- * propB;
- * onChanges(changes:{[idx: string, PropertyUpdate]}) {
- * // This will get called after any of the properties have been updated.
- * if (changes['propA']) {
- * // if propA was updated
- * }
- * if (changes['propA']) {
- * // if propB was updated
- * }
- * }
- * }
- * ```
- */
- OnChanges,
- /**
- * Notify a directive when it has been checked.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked every time even when none of the directive's bindings has changed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.DoCheck]
- * })
- * class ClassSet {
- * doCheck() {
- * }
- * }
- * ```
- */
- DoCheck,
- /**
- * Notify a directive when the bindings of all its content children have been checked the first
- * time (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentInit]
- * })
- * class ClassSet {
- *
- * afterContentInit() {
- * }
- *
- * }
- * ```
- */
- AfterContentInit,
- /**
- * Notify a directive when the bindings of all its content children have been checked (whether
- * they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentChecked]
- * })
- * class ClassSet {
- *
- * afterContentChecked() {
- * }
- *
- * }
- * ```
- */
- AfterContentChecked,
- /**
- * Notify a directive when the bindings of all its view children have been checked the first time
- * (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewInit]
- * })
- * class ClassSet {
- *
- * afterViewInit() {
- * }
- *
- * }
- * ```
- */
- AfterViewInit,
- /**
- * Notify a directive when the bindings of all its view children have been checked (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewChecked]
- * })
- * class ClassSet {
- *
- * afterViewChecked() {
- * }
- *
- * }
- * ```
- */
- AfterViewChecked
- }
- /**
- * Declares the available HTML templates for an application.
- *
- * Each angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@View` annotation specifies the HTML template to use, and lists the directives that are active
- * within the template.
- *
- * When a component is instantiated, the template is loaded into the component's shadow root, and
- * the expressions and statements in the template are evaluated against the component.
- *
- * For details on the `@Component` annotation, see {@link ComponentMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!',
- * directives: [GreetUser, Bold]
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ViewMetadata {
- /**
- * Specifies a template URL for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- templateUrl: string;
- /**
- * Specifies an inline template for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- template: string;
- /**
- * Specifies stylesheet URLs for an angular component.
- */
- styleUrls: string[];
- /**
- * Specifies an inline stylesheet for an angular component.
- */
- styles: string[];
- /**
- * Specifies a list of directives that can be used within a template.
- *
- * Directives must be listed explicitly to provide proper component encapsulation.
- *
- * ## Example
- *
- * ```javascript
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * directives: [For]
- * template: '
- * <ul>
- * <li *ng-for="#item of items">{{item}}</li>
- * </ul>'
- * })
- * class MyComponent {
- * }
- * ```
- */
- directives: Array<Type | any | any[]>;
- pipes: Array<Type | any | any[]>;
- /**
- * Specify how the template and the styles should be encapsulated.
- * The default is {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} if the view
- * has styles,
- * otherwise {@link ViewEncapsulation#None `ViewEncapsulation.None`}.
- */
- encapsulation: ViewEncapsulation;
- }
- /**
- * How the template and styles of a view should be encapsulated.
- */
- enum ViewEncapsulation {
- /**
- * Emulate scoping of styles by preprocessing the style rules
- * and adding additional attributes to elements. This is the default.
- */
- Emulated,
- /**
- * Uses the native mechanism of the renderer. For the DOM this means creating a ShadowRoot.
- */
- Native,
- /**
- * Don't scope the template nor the styles.
- */
- None
- }
- /**
- * Specifies that a {@link QueryList} should be injected.
- *
- * See {@link QueryList} for usage and example.
- */
- class QueryMetadata extends DependencyMetadata {
- descendants: boolean;
- isViewQuery: any;
- selector: any;
- isVarBindingQuery: boolean;
- varBindings: string[];
- toString(): string;
- }
- /**
- * Specifies that a constant attribute value should be injected.
- *
- * The directive can inject constant string literals of host element attributes.
- *
- * ## Example
- *
- * Suppose we have an `<input>` element and want to know its `type`.
- *
- * ```html
- * <input type="text">
- * ```
- *
- * A decorator can inject string literal `text` like so:
- *
- * ```javascript
- * @Directive({
- * selector: `input'
- * })
- * class InputDirective {
- * constructor(@Attribute('type') type) {
- * // type would be `text` in this example
- * }
- * }
- * ```
- */
- class AttributeMetadata extends DependencyMetadata {
- attributeName: string;
- token: any;
- toString(): string;
- }
- /**
- * {@link AttributeMetadata} factory function.
- */
- var Attribute : AttributeFactory ;
- /**
- * {@link AttributeMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Attribute, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Attribute('title') title: string) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Attribute('title'), function(title) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(title) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Attribute('title')]
- * ]
- * ```
- */
- interface AttributeFactory {
- new(name: string): AttributeMetadata;
- (name: string): TypeDecorator;
- }
- /**
- * {@link ComponentMetadata} factory function.
- */
- var Component : ComponentFactory ;
- /**
- * Interface for the {@link ComponentMetadata} decorator function.
- *
- * See {@link ComponentFactory}.
- */
- interface ComponentDecorator extends TypeDecorator {
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- pipes?: Array<Type | any | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link ComponentAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ComponentFactory {
- new(obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentMetadata;
- (obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentDecorator;
- }
- /**
- * {@link DirectiveMetadata} factory function.
- */
- var Directive : DirectiveFactory ;
- /**
- * Interface for the {@link DirectiveMetadata} decorator function.
- *
- * See {@link DirectiveFactory}.
- */
- interface DirectiveDecorator extends TypeDecorator {
- }
- /**
- * {@link DirectiveMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Directive} from "angular2/angular2";
- *
- * @Directive({...})
- * class MyDirective {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyDirective = ng
- * .Directive({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyDirective = function() {
- * ...
- * };
- *
- * MyDirective.annotations = [
- * new ng.Directive({...})
- * ]
- * ```
- */
- interface DirectiveFactory {
- new(obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveMetadata;
- (obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap<string, string>,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveDecorator;
- }
- /**
- * {@link ViewMetadata} factory function.
- */
- var View : ViewFactory ;
- /**
- * Interface for the {@link ViewMetadata} decorator function.
- *
- * See {@link ViewFactory}.
- */
- interface ViewDecorator extends TypeDecorator {
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- pipes?: Array<Type | any | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link ViewAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ViewFactory {
- new(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewMetadata;
- (obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
- /**
- * {@link QueryMetadata} factory function.
- */
- var Query : QueryFactory ;
- /**
- * {@link QueryMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Query, QueryList, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Query(SomeType) queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Query(SomeType), function(queryList) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(queryList) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Query(SomeType)]
- * ]
- * ```
- */
- interface QueryFactory {
- new(selector: Type | string, {descendants}?: {descendants?: boolean}): QueryMetadata;
- (selector: Type | string, {descendants}?: {descendants?: boolean}): ParameterDecorator;
- }
- /**
- * {@link di/ViewQueryMetadata} factory function.
- */
- var ViewQuery : QueryFactory ;
- /**
- * {@link PipeMetadata} factory function.
- */
- var Pipe : PipeFactory ;
- /**
- * {@link PipeMetadata} factory for creating decorators.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Pipe} from "angular2/angular2";
- *
- * @Pipe({...})
- * class MyPipe {
- * constructor() {
- * ...
- * }
- *
- * transform(v, args) {}
- * }
- * ```
- */
- interface PipeFactory {
- new(obj: {
- name: string,
- }): any;
- (obj: {name: string}): any;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentInit `LifeCycleEvent.afterContentInit`}
- * called when the bindings of all its content children have been checked the first time.
- */
- interface AfterContentInit {
- afterContentInit(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentChecked `LifeCycleEvent.afterContentChecked`}
- * called when the bindings of all its content children have been checked.
- */
- interface AfterContentChecked {
- afterContentChecked(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewInit `LifeCycleEvent.afterViewInit`}
- * called when the bindings of all its view children have been checked the first time.
- */
- interface AfterViewInit {
- afterViewInit(): void;
- }
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewChecked `LifeCycleEvent.afterViewChecked`}
- * called when the bindings of all its view children have been checked.
- */
- interface AfterViewChecked {
- afterViewChecked(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnChanges `LifeCycleEvent.OnChanges`}
- * called after all of component's bound properties are updated.
- */
- interface OnChanges {
- onChanges(changes: StringMap<string, any>): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnDestroy `LifeCycleEvent.OnDestroy`}
- * called when a directive is being destroyed.
- */
- interface OnDestroy {
- onDestroy(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnInit `LifeCycleEvent.OnInit`}
- * called when a directive is being checked the first time.
- */
- interface OnInit {
- onInit(): void;
- }
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#DoCheck `LifeCycleEvent.DoCheck`}
- * called when a directive is being checked.
- */
- interface DoCheck {
- doCheck(): boolean;
- }
- /**
- * Provides a way for expressing ES6 classes with parameter annotations in ES5.
- *
- * ## Basic Example
- *
- * ```
- * var Greeter = ng.Class({
- * constructor: function(name) {
- * this.name = name;
- * },
- *
- * greet: function() {
- * alert('Hello ' + this.name + '!');
- * }
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class Greeter {
- * constructor(name) {
- * this.name = name;
- * }
- *
- * greet() {
- * alert('Hello ' + this.name + '!');
- * }
- * }
- * ```
- *
- * or equivalent to ES5:
- *
- * ```
- * var Greeter = function (name) {
- * this.name = name;
- * }
- *
- * Greeter.prototype.greet = function () {
- * alert('Hello ' + this.name + '!');
- * }
- * ```
- *
- * ## Example with parameter annotations
- *
- * ```
- * var MyService = neg.Class({
- * constructor: [String, [new Query(), QueryList], function(name, queryList) {
- * ...
- * }];
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class MyService {
- * constructor(name: string, @Query() queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example with inheritance
- *
- * ```
- * var Shape = ng.Class({
- * constructor: (color) {
- * this.color = color;
- * }
- * });
- *
- * var Square = ng.Class({
- * extends: Shape,
- * constructor: function(color, size) {
- * Shape.call(this, color);
- * this.size = size;
- * }
- * });
- * ```
- */
- function Class(clsDef: ClassDefinition) : Type ;
- /**
- * Declares the interface to be used with {@link Class}.
- */
- interface ClassDefinition {
- /**
- * Optional argument for specifying the superclass.
- */
- extends?: Type;
- /**
- * Required constructor function for a class.
- *
- * The function may be optionally wrapped in an `Array`, in which case additional parameter
- * annotations may be specified.
- * The number of arguments and the number of parameter annotations must match.
- *
- * See {@link Class} for example of usage.
- */
- constructor: (Function | any[]);
- }
- /**
- * An interface implemented by all Angular type decorators, which allows them to be used as ES7
- * decorators as well as
- * Angular DSL syntax.
- *
- * DSL syntax:
- *
- * ```
- * var MyClass = ng
- * .Component({...})
- * .View({...})
- * .Class({...});
- * ```
- *
- * ES7 syntax:
- *
- * ```
- * @ng.Component({...})
- * @ng.View({...})
- * class MyClass {...}
- * ```
- */
- interface TypeDecorator {
- /**
- * Invoke as ES7 decorator.
- */
- <T extends Type>(type: T): T;
- /**
- * Storage for the accumulated annotations so far used by the DSL syntax.
- *
- * Used by {@link Class} to annotate the generated class.
- */
- annotations: any[];
- /**
- * Generate a class from the definition and annotate it with {@link TypeDecorator#annotations}.
- */
- Class(obj: ClassDefinition): Type;
- }
- enum ChangeDetectionStrategy {
- /**
- * `CheckedOnce` means that after calling detectChanges the mode of the change detector
- * will become `Checked`.
- */
- CheckOnce,
- /**
- * `Checked` means that the change detector should be skipped until its mode changes to
- * `CheckOnce`.
- */
- Checked,
- /**
- * `CheckAlways` means that after calling detectChanges the mode of the change detector
- * will remain `CheckAlways`.
- */
- CheckAlways,
- /**
- * `Detached` means that the change detector sub tree is not a part of the main tree and
- * should be skipped.
- */
- Detached,
- /**
- * `OnPush` means that the change detector's mode will be set to `CheckOnce` during hydration.
- */
- OnPush,
- /**
- * `Default` means that the change detector's mode will be set to `CheckAlways` during hydration.
- */
- Default,
- /**
- * This is an experimental feature. Works only in Dart.
- */
- OnPushObserve
- }
- /**
- * An error thrown if application changes model breaking the top-down data flow.
- *
- * Angular expects that the data flows from top (root) component to child (leaf) components.
- * This is known as directed acyclic graph. This allows Angular to only execute change detection
- * once and prevents loops in change detection data flow.
- *
- * This exception is only thrown in dev mode.
- */
- class ExpressionChangedAfterItHasBeenCheckedException extends BaseException {
- }
- /**
- * Thrown when an expression evaluation raises an exception.
- *
- * This error wraps the original exception, this is done to attach expression location information.
- */
- class ChangeDetectionError extends BaseException {
- /**
- * Location of the expression.
- */
- location: string;
- }
- interface ChangeDetector {
- parent: ChangeDetector;
- mode: ChangeDetectionStrategy;
- ref: ChangeDetectorRef;
- addChild(cd: ChangeDetector): void;
- addShadowDomChild(cd: ChangeDetector): void;
- removeChild(cd: ChangeDetector): void;
- removeShadowDomChild(cd: ChangeDetector): void;
- remove(): void;
- hydrate(context: any, locals: Locals, directives: any, pipes: any): void;
- dehydrate(): void;
- markPathToRootAsCheckOnce(): void;
- handleEvent(eventName: string, elIndex: number, locals: Locals): void;
- detectChanges(): void;
- checkNoChanges(): void;
- }
- class Locals {
- parent: Locals;
- current: Map<any, any>;
- contains(name: string): boolean;
- get(name: string): any;
- set(name: string, value: any): void;
- clearValues(): void;
- }
- /**
- * Controls change detection.
- *
- * {@link ChangeDetectorRef} allows requesting checks for detectors that rely on observables. It
- * also allows detaching and attaching change detector subtrees.
- */
- interface ChangeDetectorRef {
- /**
- * Request to check all OnPush ancestors.
- */
- markForCheck(): void;
- /**
- * Detaches the change detector from the change detector tree.
- *
- * The detached change detector will not be checked until it is reattached.
- */
- detach(): void;
- /**
- * Reattach the change detector to the change detector tree.
- *
- * This also requests a check of this change detector. This reattached change detector will be
- * checked during the next change detection run.
- */
- reattach(): void;
- }
- /**
- * Indicates that the result of a {@link PipeMetadata} transformation has changed even though the
- * reference
- * has not changed.
- *
- * The wrapped value will be unwrapped by change detection, and the unwrapped value will be stored.
- *
- * Example:
- *
- * ```
- * if (this._latestValue === this._latestReturnedValue) {
- * return this._latestReturnedValue;
- * } else {
- * this._latestReturnedValue = this._latestValue;
- * return WrappedValue.wrap(this._latestValue); // this will force update
- * }
- * ```
- */
- class WrappedValue {
- static wrap(value: any): WrappedValue;
- wrapped: any;
- }
- /**
- * An interface which all pipes must implement.
- *
- * #Example
- *
- * ```
- * class DoublePipe implements PipeTransform {
- * transform(value, args = []) {
- * return `${value}${value}`;
- * }
- * }
- * ```
- */
- interface PipeTransform {
- transform(value: any, args: any[]): any;
- }
- /**
- * An interface that stateful pipes should implement.
- *
- * #Example
- *
- * ```
- * class StatefulPipe implements PipeTransform, PipeOnDestroy {
- * connection;
- *
- * onDestroy() {
- * this.connection.release();
- * }
- *
- * transform(value, args = []) {
- * this.connection = createConnection();
- * // ...
- * return someValue;
- * }
- * }
- * ```
- */
- interface PipeOnDestroy {
- onDestroy(): void;
- }
- /**
- * A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
- */
- class IterableDiffers {
- static create(factories: IterableDifferFactory[], parent?: IterableDiffers): IterableDiffers;
- /**
- * Takes an array of {@link IterableDifferFactory} and returns a binding used to extend the
- * inherited {@link IterableDiffers} instance with the provided factories and return a new
- * {@link IterableDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link IterableDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * IterableDiffers.extend([new ImmutableListDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: IterableDifferFactory[]): Binding;
- factories: IterableDifferFactory[];
- find(iterable: Object): IterableDifferFactory;
- }
- interface IterableDiffer {
- diff(object: Object): any;
- onDestroy(): void;
- }
- /**
- * Provides a factory for {@link IterableDiffer}.
- */
- interface IterableDifferFactory {
- supports(objects: Object): boolean;
- create(cdRef: ChangeDetectorRef): IterableDiffer;
- }
- /**
- * A repository of different Map diffing strategies used by NgClass, NgStyle, and others.
- */
- class KeyValueDiffers {
- static create(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers;
- /**
- * Takes an array of {@link KeyValueDifferFactory} and returns a binding used to extend the
- * inherited {@link KeyValueDiffers} instance with the provided factories and return a new
- * {@link KeyValueDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link KeyValueDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * KeyValueDiffers.extend([new ImmutableMapDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: KeyValueDifferFactory[]): Binding;
- factories: KeyValueDifferFactory[];
- find(kv: Object): KeyValueDifferFactory;
- }
- interface KeyValueDiffer {
- diff(object: Object): void;
- onDestroy(): void;
- }
- /**
- * Provides a factory for {@link KeyValueDiffer}.
- */
- interface KeyValueDifferFactory {
- supports(objects: Object): boolean;
- create(cdRef: ChangeDetectorRef): KeyValueDiffer;
- }
- /**
- * An opaque token representing the application root type in the {@link Injector}.
- *
- * ```
- * @Component(...)
- * @View(...)
- * class MyApp {
- * ...
- * }
- *
- * bootstrap(MyApp).then((appRef:ApplicationRef) {
- * expect(appRef.injector.get(appComponentTypeToken)).toEqual(MyApp);
- * });
- *
- * ```
- */
- const APP_COMPONENT : OpaqueToken ;
- /**
- * Runtime representation of a type.
- *
- * In JavaScript a Type is a constructor function.
- */
- interface Type extends Function {
- new(...args: any[]): any;
- }
- /**
- * Represents a Angular's representation of an Application.
- *
- * `ApplicationRef` represents a running application instance. Use it to retrieve the host
- * component, injector,
- * or dispose of an application.
- */
- interface ApplicationRef {
- /**
- * Returns the current {@link ComponentMetadata} type.
- */
- hostComponentType: Type;
- /**
- * Returns the current {@link ComponentMetadata} instance.
- */
- hostComponent: any;
- /**
- * Dispose (un-load) the application.
- */
- dispose(): void;
- /**
- * Returns the root application {@link Injector}.
- */
- injector: Injector;
- }
- /**
- * Specifies app root url for the application.
- *
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class AppRootUrl {
- /**
- * Returns the base URL of the currently running application.
- */
- value: any;
- }
- /**
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class UrlResolver {
- /**
- * Resolves the `url` given the `baseUrl`:
- * - when the `url` is null, the `baseUrl` is returned,
- * - if `url` is relative ('path/to/here', './path/to/here'), the resolved url is a combination of
- * `baseUrl` and `url`,
- * - if `url` is absolute (it has a scheme: 'http://', 'https://' or start with '/'), the `url` is
- * returned as is (ignoring the `baseUrl`)
- *
- * @param {string} baseUrl
- * @param {string} url
- * @returns {string} the resolved URL
- */
- resolve(baseUrl: string, url: string): string;
- }
- /**
- * Resolve a `Type` from a {@link ComponentMetadata} into a URL.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class ComponentUrlMapper {
- /**
- * Returns the base URL to the component source file.
- * The returned URL could be:
- * - an absolute URL,
- * - a path relative to the application
- */
- getUrl(component: Type): string;
- }
- /**
- * Resolve a `Type` for {@link DirectiveMetadata}.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class DirectiveResolver {
- /**
- * Return {@link DirectiveMetadata} for a given `Type`.
- */
- resolve(type: Type): DirectiveMetadata;
- }
- /**
- * ## URL Resolution
- *
- * ```
- * var appRootUrl: AppRootUrl = ...;
- * var componentUrlMapper: ComponentUrlMapper = ...;
- * var urlResolver: UrlResolver = ...;
- *
- * var componentType: Type = ...;
- * var componentAnnotation: ComponentAnnotation = ...;
- * var viewAnnotation: ViewAnnotation = ...;
- *
- * // Resolving a URL
- *
- * var url = viewAnnotation.templateUrl;
- * var componentUrl = componentUrlMapper.getUrl(componentType);
- * var componentResolvedUrl = urlResolver.resolve(appRootUrl.value, componentUrl);
- * var templateResolvedUrl = urlResolver.resolve(componetResolvedUrl, url);
- * ```
- */
- interface Compiler {
- compileInHost(componentTypeOrBinding: Type | Binding): Promise<ProtoViewRef>;
- }
- /**
- * Entry point for creating, moving views in the view hierarchy and destroying views.
- * This manager contains all recursion and delegates to helper methods
- * in AppViewManagerUtils and the Renderer, so unit tests get simpler.
- */
- interface AppViewManager {
- /**
- * Returns a {@link ViewContainerRef} at the {@link ElementRef} location.
- */
- getViewContainer(location: ElementRef): ViewContainerRef;
- /**
- * Return the first child element of the host element view.
- */
- getHostElement(hostViewRef: HostViewRef): ElementRef;
- /**
- * Returns an ElementRef for the element with the given variable name
- * in the current view.
- *
- * - `hostLocation`: {@link ElementRef} of any element in the View which defines the scope of
- * search.
- * - `variableName`: Name of the variable to locate.
- * - Returns {@link ElementRef} of the found element or null. (Throws if not found.)
- */
- getNamedElementInComponentView(hostLocation: ElementRef, variableName: string): ElementRef;
- /**
- * Returns the component instance for a given element.
- *
- * The component is the execution context as seen by an expression at that {@link ElementRef}
- * location.
- */
- getComponent(hostLocation: ElementRef): any;
- /**
- * Load component view into existing element.
- *
- * Use this if a host element is already in the DOM and it is necessary to upgrade
- * the element into Angular component by attaching a view but reusing the existing element.
- *
- * - `hostProtoViewRef`: {@link ProtoViewRef} Proto view to use in creating a view for this
- * component.
- * - `overrideSelector`: (optional) selector to use in locating the existing element to load
- * the view into. If not specified use the selector in the component definition of the
- * `hostProtoView`.
- * - injector: {@link Injector} to use as parent injector for the view.
- *
- * See {@link AppViewManager#destroyRootHostView}.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- *
- * }
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<some-component></some-component>)
- * `
- * })
- * class MyApp {
- * viewRef: ng.ViewRef;
- *
- * constructor(public appViewManager: ng.AppViewManager, compiler: ng.Compiler) {
- * compiler.compileInHost(ChildComponent).then((protoView: ng.ProtoViewRef) => {
- * this.viewRef = appViewManager.createRootHostView(protoView, 'some-component', null);
- * })
- * }
- *
- * onDestroy() {
- * this.appViewManager.destroyRootHostView(this.viewRef);
- * this.viewRef = null;
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- */
- createRootHostView(hostProtoViewRef: ProtoViewRef, overrideSelector: string, injector: Injector): HostViewRef;
- /**
- * Remove the View created with {@link AppViewManager#createRootHostView}.
- */
- destroyRootHostView(hostViewRef: HostViewRef): void;
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createEmbeddedViewInContainer(viewContainerLocation: ElementRef, atIndex: number, templateRef: TemplateRef): ViewRef;
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createHostViewInContainer(viewContainerLocation: ElementRef, atIndex: number, protoViewRef: ProtoViewRef, imperativelyCreatedInjector: ResolvedBinding[]): HostViewRef;
- /**
- * See {@link AppViewManager#createViewInContainer}.
- */
- destroyViewInContainer(viewContainerLocation: ElementRef, atIndex: number): void;
- /**
- * See {@link AppViewManager#detachViewInContainer}.
- */
- attachViewInContainer(viewContainerLocation: ElementRef, atIndex: number, viewRef: ViewRef): ViewRef;
- /**
- * See {@link AppViewManager#attachViewInContainer}.
- */
- detachViewInContainer(viewContainerLocation: ElementRef, atIndex: number): ViewRef;
- }
- /**
- * An iterable and observable live list of components in the DOM.
- *
- * A QueryList contains a live list of child directives in the DOM of a directive.
- * The directives are kept in depth-first pre-order traversal of the DOM.
- *
- * The `QueryList` is iterable, therefore it can be used in both javascript code with `for..of` loop
- * as well as in template with `*ng-for="of"` directive.
- *
- * QueryList is updated as part of the change-detection cycle of a directive. Since change detection
- * happens after construction of a directive, QueryList will always be empty when observed in the
- * constructor.
- *
- *
- * NOTE: In the future this class will implement an `Observable` interface. For now it uses a plain
- * list of observable callbacks.
- *
- * # Example:
- *
- * Assume that `<tabs>` component would like to get a list its children which are `<pane>`
- * components as shown in this example:
- *
- * ```html
- * <tabs>
- * <pane title="Overview">...</pane>
- * <pane *ng-for="#o of objects" [title]="o.title">{{o.text}}</pane>
- * </tabs>
- * ```
- *
- * In the above example the list of `<tabs>` elements needs to get a list of `<pane>` elements so
- * that it could render tabs with the correct titles and in the correct order.
- *
- * A possible solution would be for a `<pane>` to inject `<tabs>` component and then register itself
- * with `<tabs>` component's on `hydrate` and deregister on `dehydrate` event. While a reasonable
- * approach, this would only work partialy since `*ng-for` could rearrange the list of `<pane>`
- * components which would not be reported to `<tabs>` component and thus the list of `<pane>`
- * components would be out of sync with respect to the list of `<pane>` elements.
- *
- * A preferred solution is to inject a `QueryList` which is a live list of directives in the
- * component`s light DOM.
- *
- * ```javascript
- * @Component({
- * selector: 'tabs'
- * })
- * @View({
- * template: `
- * <ul>
- * <li *ng-for="#pane of panes">{{pane.title}}</li>
- * </ul>
- * <content></content>
- * `
- * })
- * class Tabs {
- * panes: QueryList<Pane>
- *
- * constructor(@Query(Pane) panes:QueryList<Pane>) {
- * this.panes = panes;
- * }
- * }
- *
- * @Component({
- * selector: 'pane',
- * properties: ['title']
- * })
- * @View(...)
- * class Pane {
- * title:string;
- * }
- * ```
- */
- class QueryList<T> {
- reset(newList: T[]): void;
- add(obj: T): void;
- fireCallbacks(): void;
- onChange(callback: () => void): void;
- removeCallback(callback: () => void): void;
- toString(): string;
- length: number;
- first: T;
- last: T;
- map<U>(fn: (item: T) => U): U[];
- }
- /**
- * Service for dynamically loading a Component into an arbitrary position in the internal Angular
- * application tree.
- */
- class DynamicComponentLoader {
- /**
- * Loads a root component that is placed at the first element that matches the component's
- * selector.
- *
- * - `typeOrBinding` `Type` \ {@link Binding} - representing the component to load.
- * - `overrideSelector` (optional) selector to load the component at (or use
- * `@Component.selector`) The selector can be anywhere (i.e. outside the current component.)
- * - `injector` {@link Injector} - optional injector to use for the component.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<child id="child"></child>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, injector: ng.Injector) {
- * dynamicComponentLoader.loadAsRoot(ChildComponent, '#child', injector);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <child id="child">
- * Child
- * </child>
- * )
- * </my-app>
- * ```
- */
- loadAsRoot(typeOrBinding: Type | Binding, overrideSelector: string, injector: Injector): Promise<ComponentRef>;
- /**
- * Loads a component into the component view of the provided ElementRef next to the element
- * with the given name.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<div #child></div>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <div #child="" class="ng-binding"></div>
- * <child-component class="ng-binding">Child</child-component>
- * )
- * </my-app>
- * ```
- */
- loadIntoLocation(typeOrBinding: Type | Binding, hostLocation: ElementRef, anchorName: string, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
- /**
- * Loads a component next to the provided ElementRef.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `Parent`
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>Parent</my-app>
- * <child-component>Child</child-component>
- * ```
- */
- loadNextToLocation(typeOrBinding: Type | Binding, location: ElementRef, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
- }
- /**
- * Provides access to explicitly trigger change detection in an application.
- *
- * By default, `Zone` triggers change detection in Angular on each virtual machine (VM) turn. When
- * testing, or in some
- * limited application use cases, a developer can also trigger change detection with the
- * `lifecycle.tick()` method.
- *
- * Each Angular application has a single `LifeCycle` instance.
- *
- * # Example
- *
- * This is a contrived example, since the bootstrap automatically runs inside of the `Zone`, which
- * invokes
- * `lifecycle.tick()` on your behalf.
- *
- * ```javascript
- * bootstrap(MyApp).then((ref:ComponentRef) => {
- * var lifeCycle = ref.injector.get(LifeCycle);
- * var myApp = ref.instance;
- *
- * ref.doSomething();
- * lifecycle.tick();
- * });
- * ```
- */
- class LifeCycle {
- /**
- * @private
- */
- registerWith(zone: NgZone, changeDetector?: ChangeDetector): void;
- /**
- * Invoke this method to explicitly process change detection and its side-effects.
- *
- * In development mode, `tick()` also performs a second change detection cycle to ensure that no
- * further
- * changes are detected. If additional changes are picked up during this second cycle, bindings
- * in
- * the app have
- * side-effects that cannot be resolved in a single change detection pass. In this case, Angular
- * throws an error,
- * since an Angular application can only have one change detection pass during which all change
- * detection must
- * complete.
- */
- tick(): void;
- }
- /**
- * Reference to the element.
- *
- * Represents an opaque reference to the underlying element. The element is a DOM ELement in
- * a Browser, but may represent other types on other rendering platforms. In the browser the
- * `ElementRef` can be sent to the web-worker. Web Workers can not have references to the
- * DOM Elements.
- */
- class ElementRef implements RenderElementRef {
- /**
- * Reference to the {@link ViewRef} where the `ElementRef` is inside of.
- */
- parentView: ViewRef;
- /**
- * Index of the element inside the {@link ViewRef}.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- boundElementIndex: number;
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
- renderView: RenderViewRef;
- /**
- * Returns the native Element implementation.
- *
- * In the browser this represents the DOM Element.
- *
- * The `nativeElement` can be used as an escape hatch when direct DOM manipulation is needed. Use
- * this with caution, as it creates tight coupling between your application and the Browser, which
- * will not work in WebWorkers.
- *
- * NOTE: This method will return null in the webworker scenario!
- */
- nativeElement: any;
- }
- /**
- * Reference to a template within a component.
- *
- * Represents an opaque reference to the underlying template that can
- * be instantiated using the {@link ViewContainerRef}.
- */
- class TemplateRef {
- /**
- * The location of the template
- */
- elementRef: ElementRef;
- protoViewRef: ProtoViewRef;
- /**
- * Whether this template has a local variable with the given name
- */
- hasLocal(name: string): boolean;
- }
- /**
- * A reference to an Angular View.
- *
- * A View is a fundamental building block of Application UI. A View is the smallest set of
- * elements which are created and destroyed together. A View can change properties on the elements
- * within the view, but it can not change the structure of those elements.
- *
- * To change structure of the elements, the Views can contain zero or more {@link ViewContainerRef}s
- * which allow the views to be nested.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- *
- * The outter/inner {@link ProtoViewRef}s are then assembled into views like so:
- *
- * ```
- * <!-- ViewRef: outer-0 -->
- * Count: 2
- * <ul>
- * <template view-container-ref></template>
- * <!-- ViewRef: inner-1 --><li>first</li><!-- /ViewRef: inner-1 -->
- * <!-- ViewRef: inner-2 --><li>second</li><!-- /ViewRef: inner-2 -->
- * </ul>
- * <!-- /ViewRef: outer-0 -->
- * ```
- */
- interface ViewRef extends HostViewRef {
- /**
- * Return `RenderViewRef`
- */
- render: RenderViewRef;
- /**
- * Return `RenderFragmentRef`
- */
- renderFragment: RenderFragmentRef;
- /**
- * Set local variable in a view.
- *
- * - `contextName` - Name of the local variable in a view.
- * - `value` - Value for the local variable in a view.
- */
- setLocal(contextName: string, value: any): void;
- }
- interface HostViewRef {
- }
- /**
- * A reference to an Angular ProtoView.
- *
- * A ProtoView is a reference to a template for easy creation of views.
- * (See {@link AppViewManager#createViewInContainer `AppViewManager#createViewInContainer`} and
- * {@link AppViewManager#createRootHostView `AppViewManager#createRootHostView`}).
- *
- * A `ProtoView` is a factory for creating `View`s.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- */
- interface ProtoViewRef {
- }
- /**
- * A location where {@link ViewRef}s can be attached.
- *
- * A `ViewContainerRef` represents a location in a {@link ViewRef} where other child
- * {@link ViewRef}s can be inserted. Adding and removing views is the only way of structurally
- * changing the rendered DOM of the application.
- */
- interface ViewContainerRef {
- viewManager: AppViewManager;
- element: ElementRef;
- /**
- * Remove all {@link ViewRef}s at current location.
- */
- clear(): void;
- /**
- * Return a {@link ViewRef} at specific index.
- */
- get(index: number): ViewRef;
- /**
- * Returns number of {@link ViewRef}s currently attached at this location.
- */
- length: number;
- /**
- * Create and insert a {@link ViewRef} into the view-container.
- *
- * - `protoViewRef` (optional) {@link ProtoViewRef} - The `ProtoView` to use for creating
- * `View` to be inserted at this location. If `ViewContainer` is created at a location
- * of inline template, then `protoViewRef` is the `ProtoView` of the template.
- * - `atIndex` (optional) `number` - location of insertion point. (Or at the end if unspecified.)
- * - `context` (optional) {@link ElementRef} - Context (for expression evaluation) from the
- * {@link ElementRef} location. (Or current context if unspecified.)
- * - `bindings` (optional) Array of {@link ResolvedBinding} - Used for configuring
- * `ElementInjector`.
- *
- * Returns newly created {@link ViewRef}.
- */
- createEmbeddedView(templateRef: TemplateRef, atIndex?: number): ViewRef;
- createHostView(protoViewRef?: ProtoViewRef, atIndex?: number, dynamicallyCreatedBindings?: ResolvedBinding[]): HostViewRef;
- /**
- * Insert a {@link ViewRef} at specefic index.
- *
- * The index is location at which the {@link ViewRef} should be attached. If omitted it is
- * inserted at the end.
- *
- * Returns the inserted {@link ViewRef}.
- */
- insert(viewRef: ViewRef, atIndex?: number): ViewRef;
- /**
- * Return the index of already inserted {@link ViewRef}.
- */
- indexOf(viewRef: ViewRef): number;
- /**
- * Remove a {@link ViewRef} at specific index.
- *
- * If the index is omitted last {@link ViewRef} is removed.
- */
- remove(atIndex?: number): void;
- /**
- * The method can be used together with insert to implement a view move, i.e.
- * moving the dom nodes while the directives in the view stay intact.
- */
- detach(atIndex?: number): ViewRef;
- }
- /**
- * Angular's reference to a component instance.
- *
- * `ComponentRef` represents a component instance lifecycle and meta information.
- */
- interface ComponentRef {
- /**
- * Location of the component host element.
- */
- location: ElementRef;
- /**
- * Instance of component.
- */
- instance: any;
- /**
- * Returns the host {@link ViewRef}.
- */
- hostView: HostViewRef;
- /**
- * Dispose of the component instance.
- */
- dispose(): void;
- }
- /**
- * A wrapper around zones that lets you schedule tasks after it has executed a task.
- *
- * The wrapper maintains an "inner" and an "mount" `Zone`. The application code will executes
- * in the "inner" zone unless `runOutsideAngular` is explicitely called.
- *
- * A typical application will create a singleton `NgZone`. The outer `Zone` is a fork of the root
- * `Zone`. The default `onTurnDone` runs the Angular change detection.
- */
- class NgZone {
- /**
- * Sets the zone hook that is called just before Angular event turn starts.
- * It is called once per browser event.
- */
- overrideOnTurnStart(onTurnStartFn: Function): void;
- /**
- * Sets the zone hook that is called immediately after Angular processes
- * all pending microtasks.
- */
- overrideOnTurnDone(onTurnDoneFn: Function): void;
- /**
- * Sets the zone hook that is called immediately after the last turn in
- * an event completes. At this point Angular will no longer attempt to
- * sync the UI. Any changes to the data model will not be reflected in the
- * DOM. `onEventDoneFn` is executed outside Angular zone.
- *
- * This hook is useful for validating application state (e.g. in a test).
- */
- overrideOnEventDone(onEventDoneFn: Function, opt_waitForAsync: boolean): void;
- /**
- * Sets the zone hook that is called when an error is uncaught in the
- * Angular zone. The first argument is the error. The second argument is
- * the stack trace.
- */
- overrideOnErrorHandler(errorHandlingFn: Function): void;
- /**
- * Runs `fn` in the inner zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to make use of the
- * Angular's auto digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.run(() => {
- * // the change detection will run after this function and the microtasks it enqueues have
- * executed.
- * });
- * ```
- */
- run(fn: () => any): any;
- /**
- * Runs `fn` in the outer zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to escape Angular's
- * auto-digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.runOutsideAngular(() => {
- * element.onClick(() => {
- * // Clicking on the element would not trigger the change detection
- * });
- * });
- * ```
- */
- runOutsideAngular(fn: () => any): any;
- }
- class Observable {
- observer(generator: any): Object;
- }
- /**
- * Use Rx.Observable but provides an adapter to make it work as specified here:
- * https://github.com/jhusain/observable-spec
- *
- * Once a reference implementation of the spec is available, switch to it.
- */
- class EventEmitter extends Observable {
- observer(generator: any): Rx.IDisposable;
- toRx(): Rx.Observable<any>;
- next(value: any): void;
- throw(error: any): void;
- return(value?: any): void;
- }
- /**
- * A parameter metadata that specifies a dependency.
- *
- * ```
- * class AComponent {
- * constructor(@Inject(MyService) aService:MyService) {}
- * }
- * ```
- */
- class InjectMetadata {
- token: any;
- toString(): string;
- }
- /**
- * A parameter metadata that marks a dependency as optional. {@link Injector} provides `null` if
- * the dependency is not found.
- *
- * ```
- * class AComponent {
- * constructor(@Optional() aService:MyService) {
- * this.aService = aService;
- * }
- * }
- * ```
- */
- class OptionalMetadata {
- toString(): string;
- }
- /**
- * A marker metadata that marks a class as available to `Injector` for creation. Used by tooling
- * for generating constructor stubs.
- *
- * ```
- * class NeedsService {
- * constructor(svc:UsefulService) {}
- * }
- *
- * @Injectable
- * class UsefulService {}
- * ```
- */
- class InjectableMetadata {
- }
- /**
- * Specifies that an injector should retrieve a dependency from itself.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Self() dependency:Dependency) {}
- * }
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * var nd = inj.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(Dependency);
- * ```
- */
- class SelfMetadata {
- toString(): string;
- }
- /**
- * Specifies that an injector should retrieve a dependency from any injector until reaching the
- * closest host.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Host() dependency:Dependency) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Dependency).toClass(HostDependency)
- * ]);
- * var child = parent.resolveAndCreateChild([]);
- * var grandChild = child.resolveAndCreateChild([NeedsDependency, Depedency]);
- * var nd = grandChild.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(HostDependency);
- * ```
- */
- class HostMetadata {
- toString(): string;
- }
- /**
- * Specifies that the dependency resolution should start from the parent injector.
- *
- * ## Example
- *
- *
- * ```
- * class Service {}
- *
- * class ParentService implements Service {
- * }
- *
- * class ChildService implements Service {
- * constructor(public @SkipSelf() parentService:Service) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Service).toClass(ParentService)
- * ]);
- * var child = parent.resolveAndCreateChild([
- * bind(Service).toClass(ChildSerice)
- * ]);
- * var s = child.get(Service);
- * expect(s).toBeAnInstanceOf(ChildService);
- * expect(s.parentService).toBeAnInstanceOf(ParentService);
- * ```
- */
- class SkipSelfMetadata {
- toString(): string;
- }
- /**
- * `DependencyMetadata is used by the framework to extend DI.
- *
- * Only metadata implementing `DependencyMetadata` are added to the list of dependency
- * properties.
- *
- * For example:
- *
- * ```
- * class Exclude extends DependencyMetadata {}
- * class NotDependencyProperty {}
- *
- * class AComponent {
- * constructor(@Exclude @NotDependencyProperty aService:AService) {}
- * }
- * ```
- *
- * will create the following dependency:
- *
- * ```
- * new Dependency(Key.get(AService), [new Exclude()])
- * ```
- *
- * The framework can use `new Exclude()` to handle the `aService` dependency
- * in a specific way.
- */
- class DependencyMetadata {
- token: any;
- }
- /**
- * Allows to refer to references which are not yet defined.
- *
- * This situation arises when the key which we need te refer to for the purposes of DI is declared,
- * but not yet defined.
- *
- * ## Example:
- *
- * ```
- * class Door {
- * // Incorrect way to refer to a reference which is defined later.
- * // This fails because `Lock` is undefined at this point.
- * constructor(lock:Lock) { }
- *
- * // Correct way to refer to a reference which is defined later.
- * // The reference needs to be captured in a closure.
- * constructor(@Inject(forwardRef(() => Lock)) lock:Lock) { }
- * }
- *
- * // Only at this point the lock is defined.
- * class Lock {
- * }
- * ```
- */
- function forwardRef(forwardRefFn: ForwardRefFn) : Type ;
- /**
- * Lazily retrieve the reference value.
- *
- * See: {@link forwardRef}
- */
- function resolveForwardRef(type: any) : any ;
- interface ForwardRefFn {
- (): any;
- }
- /**
- * A dependency injection container used for resolving dependencies.
- *
- * An `Injector` is a replacement for a `new` operator, which can automatically resolve the
- * constructor dependencies.
- * In typical use, application code asks for the dependencies in the constructor and they are
- * resolved by the `Injector`.
- *
- * ## Example:
- *
- * Suppose that we want to inject an `Engine` into class `Car`, we would define it like this:
- *
- * ```javascript
- * class Engine {
- * }
- *
- * class Car {
- * constructor(@Inject(Engine) engine) {
- * }
- * }
- *
- * ```
- *
- * Next we need to write the code that creates and instantiates the `Injector`. We then ask for the
- * `root` object, `Car`, so that the `Injector` can recursively build all of that object's
- * dependencies.
- *
- * ```javascript
- * main() {
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- *
- * // Get a reference to the `root` object, which will recursively instantiate the tree.
- * var car = injector.get(Car);
- * }
- * ```
- * Notice that we don't use the `new` operator because we explicitly want to have the `Injector`
- * resolve all of the object's dependencies automatically.
- */
- class Injector {
- /**
- * Turns a list of binding definitions into an internal resolved list of resolved bindings.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- *
- * The returned list is sparse, indexed by `id` for the {@link Key}. It is generally not useful to
- * application code
- * other than for passing it to {@link Injector} functions that require resolved binding lists,
- * such as
- * `fromResolvedBindings` and `createChildFromResolved`.
- */
- static resolve(bindings: Array<Type | Binding | any[]>): ResolvedBinding[];
- /**
- * Resolves bindings and creates an injector based on those bindings. This function is slower than
- * the corresponding `fromResolvedBindings` because it needs to resolve bindings first. See
- * `resolve`
- * for the {@link Injector}.
- *
- * Prefer `fromResolvedBindings` in performance-critical code that creates lots of injectors.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more
- * bindings.
- * @param `depProvider`
- */
- static resolveAndCreate(bindings: Array<Type | Binding | any[]>, depProvider?: DependencyProvider): Injector;
- /**
- * Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
- * {@link Injector}.
- * @param `depProvider`
- */
- static fromResolvedBindings(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
- /**
- * Returns debug information about the injector.
- *
- * This information is included into exceptions thrown by the injector.
- */
- debugContext(): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually the `Type` of an object. (Same as the token used while setting up a
- * binding).
- * @returns an instance represented by the token. Throws if not found.
- */
- get(token: any): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually a `Type`. (Same as the token used while setting up a binding).
- * @returns an instance represented by the token. Returns `null` if not found.
- */
- getOptional(token: any): any;
- /**
- * Retrieves an instance from the injector.
- *
- * @param `index`: index of an instance.
- * @returns an instance represented by the index. Throws if not found.
- */
- getAt(index: number): any;
- /**
- * Direct parent of this injector.
- */
- parent: Injector;
- /**
- * Internal. Do not use.
- *
- * We return `any` not to export the InjectorStrategy type.
- */
- internalStrategy: any;
- /**
- * Creates a child injector and loads a new set of bindings into it.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- * @param `depProvider`
- */
- resolveAndCreateChild(bindings: Array<Type | Binding | any[]>, depProvider?: DependencyProvider): Injector;
- /**
- * Creates a child injector and loads a new set of {@link ResolvedBinding}s into it.
- *
- * @param `bindings`: A sparse list of {@link ResolvedBinding}s.
- * See `resolve` for the {@link Injector}.
- * @param `depProvider`
- * @returns a new child {@link Injector}.
- */
- createChildFromResolved(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
- /**
- * Resolves a binding and instantiates an object in the context of the injector.
- *
- * @param `binding`: either a type or a binding.
- * @returns an object created using binding.
- */
- resolveAndInstantiate(binding: Type | Binding): any;
- /**
- * Instantiates an object using a resolved bindin in the context of the injector.
- *
- * @param `binding`: a resolved binding
- * @returns an object created using binding.
- */
- instantiateResolved(binding: ResolvedBinding): any;
- displayName: string;
- toString(): string;
- }
- class ProtoInjector {
- numberOfBindings: number;
- getBindingAtIndex(index: number): any;
- }
- class BindingWithVisibility {
- binding: ResolvedBinding;
- visibility: Visibility;
- getKeyId(): number;
- }
- /**
- * Used to provide dependencies that cannot be easily expressed as bindings.
- */
- interface DependencyProvider {
- getDependency(injector: Injector, binding: ResolvedBinding, dependency: Dependency): any;
- }
- enum Visibility {
- Public,
- Private,
- PublicAndPrivate
- }
- const UNDEFINED : Object ;
- /**
- * Describes how_ the {@link Injector} should instantiate a given token.
- *
- * See {@link bind}.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- class Binding {
- /**
- * Token used when retrieving this binding. Usually the `Type`.
- */
- token: any;
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass: Type;
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue: any;
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that {@link Injector} returns the same instance as if the alias token was used.
- * This is in contrast to `toClass` where a separate instance of `toClass` is returned.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias: any;
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory: Function;
- /**
- * Used in conjunction with `toFactory` and specifies a set of dependencies
- * (as `token`s) which should be injected into the factory function.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- dependencies: any[];
- /**
- * Converts the {@link Binding} into {@link ResolvedBinding}.
- *
- * {@link Injector} internally only uses {@link ResolvedBinding}, {@link Binding} contains
- * convenience binding syntax.
- */
- resolve(): ResolvedBinding;
- }
- /**
- * Helper class for the {@link bind} function.
- */
- class BindingBuilder {
- token: any;
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass(type: Type): Binding;
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(String).toValue('Hello')
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue(value: any): Binding;
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that we will return the same instance as if the alias token was used. (This is
- * in contrast to `toClass` where a separate instance of `toClass` will be returned.)
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias(aliasToken: /*Type*/ any): Binding;
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(Number).toFactory(() => { return 1+2; }),
- * bind(String).toFactory((v) => { return "Value: " + v; }, [Number])
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory(factoryFunction: Function, dependencies?: any[]): Binding;
- }
- /**
- * An internal resolved representation of a {@link Binding} used by the {@link Injector}.
- *
- * A {@link Binding} is resolved when it has a factory function. Binding to a class, alias, or
- * value, are just convenience methods, as {@link Injector} only operates on calling factory
- * functions.
- */
- class ResolvedBinding {
- /**
- * A key, usually a `Type`.
- */
- key: Key;
- /**
- * Factory function which can return an instance of an object represented by a key.
- */
- factory: Function;
- /**
- * Arguments (dependencies) to the `factory` function.
- */
- dependencies: Dependency[];
- }
- /**
- * @private
- */
- class Dependency {
- static fromKey(key: Key): Dependency;
- key: Key;
- optional: boolean;
- lowerBoundVisibility: any;
- upperBoundVisibility: any;
- properties: any[];
- }
- /**
- * Provides an API for imperatively constructing {@link Binding}s.
- *
- * This is only relevant for JavaScript. See {@link BindingBuilder}.
- *
- * ## Example
- *
- * ```javascript
- * bind(MyInterface).toClass(MyClass)
- *
- * ```
- */
- function bind(token: any) : BindingBuilder ;
- /**
- * A unique object used for retrieving items from the {@link Injector}.
- *
- * Keys have:
- * - a system-wide unique `id`.
- * - a `token`, usually the `Type` of the instance.
- *
- * Keys are used internally by the {@link Injector} because their system-wide unique `id`s allow the
- * injector to index in arrays rather than looking up items in maps.
- */
- class Key {
- /**
- * Retrieves a `Key` for a token.
- */
- static get(token: Object): Key;
- /**
- * @returns the number of keys registered in the system.
- */
- static numberOfKeys: number;
- token: Object;
- id: number;
- displayName: string;
- }
- /**
- * @private
- */
- class KeyRegistry {
- get(token: Object): Key;
- numberOfKeys: number;
- }
- /**
- * Type literals is a Dart-only feature. This is here only so we can x-compile
- * to multiple languages.
- */
- class TypeLiteral {
- type: any;
- }
- /**
- * Thrown when trying to retrieve a dependency by `Key` from {@link Injector}, but the
- * {@link Injector} does not have a {@link Binding} for {@link Key}.
- */
- class NoBindingError extends AbstractBindingError {
- }
- /**
- * Base class for all errors arising from misconfigured bindings.
- */
- class AbstractBindingError extends BaseException {
- name: string;
- message: string;
- keys: Key[];
- injectors: Injector[];
- constructResolvingMessage: Function;
- addKey(injector: Injector, key: Key): void;
- context: any;
- toString(): string;
- }
- /**
- * Thrown when dependencies form a cycle.
- *
- * ## Example:
- *
- * ```javascript
- * class A {
- * constructor(b:B) {}
- * }
- * class B {
- * constructor(a:A) {}
- * }
- * ```
- *
- * Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
- */
- class CyclicDependencyError extends AbstractBindingError {
- }
- /**
- * Thrown when a constructing type returns with an Error.
- *
- * The `InstantiationError` class contains the original error plus the dependency graph which caused
- * this object to be instantiated.
- */
- class InstantiationError extends AbstractBindingError {
- causeKey: Key;
- }
- /**
- * Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
- * creation.
- */
- class InvalidBindingError extends BaseException {
- message: string;
- toString(): string;
- }
- /**
- * Thrown when the class has no annotation information.
- *
- * Lack of annotation information prevents the {@link Injector} from determining which dependencies
- * need to be injected into the constructor.
- */
- class NoAnnotationError extends BaseException {
- name: string;
- message: string;
- toString(): string;
- }
- /**
- * Thrown when getting an object by index.
- */
- class OutOfBoundsError extends BaseException {
- message: string;
- toString(): string;
- }
- class OpaqueToken {
- toString(): string;
- }
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- interface InjectFactory {
- new(token: any): InjectMetadata;
- (token: any): any;
- }
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- interface OptionalFactory {
- new(): OptionalMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- interface InjectableFactory {
- new(): InjectableMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- interface SelfFactory {
- new(): SelfMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link HostMetadata}.
- */
- interface HostFactory {
- new(): HostMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- interface SkipSelfFactory {
- new(): SkipSelfMetadata;
- (): any;
- }
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- var Inject : InjectFactory ;
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- var Optional : OptionalFactory ;
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- var Injectable : InjectableFactory ;
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- var Self : SelfFactory ;
- /**
- * Factory for creating {@link HostMetadata}.
- */
- var Host : HostFactory ;
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- var SkipSelf : SkipSelfFactory ;
- /**
- * A collection of the Angular core directives that are likely to be used in each and every Angular
- * application.
- *
- * This collection can be used to quickly enumerate all the built-in directives in the `@View`
- * annotation. For example,
- * instead of writing:
- *
- * ```
- * import {NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- * one could import all the core directives at once:
- *
- * ```
- * import {CORE_DIRECTIVES} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [CORE_DIRECTIVES, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- */
- const CORE_DIRECTIVES : Type[] ;
- /**
- * Adds and removes CSS classes based on an {expression} value.
- *
- * The result of expression is used to add and remove CSS classes using the following logic,
- * based on expression's value type:
- * - {string} - all the CSS classes (space - separated) are added
- * - {Array} - all the CSS classes (Array elements) are added
- * - {Object} - each key corresponds to a CSS class name while values
- * are interpreted as {boolean} expression. If a given expression
- * evaluates to {true} a corresponding CSS class is added - otherwise
- * it is removed.
- *
- * # Example:
- *
- * ```
- * <div class="message" [ng-class]="{error: errorCount > 0}">
- * Please check errors.
- * </div>
- * ```
- */
- class NgClass {
- initialClasses: any;
- rawClass: any;
- doCheck(): void;
- onDestroy(): void;
- }
- /**
- * The `NgFor` directive instantiates a template once per item from an iterable. The context for
- * each instantiated template inherits from the outer context with the given loop variable set
- * to the current item from the iterable.
- *
- * It is possible to alias the `index` to a local variable that will be set to the current loop
- * iteration in the template context.
- *
- * When the contents of the iterator changes, `NgFor` makes the corresponding changes to the DOM:
- *
- * * When an item is added, a new instance of the template is added to the DOM.
- * * When an item is removed, its template instance is removed from the DOM.
- * * When items are reordered, their respective templates are reordered in the DOM.
- *
- * # Example
- *
- * ```
- * <ul>
- * <li *ng-for="#error of errors; #i = index">
- * Error {{i}} of {{errors.length}}: {{error.message}}
- * </li>
- * </ul>
- * ```
- *
- * # Syntax
- *
- * - `<li *ng-for="#item of items; #i = index">...</li>`
- * - `<li template="ng-for #item of items; #i = index">...</li>`
- * - `<template ng-for #item [ng-for-of]="items" #i="index"><li>...</li></template>`
- */
- class NgFor {
- static bulkRemove(tuples: RecordViewTuple[], viewContainer: ViewContainerRef): RecordViewTuple[];
- static bulkInsert(tuples: RecordViewTuple[], viewContainer: ViewContainerRef, templateRef: TemplateRef): RecordViewTuple[];
- viewContainer: ViewContainerRef;
- templateRef: TemplateRef;
- iterableDiffers: IterableDiffers;
- cdr: ChangeDetectorRef;
- ngForOf: any;
- doCheck(): void;
- }
- class RecordViewTuple {
- view: ViewRef;
- record: any;
- }
- /**
- * Removes or recreates a portion of the DOM tree based on an {expression}.
- *
- * If the expression assigned to `ng-if` evaluates to a false value then the element
- * is removed from the DOM, otherwise a clone of the element is reinserted into the DOM.
- *
- * # Example:
- *
- * ```
- * <div *ng-if="errorCount > 0" class="error">
- * <!-- Error message displayed when the errorCount property on the current context is greater
- * than 0. -->
- * {{errorCount}} errors detected
- * </div>
- * ```
- *
- * # Syntax
- *
- * - `<div *ng-if="condition">...</div>`
- * - `<div template="ng-if condition">...</div>`
- * - `<template [ng-if]="condition"><div>...</div></template>`
- */
- class NgIf {
- ngIf: any;
- }
- /**
- * The `NgNonBindable` directive tells Angular not to compile or bind the contents of the current
- * DOM element. This is useful if the element contains what appears to be Angular directives and
- * bindings but which should be ignored by Angular. This could be the case if you have a site that
- * displays snippets of code, for instance.
- *
- * Example:
- *
- * ```
- * <div>Normal: {{1 + 2}}</div> // output "Normal: 3"
- * <div ng-non-bindable>Ignored: {{1 + 2}}</div> // output "Ignored: {{1 + 2}}"
- * ```
- */
- class NgNonBindable {
- }
- /**
- * Adds or removes styles based on an {expression}.
- *
- * When the expression assigned to `ng-style` evaluates to an object, the corresponding element
- * styles are updated. Style names to update are taken from the object keys and values - from the
- * corresponding object values.
- *
- * # Example:
- *
- * ```
- * <div [ng-style]="{'text-align': alignExp}"></div>
- * ```
- *
- * In the above example the `text-align` style will be updated based on the `alignExp` value
- * changes.
- *
- * # Syntax
- *
- * - `<div [ng-style]="{'text-align': alignExp}"></div>`
- * - `<div [ng-style]="styleExp"></div>`
- */
- class NgStyle {
- rawStyle: any;
- doCheck(): void;
- }
- class SwitchView {
- create(): void;
- destroy(): void;
- }
- /**
- * The `NgSwitch` directive is used to conditionally swap DOM structure on your template based on a
- * scope expression.
- * Elements within `NgSwitch` but without `NgSwitchWhen` or `NgSwitchDefault` directives will be
- * preserved at the location as specified in the template.
- *
- * `NgSwitch` simply chooses nested elements and makes them visible based on which element matches
- * the value obtained from the evaluated expression. In other words, you define a container element
- * (where you place the directive), place an expression on the **`[ng-switch]="..."` attribute**),
- * define any inner elements inside of the directive and place a `[ng-switch-when]` attribute per
- * element.
- * The when attribute is used to inform NgSwitch which element to display when the expression is
- * evaluated. If a matching expression is not found via a when attribute then an element with the
- * default attribute is displayed.
- *
- * # Example:
- *
- * ```
- * <ANY [ng-switch]="expression">
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template ng-switch-default>...</template>
- * </ANY>
- * ```
- */
- class NgSwitch {
- ngSwitch: any;
- }
- /**
- * Defines a case statement as an expression.
- *
- * If multiple `NgSwitchWhen` match the `NgSwitch` value, all of them are displayed.
- *
- * Example:
- *
- * ```
- * // match against a context variable
- * <template [ng-switch-when]="contextVariable">...</template>
- *
- * // match against a constant string
- * <template ng-switch-when="stringValue">...</template>
- * ```
- */
- class NgSwitchWhen {
- ngSwitchWhen: any;
- }
- /**
- * Defines a default case statement.
- *
- * Default case statements are displayed when no `NgSwitchWhen` match the `ng-switch` value.
- *
- * Example:
- *
- * ```
- * <template ng-switch-default>...</template>
- * ```
- */
- class NgSwitchDefault {
- }
- /**
- * Omitting from external API doc as this is really an abstract internal concept.
- */
- class AbstractControl {
- validator: Function;
- value: any;
- status: string;
- valid: boolean;
- errors: StringMap<string, any>;
- pristine: boolean;
- dirty: boolean;
- touched: boolean;
- untouched: boolean;
- valueChanges: Observable;
- markAsTouched(): void;
- markAsDirty({onlySelf}?: {onlySelf?: boolean}): void;
- setParent(parent: ControlGroup | ControlArray): void;
- updateValidity({onlySelf}?: {onlySelf?: boolean}): void;
- updateValueAndValidity({onlySelf, emitEvent}?: {onlySelf?: boolean, emitEvent?: boolean}): void;
- find(path: Array<string | number>| string): AbstractControl;
- getError(errorCode: string, path?: string[]): any;
- hasError(errorCode: string, path?: string[]): boolean;
- }
- /**
- * Defines a part of a form that cannot be divided into other controls.
- *
- * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
- * with
- * {@link ControlGroup} and {@link ControlArray}.
- */
- class Control extends AbstractControl {
- updateValue(value: any, {onlySelf, emitEvent, emitModelToViewChange}?:
- {onlySelf?: boolean, emitEvent?: boolean, emitModelToViewChange?: boolean}): void;
- registerOnChange(fn: Function): void;
- }
- /**
- * Defines a part of a form, of fixed length, that can contain other controls.
- *
- * A ControlGroup aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlGroup` is one of the three fundamental building blocks used to define forms in Angular,
- * along with
- * {@link Control} and {@link ControlArray}. {@link ControlArray} can also contain other controls,
- * but is of variable
- * length.
- */
- class ControlGroup extends AbstractControl {
- controls: StringMap<string, AbstractControl>;
- addControl(name: string, c: AbstractControl): void;
- removeControl(name: string): void;
- include(controlName: string): void;
- exclude(controlName: string): void;
- contains(controlName: string): boolean;
- }
- /**
- * Defines a part of a form, of variable length, that can contain other controls.
- *
- * A `ControlArray` aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlArray` is one of the three fundamental building blocks used to define forms in Angular,
- * along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
- * other controls, but is of fixed length.
- */
- class ControlArray extends AbstractControl {
- controls: AbstractControl[];
- at(index: number): AbstractControl;
- push(control: AbstractControl): void;
- insert(index: number, control: AbstractControl): void;
- removeAt(index: number): void;
- length: number;
- }
- class AbstractControlDirective {
- control: AbstractControl;
- value: any;
- valid: boolean;
- errors: StringMap<string, any>;
- pristine: boolean;
- dirty: boolean;
- touched: boolean;
- untouched: boolean;
- }
- /**
- * An interface that {@link NgFormModel} and {@link NgForm} implement.
- *
- * Only used by the forms module.
- */
- interface Form {
- addControl(dir: NgControl): void;
- removeControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- }
- /**
- * A directive that contains a group of [NgControl].
- *
- * Only used by the forms module.
- */
- class ControlContainer extends AbstractControlDirective {
- name: string;
- formDirective: Form;
- path: string[];
- }
- /**
- * Creates and binds a control with a specified name to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the login and password controls.
- * We can work with each control separately: check its validity, get its value, listen to its
- * changes.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onLogIn(f.value)'>
- * Login <input type='text' ng-control='login' #l="form">
- * <div *ng-if="!l.valid">Login is invalid</div>
- *
- * Password <input type='password' ng-control='password'>
- *
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * onLogIn(value) {
- * // value === {login: 'some login', password: 'some password'}
- * }
- * }
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form (submit)='onLogIn()'>
- * Login <input type='text' ng-control='login' [(ng-model)]="credentials.login">
- * Password <input type='password' ng-control='password'
- * [(ng-model)]="credentials.password">
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * credentials: {login:string, password:string};
- *
- * onLogIn() {
- * // this.credentials.login === "some login"
- * // this.credentials.password === "some password"
- * }
- * }
- * ```
- */
- class NgControlName extends NgControl {
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- onDestroy(): void;
- viewToModelUpdate(newValue: any): void;
- path: string[];
- formDirective: any;
- control: Control;
- validator: Function;
- }
- /**
- * Binds an existing control to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control to an input element. When the value of the input element
- * changes, the value of
- * the control will reflect that change. Likewise, if the value of the control changes, the input
- * element reflects that
- * change.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl'>"
- * })
- * class LoginComp {
- * loginControl:Control;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl' [(ng-model)]='login'>"
- * })
- * class LoginComp {
- * loginControl:Control;
- * login:string;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- * ```
- */
- class NgFormControl extends NgControl {
- form: Control;
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- path: string[];
- control: Control;
- validator: Function;
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * Binds a domain model to the form.
- *
- * # Example
- * ```
- * @Component({selector: "search-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <input type='text' [(ng-model)]="searchQuery">
- * `})
- * class SearchComp {
- * searchQuery: string;
- * }
- * ```
- */
- class NgModel extends NgControl {
- update: any;
- model: any;
- viewModel: any;
- ngValidators: QueryList<NgValidator>;
- onChanges(c: StringMap<string, any>): void;
- control: Control;
- path: string[];
- validator: Function;
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * An abstract class that all control directive extend.
- *
- * It binds a {@link Control} object to a DOM element.
- */
- class NgControl extends AbstractControlDirective {
- name: string;
- valueAccessor: ControlValueAccessor;
- validator: Function;
- path: string[];
- viewToModelUpdate(newValue: any): void;
- }
- /**
- * Creates and binds a control group to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the credentials and personal control groups.
- * We can work with each group separately: check its validity, get its value, listen to its changes.
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgControlGroup extends ControlContainer {
- onInit(): void;
- onDestroy(): void;
- control: ControlGroup;
- path: string[];
- formDirective: Form;
- }
- /**
- * Binds an existing control group to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control group to the form element, and we bind the login and
- * password controls to the
- * login and password elements.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<form [ng-form-model]='loginForm'>" +
- * "Login <input type='text' ng-control='login'>" +
- * "Password <input type='password' ng-control='password'>" +
- * "<button (click)="onLogin()">Login</button>" +
- * "</form>"
- * })
- * class LoginComp {
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.loginForm.value
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<form [ng-form-model]='loginForm'>" +
- * "Login <input type='text' ng-control='login' [(ng-model)]='login'>" +
- * "Password <input type='password' ng-control='password' [(ng-model)]='password'>" +
- * "<button (click)="onLogin()">Login</button>" +
- * "</form>"
- * })
- * class LoginComp {
- * credentials:{login:string, password:string}
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.credentials.login === 'some login'
- * // this.credentials.password === 'some password'
- * }
- * }
- * ```
- */
- class NgFormModel extends ControlContainer implements Form {
- form: ControlGroup;
- directives: NgControl[];
- ngSubmit: any;
- onChanges(_: any): void;
- formDirective: Form;
- control: ControlGroup;
- path: string[];
- addControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- removeControl(dir: NgControl): void;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- onSubmit(): boolean;
- }
- /**
- * Creates and binds a form object to a DOM element.
- *
- * # Example
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgForm extends ControlContainer implements Form {
- form: ControlGroup;
- ngSubmit: any;
- formDirective: Form;
- control: ControlGroup;
- path: string[];
- controls: StringMap<string, AbstractControl>;
- addControl(dir: NgControl): void;
- getControl(dir: NgControl): Control;
- removeControl(dir: NgControl): void;
- addControlGroup(dir: NgControlGroup): void;
- removeControlGroup(dir: NgControlGroup): void;
- getControlGroup(dir: NgControlGroup): ControlGroup;
- updateModel(dir: NgControl, value: any): void;
- onSubmit(): boolean;
- }
- /**
- * A bridge between a control and a native element.
- *
- * Please see {@link DefaultValueAccessor} for more information.
- */
- interface ControlValueAccessor {
- writeValue(obj: any): void;
- registerOnChange(fn: any): void;
- registerOnTouched(fn: any): void;
- }
- /**
- * The default accessor for writing a value and listening to changes that is used by the
- * {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
- *
- * # Example
- * ```
- * <input type="text" [(ng-model)]="searchQuery">
- * ```
- */
- class DefaultValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: (_: any) => void): void;
- registerOnTouched(fn: () => void): void;
- }
- /**
- * The accessor for writing a value and listening to changes on a checkbox input element.
- *
- * # Example
- * ```
- * <input type="checkbox" [ng-control]="rememberLogin">
- * ```
- */
- class CheckboxControlValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: (_: any) => {}): void;
- registerOnTouched(fn: () => {}): void;
- }
- /**
- * Marks <option> as dynamic, so Angular can be notified when options change.
- *
- * #Example:
- *
- * ```
- * <select ng-control="city">
- * <option *ng-for="#c of cities" [value]="c"></option>
- * </select>
- * ```
- */
- class NgSelectOption {
- }
- /**
- * The accessor for writing a value and listening to changes on a select element.
- */
- class SelectControlValueAccessor implements ControlValueAccessor {
- cd: NgControl;
- value: string;
- onChange: any;
- onTouched: any;
- renderer: Renderer;
- elementRef: ElementRef;
- writeValue(value: any): void;
- ngClassUntouched: boolean;
- ngClassTouched: boolean;
- ngClassPristine: boolean;
- ngClassDirty: boolean;
- ngClassValid: boolean;
- ngClassInvalid: boolean;
- registerOnChange(fn: () => any): void;
- registerOnTouched(fn: () => any): void;
- }
- /**
- * A list of all the form directives used as part of a `@View` annotation.
- *
- * This is a shorthand for importing them each individually.
- */
- const FORM_DIRECTIVES : Type[] ;
- /**
- * Provides a set of validators used by form controls.
- *
- * # Example
- *
- * ```
- * var loginControl = new Control("", Validators.required)
- * ```
- */
- class Validators {
- static required(c:Control): StringMap<string, boolean>;
- static nullValidator(c: any): StringMap<string, boolean>;
- static compose(validators: Function[]): Function;
- static group(c:ControlGroup): StringMap<string, boolean>;
- static array(c:ControlArray): StringMap<string, boolean>;
- }
- class NgValidator {
- validator: Function;
- }
- class NgRequiredValidator extends NgValidator {
- validator: Function;
- }
- /**
- * Creates a form object from a user-specified configuration.
- *
- * # Example
- *
- * ```
- * import {Component, View, bootstrap} from 'angular2/angular2';
- * import {FormBuilder, Validators, FORM_DIRECTIVES, ControlGroup} from 'angular2/forms';
- *
- * @Component({
- * selector: 'login-comp',
- * viewBindings: [
- * FormBuilder
- * ]
- * })
- * @View({
- * template: `
- * <form [control-group]="loginForm">
- * Login <input control="login">
- *
- * <div control-group="passwordRetry">
- * Password <input type="password" control="password">
- * Confirm password <input type="password" control="passwordConfirmation">
- * </div>
- * </form>
- * `,
- * directives: [
- * FORM_DIRECTIVES
- * ]
- * })
- * class LoginComp {
- * loginForm: ControlGroup;
- *
- * constructor(builder: FormBuilder) {
- * this.loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- * }
- * }
- *
- * bootstrap(LoginComp)
- * ```
- *
- * This example creates a {@link ControlGroup} that consists of a `login` {@link Control}, and a
- * nested
- * {@link ControlGroup} that defines a `password` and a `passwordConfirmation` {@link Control}:
- *
- * ```
- * var loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- *
- * ```
- */
- class FormBuilder {
- group(controlsConfig: StringMap<string, any>, extra?: StringMap<string, any>): ControlGroup;
- control(value: Object, validator?: Function): Control;
- array(controlsConfig: any[], validator?: Function): ControlArray;
- }
- const FORM_BINDINGS : Type[] ;
- class RenderDirectiveMetadata {
- static DIRECTIVE_TYPE: any;
- static COMPONENT_TYPE: any;
- static create({id, selector, compileChildren, events, host, properties, readAttributes, type,
- callOnDestroy, callOnChanges, callDoCheck, callOnInit, callAfterContentInit,
- callAfterContentChecked, callAfterViewInit, callAfterViewChecked, changeDetection,
- exportAs}: {
- id?: string,
- selector?: string,
- compileChildren?: boolean,
- events?: string[],
- host?: Map<string, string>,
- properties?: string[],
- readAttributes?: string[],
- type?: number,
- callOnDestroy?: boolean,
- callOnChanges?: boolean,
- callDoCheck?: boolean,
- callOnInit?: boolean,
- callAfterContentInit?: boolean,
- callAfterContentChecked?: boolean,
- callAfterViewInit?: boolean,
- callAfterViewChecked?: boolean,
- changeDetection?: ChangeDetectionStrategy,
- exportAs?: string
- }): RenderDirectiveMetadata;
- id: any;
- selector: string;
- compileChildren: boolean;
- events: string[];
- properties: string[];
- readAttributes: string[];
- type: number;
- callOnDestroy: boolean;
- callOnChanges: boolean;
- callDoCheck: boolean;
- callOnInit: boolean;
- callAfterContentInit: boolean;
- callAfterContentChecked: boolean;
- callAfterViewInit: boolean;
- callAfterViewChecked: boolean;
- changeDetection: ChangeDetectionStrategy;
- exportAs: string;
- hostListeners: Map<string, string>;
- hostProperties: Map<string, string>;
- hostAttributes: Map<string, string>;
- }
- class DomRenderer extends Renderer {
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
- destroyView(viewRef: RenderViewRef): void;
- getNativeElementSync(location: RenderElementRef): any;
- getRootNodes(fragment: RenderFragmentRef): Node[];
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
- detachFragment(fragmentRef: RenderFragmentRef): void;
- hydrateView(viewRef: RenderViewRef): void;
- dehydrateView(viewRef: RenderViewRef): void;
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: any): void;
- }
- /**
- * A dispatcher for all events happening in a view.
- */
- interface RenderEventDispatcher {
- /**
- * Called when an event was triggered for a on-* attribute on an element.
- * @param {Map<string, any>} locals Locals to be used to evaluate the
- * event expressions
- * @return {boolean} False if `preventDefault` should be called on the DOM event.
- */
- dispatchRenderEvent(elementIndex: number, eventName: string, locals: Map<string, any>): boolean;
- }
- class Renderer {
- /**
- * Creates a root host view that includes the given element.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- *
- * @param {RenderProtoViewRef} hostProtoViewRef a RenderProtoViewRef of type
- * ProtoViewDto.HOST_VIEW_TYPE
- * @param {any} hostElementSelector css selector for the host element (will be queried against the
- * main document)
- * @return {RenderViewWithFragments} the created view including fragments
- */
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
- /**
- * Creates a regular view out of the given ProtoView.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- */
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
- /**
- * Destroys the given view after it has been dehydrated and detached
- */
- destroyView(viewRef: RenderViewRef): void;
- /**
- * Attaches a fragment after another fragment.
- */
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
- /**
- * Attaches a fragment after an element.
- */
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
- /**
- * Detaches a fragment.
- */
- detachFragment(fragmentRef: RenderFragmentRef): void;
- /**
- * Hydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- hydrateView(viewRef: RenderViewRef): void;
- /**
- * Dehydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- dehydrateView(viewRef: RenderViewRef): void;
- /**
- * Returns the native element at the given location.
- * Attention: In a WebWorker scenario, this should always return null!
- */
- getNativeElementSync(location: RenderElementRef): any;
- /**
- * Sets a property on an element.
- */
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
- /**
- * Sets an attribute on an element.
- */
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
- /**
- * Sets a class on an element.
- */
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
- /**
- * Sets a style on an element.
- */
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
- /**
- * Calls a method on an element.
- */
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
- /**
- * Sets the value of a text node.
- */
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
- /**
- * Sets the dispatcher for all events of the given view
- */
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: RenderEventDispatcher): void;
- }
- /**
- * Abstract reference to the element which can be marshaled across web-worker boundary.
- *
- * This interface is used by the Renderer API.
- */
- interface RenderElementRef {
- /**
- * Reference to the `RenderViewRef` where the `RenderElementRef` is inside of.
- */
- renderView: RenderViewRef;
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
- }
- class RenderViewRef {
- }
- class RenderProtoViewRef {
- }
- class RenderFragmentRef {
- }
- class RenderViewWithFragments {
- viewRef: RenderViewRef;
- fragmentRefs: RenderFragmentRef[];
- }
- class ViewDefinition {
- componentId: string;
- templateAbsUrl: string;
- template: string;
- directives: RenderDirectiveMetadata[];
- styleAbsUrls: string[];
- styles: string[];
- encapsulation: ViewEncapsulation;
- }
- const DOCUMENT : OpaqueToken ;
- /**
- * A unique id (string) for an angular application.
- */
- const APP_ID : OpaqueToken ;
- /**
- * Defines when a compiled template should be stored as a string
- * rather than keeping its Nodes to preserve memory.
- */
- const MAX_IN_MEMORY_ELEMENTS_PER_TEMPLATE : OpaqueToken ;
- /**
- * Create trace scope.
- *
- * Scopes must be strictly nested and are analogous to stack frames, but
- * do not have to follow the stack frames. Instead it is recommended that they follow logical
- * nesting. You may want to use
- * [Event
- * Signatures](http://google.github.io/tracing-framework/instrumenting-code.html#custom-events)
- * as they are defined in WTF.
- *
- * Used to mark scope entry. The return value is used to leave the scope.
- *
- * var myScope = wtfCreateScope('MyClass#myMethod(ascii someVal)');
- *
- * someMethod() {
- * var s = myScope('Foo'); // 'Foo' gets stored in tracing UI
- * // DO SOME WORK HERE
- * return wtfLeave(s, 123); // Return value 123
- * }
- *
- * Note, adding try-finally block around the work to ensure that `wtfLeave` gets called can
- * negatively impact the performance of your application. For this reason we recommend that
- * you don't add them to ensure that `wtfLeave` gets called. In production `wtfLeave` is a noop and
- * so try-finally block has no value. When debugging perf issues, skipping `wtfLeave`, do to
- * exception, will produce incorrect trace, but presence of exception signifies logic error which
- * needs to be fixed before the app should be profiled. Add try-finally only when you expect that
- * an exception is expected during normal execution while profiling.
- */
- var wtfCreateScope : WtfScopeFn ;
- /**
- * Used to mark end of Scope.
- *
- * - `scope` to end.
- * - `returnValue` (optional) to be passed to the WTF.
- *
- * Returns the `returnValue for easy chaining.
- */
- var wtfLeave : <T>(scope: any, returnValue?: T) => T ;
- /**
- * Used to mark Async start. Async are similar to scope but they don't have to be strictly nested.
- * The return value is used in the call to [endAsync]. Async ranges only work if WTF has been
- * enabled.
- *
- * someMethod() {
- * var s = wtfStartTimeRange('HTTP:GET', 'some.url');
- * var future = new Future.delay(5).then((_) {
- * wtfEndTimeRange(s);
- * });
- * }
- */
- var wtfStartTimeRange : (rangeType: string, action: string) => any ;
- /**
- * Ends a async time range operation.
- * [range] is the return value from [wtfStartTimeRange] Async ranges only work if WTF has been
- * enabled.
- */
- var wtfEndTimeRange : (range: any) => void ;
- interface WtfScopeFn {
- (arg0?: any, arg1?: any): any;
- }
- /**
- * Bootstrapping a Webworker Application
- *
- * You instantiate the application side by calling bootstrapWebworker from your webworker index
- * script.
- * You can call bootstrapWebworker() exactly as you would call bootstrap() in a regular Angular
- * application
- * See the bootstrap() docs for more details.
- */
- function bootstrapWebWorker(appComponentType: Type, componentInjectableBindings?: Array<Type | Binding | any[]>) : Promise<ApplicationRef> ;
- /**
- * Message Bus is a low level API used to communicate between the UI and the background.
- * Communication is based on a channel abstraction. Messages published in a
- * given channel to one MessageBusSink are received on the same channel
- * by the corresponding MessageBusSource.
- */
- class MessageBus implements MessageBusSource, MessageBusSink {
- /**
- * Returns an {@link EventEmitter} that emits every time a messsage
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
- }
- interface MessageBusSource {
- /**
- * Returns an {@link EventEmitter} that emits every time a messsage
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
- }
- interface MessageBusSink {
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
- }
- class ClientMessageBrokerFactory {
- createMessageBroker(channel: string): ClientMessageBroker;
- }
- class ClientMessageBroker {
- channel: any;
- runOnService(args: UiArguments, returnType: Type): Promise<any>;
- }
- class FnArg {
- value: any;
- type: Type;
- }
- class UiArguments {
- method: string;
- args: FnArg[];
- }
- class ServiceMessageBrokerFactory {
- createMessageBroker(channel: string): ServiceMessageBroker;
- }
- /**
- * Helper class for UIComponents that allows components to register methods.
- * If a registered method message is received from the broker on the worker,
- * the UIMessageBroker desererializes its arguments and calls the registered method.
- * If that method returns a promise, the UIMessageBroker returns the result to the worker.
- */
- class ServiceMessageBroker {
- channel: any;
- registerMethod(methodName: string, signature: Type[], method: Function, returnType?: Type): void;
- }
- class ReceivedMessage {
- method: string;
- args: any[];
- id: string;
- type: string;
- }
- const PRIMITIVE : Type ;
- class Serializer {
- serialize(obj: any, type: Type): Object;
- deserialize(map: any, type: Type, data?: any): any;
- mapToObject(map: Map<string, any>, type?: Type): Object;
- objectToMap(obj: StringMap<string, any>, type?: Type, data?: any): Map<string, any>;
- allocateRenderViews(fragmentCount: number): void;
- }
- var ChangeDetectorRef: InjectableReference;
- var ApplicationRef: InjectableReference;
- var Compiler: InjectableReference;
- var AppViewManager: InjectableReference;
- var ViewRef: InjectableReference;
- var ProtoViewRef: InjectableReference;
- var ViewContainerRef: InjectableReference;
- var ComponentRef: InjectableReference;
- }
- declare module "angular2/web_worker/worker" {
- export = ngWorker;
- }
- declare module ngUi {
- class WebWorkerApplication {
- createClientMessageBroker(channel: string): ClientMessageBroker;
- createServiceMessageBroker(channel: string): ServiceMessageBroker;
- }
- /**
- * Bootstrapping a WebWorker
- *
- * You instantiate a WebWorker application by calling bootstrap with the URI of your worker's index
- * script
- * Note: The WebWorker script must call bootstrapWebworker once it is set up to complete the
- * bootstrapping process
- */
- function bootstrap(uri: string) : WebWorkerInstance ;
- function spawnWebWorker(uri: string) : WebWorkerInstance ;
- /**
- * Wrapper class that exposes the {@link WebWorkerApplication}
- * Isolate instance and underyling {@link MessageBus} for lower level message passing.
- */
- class WebWorkerInstance {
- app: WebWorkerApplication;
- worker: Worker;
- bus: MessageBus;
- }
- /**
- * Use Rx.Observable but provides an adapter to make it work as specified here:
- * https://github.com/jhusain/observable-spec
- *
- * Once a reference implementation of the spec is available, switch to it.
- */
- class EventEmitter extends Observable {
- observer(generator: any): Rx.IDisposable;
- toRx(): Rx.Observable<any>;
- next(value: any): void;
- throw(error: any): void;
- return(value?: any): void;
- }
- class Observable {
- observer(generator: any): Object;
- }
- /**
- * Message Bus is a low level API used to communicate between the UI and the background.
- * Communication is based on a channel abstraction. Messages published in a
- * given channel to one MessageBusSink are received on the same channel
- * by the corresponding MessageBusSource.
- */
- class MessageBus implements MessageBusSource, MessageBusSink {
- /**
- * Returns an {@link EventEmitter} that emits every time a messsage
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
- }
- interface MessageBusSource {
- /**
- * Returns an {@link EventEmitter} that emits every time a messsage
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
- }
- interface MessageBusSink {
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
- }
- /**
- * Runtime representation of a type.
- *
- * In JavaScript a Type is a constructor function.
- */
- interface Type extends Function {
- new(...args: any[]): any;
- }
- class ClientMessageBrokerFactory {
- createMessageBroker(channel: string): ClientMessageBroker;
- }
- class ClientMessageBroker {
- channel: any;
- runOnService(args: UiArguments, returnType: Type): Promise<any>;
- }
- class FnArg {
- value: any;
- type: Type;
- }
- class UiArguments {
- method: string;
- args: FnArg[];
- }
- class ServiceMessageBrokerFactory {
- createMessageBroker(channel: string): ServiceMessageBroker;
- }
- /**
- * Helper class for UIComponents that allows components to register methods.
- * If a registered method message is received from the broker on the worker,
- * the UIMessageBroker desererializes its arguments and calls the registered method.
- * If that method returns a promise, the UIMessageBroker returns the result to the worker.
- */
- class ServiceMessageBroker {
- channel: any;
- registerMethod(methodName: string, signature: Type[], method: Function, returnType?: Type): void;
- }
- class ReceivedMessage {
- method: string;
- args: any[];
- id: string;
- type: string;
- }
- const PRIMITIVE : Type ;
- class Serializer {
- serialize(obj: any, type: Type): Object;
- deserialize(map: any, type: Type, data?: any): any;
- mapToObject(map: Map<string, any>, type?: Type): Object;
- objectToMap(obj: StringMap<string, any>, type?: Type, data?: any): Map<string, any>;
- allocateRenderViews(fragmentCount: number): void;
- }
- }
- declare module "angular2/web_worker/ui" {
- export = ngUi;
- }
|
