| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214 |
- // 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;
- }
|