Module
x/path_to_regexp/index.spec.ts
Turn a path string such as `/user/:name` into a regular expression
Very Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952import * as util from "util";import * as pathToRegexp from "./index";import semver from "semver";
type Test = [ pathToRegexp.Path, (pathToRegexp.TokensToRegexpOptions & pathToRegexp.ParseOptions) | undefined, pathToRegexp.Token[], Array< [ string, (string | undefined)[] | null, pathToRegexp.Match?, pathToRegexp.RegexpToFunctionOptions? ] >, Array<[any, string | null, pathToRegexp.TokensToFunctionOptions?]>];
/** * An array of test cases with expected inputs and outputs. */const TESTS: Test[] = [ /** * Simple paths. */ [ "/", undefined, ["/"], [ ["/", ["/"], { path: "/", index: 0, params: {} }], ["/route", null, false], ], [ [null, "/"], [{}, "/"], [{ id: 123 }, "/"], ], ], [ "/test", undefined, ["/test"], [ ["/test", ["/test"], { path: "/test", index: 0, params: {} }], ["/route", null, false], ["/test/route", null, false], ["/test/", ["/test/"], { path: "/test/", index: 0, params: {} }], ], [ [null, "/test"], [{}, "/test"], ], ], [ "/test/", undefined, ["/test/"], [ ["/test", null], ["/test/", ["/test/"]], ["/test//", ["/test//"]], ], [[null, "/test/"]], ],
/** * Case-sensitive paths. */ [ "/test", { sensitive: true, }, ["/test"], [ ["/test", ["/test"]], ["/TEST", null], ], [[null, "/test"]], ], [ "/TEST", { sensitive: true, }, ["/TEST"], [ ["/test", null], ["/TEST", ["/TEST"]], ], [[null, "/TEST"]], ],
/** * Strict mode. */ [ "/test", { strict: true, }, ["/test"], [ ["/test", ["/test"]], ["/test/", null], ["/TEST", ["/TEST"]], ], [[null, "/test"]], ], [ "/test/", { strict: true, }, ["/test/"], [ ["/test", null], ["/test/", ["/test/"]], ["/test//", null], ], [[null, "/test/"]], ],
/** * Non-ending mode. */ [ "/test", { end: false, }, ["/test"], [ ["/test", ["/test"]], ["/test/", ["/test/"]], ["/test/route", ["/test"]], ["/route", null], ], [[null, "/test"]], ], [ "/test/", { end: false, }, ["/test/"], [ ["/test", null], ["/test/route", ["/test/"]], ["/test//", ["/test//"]], ["/test//route", ["/test/"]], ], [[null, "/test/"]], ], [ "/:test", { end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ [ "/route", ["/route", "route"], { path: "/route", index: 0, params: { test: "route" } }, ], [ "/caf%C3%A9", ["/caf%C3%A9", "caf%C3%A9"], { path: "/caf%C3%A9", index: 0, params: { test: "caf%C3%A9" } }, ], [ "/caf%C3%A9", ["/caf%C3%A9", "caf%C3%A9"], { path: "/caf%C3%A9", index: 0, params: { test: "café" } }, { decode: decodeURIComponent }, ], ], [ [{}, null], [{ test: "abc" }, "/abc"], [{ test: "a+b" }, "/a+b"], [{ test: "a+b" }, "/test", { encode: (_, token) => String(token.name) }], [{ test: "a+b" }, "/a%2Bb", { encode: encodeURIComponent }], ], ], [ "/:test/", { end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route", null], ["/route/", ["/route/", "route"]], ], [[{ test: "abc" }, "/abc/"]], ], [ "", { end: false, }, [], [ ["", [""]], ["/", ["/"]], ["route", [""]], ["/route", [""]], ["/route/", [""]], ], [[null, ""]], ],
/** * Non-starting mode. */ [ "/test", { start: false, }, ["/test"], [ ["/test", ["/test"]], ["/test/", ["/test/"]], ["/route/test", ["/test"]], ["/test/route", null], ["/route/test/deep", null], ["/route", null], ], [[null, "/test"]], ], [ "/test/", { start: false, }, ["/test/"], [ ["/test", null], ["/test/route", null], ["/test//route", null], ["/test//", ["/test//"]], ["/route/test/", ["/test/"]], ], [[null, "/test/"]], ], [ "/:test", { start: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [["/route", ["/route", "route"]]], [ [{}, null], [{ test: "abc" }, "/abc"], [{ test: "a+b" }, "/a+b"], [{ test: "a+b" }, "/test", { encode: (_, token) => String(token.name) }], [{ test: "a+b" }, "/a%2Bb", { encode: encodeURIComponent }], ], ], [ "/:test/", { start: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route", null], ["/route/", ["/route/", "route"]], ], [[{ test: "abc" }, "/abc/"]], ], [ "", { start: false, }, [], [ ["", [""]], ["/", ["/"]], ["route", [""]], ["/route", [""]], ["/route/", ["/"]], ], [[null, ""]], ],
/** * Combine modes. */ [ "/test", { end: false, strict: true, }, ["/test"], [ ["/test", ["/test"]], ["/test/", ["/test"]], ["/test/route", ["/test"]], ], [[null, "/test"]], ], [ "/test/", { end: false, strict: true, }, ["/test/"], [ ["/test", null], ["/test/", ["/test/"]], ["/test//", ["/test/"]], ["/test/route", ["/test/"]], ], [[null, "/test/"]], ], [ "/test.json", { end: false, strict: true, }, ["/test.json"], [ ["/test.json", ["/test.json"]], ["/test.json.hbs", null], ["/test.json/route", ["/test.json"]], ], [[null, "/test.json"]], ], [ "/:test", { end: false, strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route"]], ["/route/", ["/route", "route"]], ], [ [{}, null], [{ test: "abc" }, "/abc"], ], ], [ "/:test/", { end: false, strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route", null], ["/route/", ["/route/", "route"]], ], [[{ test: "foobar" }, "/foobar/"]], ], [ "/test", { start: false, end: false, }, ["/test"], [ ["/test", ["/test"]], ["/test/", ["/test/"]], ["/test/route", ["/test"]], ["/route/test/deep", ["/test"]], ], [[null, "/test"]], ], [ "/test/", { start: false, end: false, }, ["/test/"], [ ["/test", null], ["/test/", ["/test/"]], ["/test//", ["/test//"]], ["/test/route", ["/test/"]], ["/route/test/deep", ["/test/"]], ], [[null, "/test/"]], ], [ "/test.json", { start: false, end: false, }, ["/test.json"], [ ["/test.json", ["/test.json"]], ["/test.json.hbs", null], ["/test.json/route", ["/test.json"]], ["/route/test.json/deep", ["/test.json"]], ], [[null, "/test.json"]], ], [ "/:test", { start: false, end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route"]], ["/route/", ["/route/", "route"]], ], [ [{}, null], [{ test: "abc" }, "/abc"], ], ], [ "/:test/", { end: false, strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route", null], ["/route/", ["/route/", "route"]], ], [[{ test: "foobar" }, "/foobar/"]], ],
/** * Arrays of simple paths. */ [ ["/one", "/two"], undefined, [], [ ["/one", ["/one"]], ["/two", ["/two"]], ["/three", null], ["/one/two", null], ], [], ],
/** * Non-ending simple path. */ [ "/test", { end: false, }, ["/test"], [["/test/route", ["/test"]]], [[null, "/test"]], ],
/** * Single named parameter. */ [ "/:test", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route"]], ["/another", ["/another", "another"]], ["/something/else", null], ["/route.json", ["/route.json", "route.json"]], ["/something%2Felse", ["/something%2Felse", "something%2Felse"]], [ "/something%2Felse%2Fmore", ["/something%2Felse%2Fmore", "something%2Felse%2Fmore"], ], ["/;,:@&=+$-_.!~*()", ["/;,:@&=+$-_.!~*()", ";,:@&=+$-_.!~*()"]], ], [ [{ test: "route" }, "/route"], [ { test: "something/else" }, "/something%2Felse", { encode: encodeURIComponent }, ], [ { test: "something/else/more" }, "/something%2Felse%2Fmore", { encode: encodeURIComponent }, ], ], ], [ "/:test", { strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route"]], ["/route/", null], ], [[{ test: "route" }, "/route"]], ], [ "/:test/", { strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route/", ["/route/", "route"]], ["/route//", null], ], [[{ test: "route" }, "/route/"]], ], [ "/:test", { end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route.json", ["/route.json", "route.json"]], ["/route//", ["/route", "route"]], ], [[{ test: "route" }, "/route"]], ],
/** * Optional named parameter. */ [ "/:test?", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ], [ [ "/route", ["/route", "route"], { path: "/route", index: 0, params: { test: "route" } }, ], ["/route/nested", null, false], ["/", ["/", undefined], { path: "/", index: 0, params: {} }], ["//", null], ], [ [null, ""], [{ test: "foobar" }, "/foobar"], ], ], [ "/:test?", { strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route"]], ["/", null], // Questionable behaviour. ["//", null], ], [ [null, ""], [{ test: "foobar" }, "/foobar"], ], ], [ "/:test?/", { strict: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "/", ], [ ["/route", null], ["/route/", ["/route/", "route"]], ["/", ["/", undefined]], ["//", null], ], [ [null, "/"], [{ test: "foobar" }, "/foobar/"], ], ], [ "/:test?/bar", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "/bar", ], [ ["/bar", ["/bar", undefined]], ["/foo/bar", ["/foo/bar", "foo"]], ], [ [null, "/bar"], [{ test: "foo" }, "/foo/bar"], ], ], [ "/:test?-bar", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "-bar", ], [ ["-bar", ["-bar", undefined]], ["/-bar", null], ["/foo-bar", ["/foo-bar", "foo"]], ], [ [undefined, "-bar"], [{ test: "foo" }, "/foo-bar"], ], ], [ "/:test*-bar", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "*", pattern: "[^\\/#\\?]+?", }, "-bar", ], [ ["-bar", ["-bar", undefined]], ["/-bar", null], ["/foo-bar", ["/foo-bar", "foo"]], ["/foo/baz-bar", ["/foo/baz-bar", "foo/baz"]], ], [[{ test: "foo" }, "/foo-bar"]], ],
/** * Repeated one or more times parameters. */ [ "/:test+", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "+", pattern: "[^\\/#\\?]+?", }, ], [ ["/", null, false], [ "/route", ["/route", "route"], { path: "/route", index: 0, params: { test: ["route"] } }, ], [ "/some/basic/route", ["/some/basic/route", "some/basic/route"], { path: "/some/basic/route", index: 0, params: { test: ["some", "basic", "route"] }, }, ], ["//", null, false], ], [ [{}, null], [{ test: "foobar" }, "/foobar"], [{ test: ["a", "b", "c"] }, "/a/b/c"], ], ], [ "/:test(\\d+)+", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "+", pattern: "\\d+", }, ], [ ["/abc/456/789", null], ["/123/456/789", ["/123/456/789", "123/456/789"]], ], [ [{ test: "abc" }, null], [{ test: 123 }, "/123"], [{ test: [1, 2, 3] }, "/1/2/3"], ], ], [ "/route.:ext(json|xml)+", undefined, [ "/route", { name: "ext", prefix: ".", suffix: "", modifier: "+", pattern: "json|xml", }, ], [ ["/route", null], ["/route.json", ["/route.json", "json"]], ["/route.xml.json", ["/route.xml.json", "xml.json"]], ["/route.html", null], ], [ [{ ext: "foobar" }, null], [{ ext: "xml" }, "/route.xml"], [{ ext: ["xml", "json"] }, "/route.xml.json"], ], ], [ "/route.:ext(\\w+)/test", undefined, [ "/route", { name: "ext", prefix: ".", suffix: "", modifier: "", pattern: "\\w+", }, "/test", ], [ ["/route", null], ["/route.json", null], ["/route.xml/test", ["/route.xml/test", "xml"]], ["/route.json.gz/test", null], ], [[{ ext: "xml" }, "/route.xml/test"]], ],
/** * Repeated zero or more times parameters. */ [ "/:test*", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "*", pattern: "[^\\/#\\?]+?", }, ], [ ["/", ["/", undefined], { path: "/", index: 0, params: {} }], ["//", null, false], [ "/route", ["/route", "route"], { path: "/route", index: 0, params: { test: ["route"] } }, ], [ "/some/basic/route", ["/some/basic/route", "some/basic/route"], { path: "/some/basic/route", index: 0, params: { test: ["some", "basic", "route"] }, }, ], ], [ [{}, ""], [{ test: [] }, ""], [{ test: "foobar" }, "/foobar"], [{ test: ["foo", "bar"] }, "/foo/bar"], ], ], [ "/route.:ext([a-z]+)*", undefined, [ "/route", { name: "ext", prefix: ".", suffix: "", modifier: "*", pattern: "[a-z]+", }, ], [ ["/route", ["/route", undefined]], ["/route.json", ["/route.json", "json"]], ["/route.json.xml", ["/route.json.xml", "json.xml"]], ["/route.123", null], ], [ [{}, "/route"], [{ ext: [] }, "/route"], [{ ext: "123" }, null], [{ ext: "foobar" }, "/route.foobar"], [{ ext: ["foo", "bar"] }, "/route.foo.bar"], ], ],
/** * Custom named parameters. */ [ "/:test(\\d+)", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "\\d+", }, ], [ ["/123", ["/123", "123"]], ["/abc", null], ["/123/abc", null], ], [ [{ test: "abc" }, null], [{ test: "abc" }, "/abc", { validate: false }], [{ test: "123" }, "/123"], ], ], [ "/:test(\\d+)", { end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "\\d+", }, ], [ ["/123", ["/123", "123"]], ["/abc", null], ["/123/abc", ["/123", "123"]], ], [[{ test: "123" }, "/123"]], ], [ "/:test(.*)", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: ".*", }, ], [ ["/anything/goes/here", ["/anything/goes/here", "anything/goes/here"]], ["/;,:@&=/+$-_.!/~*()", ["/;,:@&=/+$-_.!/~*()", ";,:@&=/+$-_.!/~*()"]], ], [ [{ test: "" }, "/"], [{ test: "abc" }, "/abc"], [{ test: "abc/123" }, "/abc%2F123", { encode: encodeURIComponent }], [ { test: "abc/123/456" }, "/abc%2F123%2F456", { encode: encodeURIComponent }, ], ], ], [ "/:route([a-z]+)", undefined, [ { name: "route", prefix: "/", suffix: "", modifier: "", pattern: "[a-z]+", }, ], [ ["/abcde", ["/abcde", "abcde"]], ["/12345", null], ], [ [{ route: "" }, null], [{ route: "" }, "/", { validate: false }], [{ route: "123" }, null], [{ route: "123" }, "/123", { validate: false }], [{ route: "abc" }, "/abc"], ], ], [ "/:route(this|that)", undefined, [ { name: "route", prefix: "/", suffix: "", modifier: "", pattern: "this|that", }, ], [ ["/this", ["/this", "this"]], ["/that", ["/that", "that"]], ["/foo", null], ], [ [{ route: "this" }, "/this"], [{ route: "foo" }, null], [{ route: "foo" }, "/foo", { validate: false }], [{ route: "that" }, "/that"], ], ], [ "/:path(abc|xyz)*", undefined, [ { name: "path", prefix: "/", suffix: "", modifier: "*", pattern: "abc|xyz", }, ], [ ["/abc", ["/abc", "abc"]], ["/abc/abc", ["/abc/abc", "abc/abc"]], ["/xyz/xyz", ["/xyz/xyz", "xyz/xyz"]], ["/abc/xyz", ["/abc/xyz", "abc/xyz"]], ["/abc/xyz/abc/xyz", ["/abc/xyz/abc/xyz", "abc/xyz/abc/xyz"]], ["/xyzxyz", null], ], [ [{ path: "abc" }, "/abc"], [{ path: ["abc", "xyz"] }, "/abc/xyz"], [{ path: ["xyz", "abc", "xyz"] }, "/xyz/abc/xyz"], [{ path: "abc123" }, null], [{ path: "abc123" }, "/abc123", { validate: false }], [{ path: "abcxyz" }, null], [{ path: "abcxyz" }, "/abcxyz", { validate: false }], ], ],
/** * Prefixed slashes could be omitted. */ [ "test", undefined, ["test"], [ ["test", ["test"]], ["/test", null], ], [[null, "test"]], ], [ ":test", undefined, [ { name: "test", prefix: "", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["route", ["route", "route"]], ["/route", null], ["route/", ["route/", "route"]], ], [ [{ test: "" }, null], [{}, null], [{ test: null }, null], [{ test: "route" }, "route"], ], ], [ ":test", { strict: true, }, [ { name: "test", prefix: "", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["route", ["route", "route"]], ["/route", null], ["route/", null], ], [[{ test: "route" }, "route"]], ], [ ":test", { end: false, }, [ { name: "test", prefix: "", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["route", ["route", "route"]], ["/route", null], ["route/", ["route/", "route"]], ["route/foobar", ["route", "route"]], ], [[{ test: "route" }, "route"]], ], [ ":test?", undefined, [ { name: "test", prefix: "", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ], [ ["route", ["route", "route"]], ["/route", null], ["", ["", undefined]], ["route/foobar", null], ], [ [{}, ""], [{ test: "" }, null], [{ test: "route" }, "route"], ], ], [ "{:test/}+", undefined, [ { name: "test", prefix: "", suffix: "/", modifier: "+", pattern: "[^\\/#\\?]+?", }, ], [ ["route/", ["route/", "route"]], ["/route", null], ["", null], ["foo/bar/", ["foo/bar/", "foo/bar"]], ], [ [{}, null], [{ test: "" }, null], [{ test: ["route"] }, "route/"], [{ test: ["foo", "bar"] }, "foo/bar/"], ], ],
/** * Formats. */ [ "/test.json", undefined, ["/test.json"], [ ["/test.json", ["/test.json"]], ["/route.json", null], ], [[{}, "/test.json"]], ], [ "/:test.json", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ".json", ], [ ["/.json", null], ["/test.json", ["/test.json", "test"]], ["/route.json", ["/route.json", "route"]], ["/route.json.json", ["/route.json.json", "route.json"]], ], [ [{ test: "" }, null], [{ test: "foo" }, "/foo.json"], ], ],
/** * Format params. */ [ "/test.:format(\\w+)", undefined, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "\\w+", }, ], [ ["/test.html", ["/test.html", "html"]], ["/test.hbs.html", null], ], [ [{}, null], [{ format: "" }, null], [{ format: "foo" }, "/test.foo"], ], ], [ "/test.:format(\\w+).:format(\\w+)", undefined, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "\\w+", }, { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "\\w+", }, ], [ ["/test.html", null], ["/test.hbs.html", ["/test.hbs.html", "hbs", "html"]], ], [ [{ format: "foo.bar" }, null], [{ format: "foo" }, "/test.foo.foo"], ], ], [ "/test{.:format}+", undefined, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "+", pattern: "[^\\/#\\?]+?", }, ], [ ["/test.html", ["/test.html", "html"]], ["/test.hbs.html", ["/test.hbs.html", "hbs.html"]], ], [ [{ format: [] }, null], [{ format: "foo" }, "/test.foo"], [{ format: ["foo", "bar"] }, "/test.foo.bar"], ], ], [ "/test.:format(\\w+)", { end: false, }, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "\\w+", }, ], [ ["/test.html", ["/test.html", "html"]], ["/test.hbs.html", null], ], [[{ format: "foo" }, "/test.foo"]], ], [ "/test.:format.", undefined, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ".", ], [ ["/test.html.", ["/test.html.", "html"]], ["/test.hbs.html", null], ], [ [{ format: "" }, null], [{ format: "foo" }, "/test.foo."], ], ],
/** * Format and path params. */ [ "/:test.:format", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "format", prefix: ".", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/route.html", ["/route.html", "route", "html"]], ["/route", null], ["/route.html.json", ["/route.html.json", "route", "html.json"]], ], [ [{}, null], [{ test: "route", format: "foo" }, "/route.foo"], ], ], [ "/:test{.:format}?", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "format", prefix: ".", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route", undefined]], ["/route.json", ["/route.json", "route", "json"]], ["/route.json.html", ["/route.json.html", "route", "json.html"]], ], [ [{ test: "route" }, "/route"], [{ test: "route", format: "" }, null], [{ test: "route", format: "foo" }, "/route.foo"], ], ], [ "/:test.:format?", { end: false, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "format", prefix: ".", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ], [ ["/route", ["/route", "route", undefined]], ["/route.json", ["/route.json", "route", "json"]], ["/route.json.html", ["/route.json.html", "route", "json.html"]], ], [ [{ test: "route" }, "/route"], [{ test: "route", format: undefined }, "/route"], [{ test: "route", format: "" }, null], [{ test: "route", format: "foo" }, "/route.foo"], ], ], [ "/test.:format(.*)z", { end: false, }, [ "/test", { name: "format", prefix: ".", suffix: "", modifier: "", pattern: ".*", }, "z", ], [ ["/test.abc", null], ["/test.z", ["/test.z", ""]], ["/test.abcz", ["/test.abcz", "abc"]], ], [ [{}, null], [{ format: "" }, "/test.z"], [{ format: "foo" }, "/test.fooz"], ], ],
/** * Unnamed params. */ [ "/(\\d+)", undefined, [ { name: 0, prefix: "/", suffix: "", modifier: "", pattern: "\\d+", }, ], [ ["/123", ["/123", "123"]], ["/abc", null], ["/123/abc", null], ], [ [{}, null], [{ "0": "123" }, "/123"], ], ], [ "/(\\d+)", { end: false, }, [ { name: 0, prefix: "/", suffix: "", modifier: "", pattern: "\\d+", }, ], [ ["/123", ["/123", "123"]], ["/abc", null], ["/123/abc", ["/123", "123"]], ["/123/", ["/123/", "123"]], ], [[{ "0": "123" }, "/123"]], ], [ "/(\\d+)?", undefined, [ { name: 0, prefix: "/", suffix: "", modifier: "?", pattern: "\\d+", }, ], [ ["/", ["/", undefined]], ["/123", ["/123", "123"]], ], [ [{}, ""], [{ "0": "123" }, "/123"], ], ], [ "/(.*)", undefined, [ { name: 0, prefix: "/", suffix: "", modifier: "", pattern: ".*", }, ], [ ["/", ["/", ""]], ["/route", ["/route", "route"]], ["/route/nested", ["/route/nested", "route/nested"]], ], [ [{ "0": "" }, "/"], [{ "0": "123" }, "/123"], ], ], [ "/route\\(\\\\(\\d+\\\\)\\)", undefined, [ "/route(\\", { name: 0, prefix: "", suffix: "", modifier: "", pattern: "\\d+\\\\", }, ")", ], [["/route(\\123\\)", ["/route(\\123\\)", "123\\"]]], [], ], [ "{/login}?", undefined, [ { name: "", prefix: "/login", suffix: "", modifier: "?", pattern: "", }, ], [ ["/", ["/"]], ["/login", ["/login"]], ], [ [null, ""], [{ "": "" }, "/login"], ], ], [ "{/login}", undefined, [ { name: "", prefix: "/login", suffix: "", modifier: "", pattern: "", }, ], [ ["/", null], ["/login", ["/login"]], ], [[{ "": "" }, "/login"]], ], [ "{/(.*)}", undefined, [ { name: 0, prefix: "/", suffix: "", modifier: "", pattern: ".*", }, ], [ ["/", ["/", ""]], ["/login", ["/login", "login"]], ], [[{ 0: "test" }, "/test"]], ],
/** * Regexps. */ [/.*/, undefined, [], [["/match/anything", ["/match/anything"]]], []], [ /(.*)/, undefined, [ { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [["/match/anything", ["/match/anything", "/match/anything"]]], [], ], [ /\/(\d+)/, undefined, [ { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/abc", null], ["/123", ["/123", "123"]], ], [], ],
/** * Mixed arrays. */ [ ["/test", /\/(\d+)/], undefined, [ { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [["/test", ["/test", undefined]]], [], ], [ ["/:test(\\d+)", /(.*)/], undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "\\d+", }, { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/123", ["/123", "123", undefined]], ["/abc", ["/abc", undefined, "/abc"]], ], [], ],
/** * Correct names and indexes. */ [ ["/:test", "/route/:test"], undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/test", ["/test", "test", undefined]], ["/route/test", ["/route/test", undefined, "test"]], ], [], ], [ [/^\/([^/]+)$/, /^\/route\/([^/]+)$/], undefined, [ { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/test", ["/test", "test", undefined]], ["/route/test", ["/route/test", undefined, "test"]], ], [], ],
/** * Ignore non-matching groups in regexps. */ [ /(?:.*)/, undefined, [], [["/anything/you/want", ["/anything/you/want"]]], [], ],
/** * Respect escaped characters. */ [ "/\\(testing\\)", undefined, ["/(testing)"], [ ["/testing", null], ["/(testing)", ["/(testing)"]], ], [[null, "/(testing)"]], ], [ "/.\\+\\*\\?\\{\\}=^!\\:$[]|", undefined, ["/.+*?{}=^!:$[]|"], [["/.+*?{}=^!:$[]|", ["/.+*?{}=^!:$[]|"]]], [[null, "/.+*?{}=^!:$[]|"]], ], [ "/test\\/:uid(u\\d+)?:cid(c\\d+)?", undefined, [ "/test/", { name: "uid", prefix: "", suffix: "", modifier: "?", pattern: "u\\d+", }, { name: "cid", prefix: "", suffix: "", modifier: "?", pattern: "c\\d+", }, ], [ ["/test", null], ["/test/", ["/test/", undefined, undefined]], ["/test/u123", ["/test/u123", "u123", undefined]], ["/test/c123", ["/test/c123", undefined, "c123"]], ], [ [{ uid: "u123" }, "/test/u123"], [{ cid: "c123" }, "/test/c123"], [{ cid: "u123" }, null], ], ],
/** * Unnamed group prefix. */ [ "/{apple-}?icon-:res(\\d+).png", undefined, [ "/", { name: "", prefix: "apple-", suffix: "", modifier: "?", pattern: "", }, "icon-", { name: "res", prefix: "", suffix: "", modifier: "", pattern: "\\d+", }, ".png", ], [ ["/icon-240.png", ["/icon-240.png", "240"]], ["/apple-icon-240.png", ["/apple-icon-240.png", "240"]], ], [], ],
/** * Random examples. */ [ "/:foo/:bar", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "bar", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [["/match/route", ["/match/route", "match", "route"]]], [[{ foo: "a", bar: "b" }, "/a/b"]], ], [ "/:foo\\(test\\)/bar", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "(test)/bar", ], [], [], ], [ "/:remote([\\w-.]+)/:user([\\w-]+)", undefined, [ { name: "remote", prefix: "/", suffix: "", modifier: "", pattern: "[\\w-.]+", }, { name: "user", prefix: "/", suffix: "", modifier: "", pattern: "[\\w-]+", }, ], [ ["/endpoint/user", ["/endpoint/user", "endpoint", "user"]], ["/endpoint/user-name", ["/endpoint/user-name", "endpoint", "user-name"]], ["/foo.bar/user-name", ["/foo.bar/user-name", "foo.bar", "user-name"]], ], [ [{ remote: "foo", user: "bar" }, "/foo/bar"], [{ remote: "foo.bar", user: "uno" }, "/foo.bar/uno"], ], ], [ "/:foo\\?", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "?", ], [["/route?", ["/route?", "route"]]], [[{ foo: "bar" }, "/bar?"]], ], [ "/:foo+baz", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "+", pattern: "[^\\/#\\?]+?", }, "baz", ], [ ["/foobaz", ["/foobaz", "foo"]], ["/foo/barbaz", ["/foo/barbaz", "foo/bar"]], ["/baz", null], ], [ [{ foo: "foo" }, "/foobaz"], [{ foo: "foo/bar" }, "/foo%2Fbarbaz", { encode: encodeURIComponent }], [{ foo: ["foo", "bar"] }, "/foo/barbaz"], ], ], [ "\\/:pre?baz", undefined, [ "/", { name: "pre", prefix: "", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "baz", ], [ ["/foobaz", ["/foobaz", "foo"]], ["/baz", ["/baz", undefined]], ], [ [{}, "/baz"], [{ pre: "foo" }, "/foobaz"], ], ], [ "/:foo\\(:bar?\\)", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "(", { name: "bar", prefix: "", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, ")", ], [ ["/hello(world)", ["/hello(world)", "hello", "world"]], ["/hello()", ["/hello()", "hello", undefined]], ], [ [{ foo: "hello", bar: "world" }, "/hello(world)"], [{ foo: "hello" }, "/hello()"], ], ], [ "/:postType(video|audio|text)(\\+.+)?", undefined, [ { name: "postType", prefix: "/", suffix: "", modifier: "", pattern: "video|audio|text", }, { name: 0, prefix: "", suffix: "", modifier: "?", pattern: "\\+.+", }, ], [ ["/video", ["/video", "video", undefined]], ["/video+test", ["/video+test", "video", "+test"]], ["/video+", null], ], [ [{ postType: "video" }, "/video"], [{ postType: "random" }, null], ], ], [ "/:foo?/:bar?-ext", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, { name: "bar", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "-ext", ], [ ["/-ext", null], ["-ext", ["-ext", undefined, undefined]], ["/foo-ext", ["/foo-ext", "foo", undefined]], ["/foo/bar-ext", ["/foo/bar-ext", "foo", "bar"]], ["/foo/-ext", null], ], [ [{}, "-ext"], [{ foo: "foo" }, "/foo-ext"], [{ bar: "bar" }, "/bar-ext"], [{ foo: "foo", bar: "bar" }, "/foo/bar-ext"], ], ], [ "/:required/:optional?-ext", undefined, [ { name: "required", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, { name: "optional", prefix: "/", suffix: "", modifier: "?", pattern: "[^\\/#\\?]+?", }, "-ext", ], [ ["/foo-ext", ["/foo-ext", "foo", undefined]], ["/foo/bar-ext", ["/foo/bar-ext", "foo", "bar"]], ["/foo/-ext", null], ], [[{ required: "foo" }, "/foo-ext"]], ],
/** * Unicode characters. */ [ "/:foo", undefined, [ { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [["/café", ["/café", "café"]]], [ [{ foo: "café" }, "/café"], [{ foo: "café" }, "/caf%C3%A9", { encode: encodeURIComponent }], ], ], ["/café", undefined, ["/café"], [["/café", ["/café"]]], [[null, "/café"]]], [ "/café", { encode: encodeURI }, ["/café"], [["/caf%C3%A9", ["/caf%C3%A9"]]], [[null, "/café"]], ], [ "packages/", undefined, ["packages/"], [ ["packages", null], ["packages/", ["packages/"]], ], [[null, "packages/"]], ],
/** * Hostnames. */ [ ":domain.com", { delimiter: ".", }, [ { name: "domain", prefix: "", suffix: "", modifier: "", pattern: "[^\\.]+?", }, ".com", ], [ ["example.com", ["example.com", "example"]], ["github.com", ["github.com", "github"]], ], [ [{ domain: "example" }, "example.com"], [{ domain: "github" }, "github.com"], ], ], [ "mail.:domain.com", { delimiter: ".", }, [ "mail", { name: "domain", prefix: ".", suffix: "", modifier: "", pattern: "[^\\.]+?", }, ".com", ], [ ["mail.example.com", ["mail.example.com", "example"]], ["mail.github.com", ["mail.github.com", "github"]], ], [ [{ domain: "example" }, "mail.example.com"], [{ domain: "github" }, "mail.github.com"], ], ], [ "example.:ext", {}, [ "example", { name: "ext", prefix: ".", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["example.com", ["example.com", "com"]], ["example.org", ["example.org", "org"]], ], [ [{ ext: "com" }, "example.com"], [{ ext: "org" }, "example.org"], ], ], [ "this is", { delimiter: " ", end: false, }, ["this is"], [ ["this is a test", ["this is"]], ["this isn't", null], ], [[null, "this is"]], ],
/** * Ends with. */ [ "/test", { endsWith: "?", }, ["/test"], [ ["/test", ["/test"]], ["/test?query=string", ["/test"]], ["/test/?query=string", ["/test/"]], ["/testx", null], ], [[null, "/test"]], ], [ "/test", { endsWith: "?", strict: true, }, ["/test"], [ ["/test?query=string", ["/test"]], ["/test/?query=string", null], ], [[null, "/test"]], ],
/** * Custom prefixes. */ [ "{$:foo}{$:bar}?", {}, [ { name: "foo", pattern: "[^\\/#\\?]+?", prefix: "$", suffix: "", modifier: "", }, { name: "bar", pattern: "[^\\/#\\?]+?", prefix: "$", suffix: "", modifier: "?", }, ], [ ["$x", ["$x", "x", undefined]], ["$x$y", ["$x$y", "x", "y"]], ], [ [{ foo: "foo" }, "$foo"], [{ foo: "foo", bar: "bar" }, "$foo$bar"], ], ], [ "name/:attr1?{-:attr2}?{-:attr3}?", {}, [ "name", { name: "attr1", pattern: "[^\\/#\\?]+?", prefix: "/", suffix: "", modifier: "?", }, { name: "attr2", pattern: "[^\\/#\\?]+?", prefix: "-", suffix: "", modifier: "?", }, { name: "attr3", pattern: "[^\\/#\\?]+?", prefix: "-", suffix: "", modifier: "?", }, ], [ ["name/test", ["name/test", "test", undefined, undefined]], ["name/1", ["name/1", "1", undefined, undefined]], ["name/1-2", ["name/1-2", "1", "2", undefined]], ["name/1-2-3", ["name/1-2-3", "1", "2", "3"]], ["name/foo-bar/route", null], ["name/test/route", null], ], [ [{}, "name"], [{ attr1: "test" }, "name/test"], [{ attr2: "attr" }, "name-attr"], ], ],
/** * Case-sensitive compile tokensToFunction params. */ [ "/:test(abc)", { sensitive: true, }, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "abc", }, ], [ ["/abc", ["/abc", "abc"]], ["/ABC", null], ], [ [{ test: "abc" }, "/abc"], [{ test: "ABC" }, null], ], ], [ "/:test(abc)", {}, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "abc", }, ], [ ["/abc", ["/abc", "abc"]], ["/ABC", ["/ABC", "ABC"]], ], [ [{ test: "abc" }, "/abc"], [{ test: "ABC" }, "/ABC"], ], ],
/** * Nested parentheses. */ [ "/:test(\\d+(?:\\.\\d+)?)", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "\\d+(?:\\.\\d+)?", }, ], [ ["/123", ["/123", "123"]], ["/abc", null], ["/123/abc", null], ["/123.123", ["/123.123", "123.123"]], ["/123.abc", null], ], [ [{ test: 123 }, "/123"], [{ test: 123.123 }, "/123.123"], [{ test: "abc" }, null], [{ test: "123" }, "/123"], [{ test: "123.123" }, "/123.123"], [{ test: "123.abc" }, null], ], ], [ "/:test((?!login)[^/]+)", undefined, [ { name: "test", prefix: "/", suffix: "", modifier: "", pattern: "(?!login)[^/]+", }, ], [ ["/route", ["/route", "route"]], ["/login", null], ], [ [{ test: "route" }, "/route"], [{ test: "login" }, null], ], ],
/** * https://github.com/pillarjs/path-to-regexp/issues/206 */ [ "/user(s)?/:user", undefined, [ "/user", { name: 0, prefix: "", suffix: "", modifier: "?", pattern: "s", }, { name: "user", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/user/123", ["/user/123", undefined, "123"]], ["/users/123", ["/users/123", "s", "123"]], ], [[{ user: "123" }, "/user/123"]], ],
/** * https://github.com/pillarjs/path-to-regexp/issues/209 */ [ "/whatever/:foo\\?query=str", undefined, [ "/whatever", { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, "?query=str", ], [["/whatever/123?query=str", ["/whatever/123?query=str", "123"]]], [[{ foo: "123" }, "/whatever/123?query=str"]], ], [ "/whatever/:foo", { end: false, }, [ "/whatever", { name: "foo", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", }, ], [ ["/whatever/123", ["/whatever/123", "123"]], ["/whatever/123/path", ["/whatever/123", "123"]], ["/whatever/123#fragment", ["/whatever/123", "123"]], ["/whatever/123?query=str", ["/whatever/123", "123"]], ], [ [{ foo: "123" }, "/whatever/123"], [{ foo: "#" }, null], ], ], /** * https://github.com/pillarjs/path-to-regexp/issues/260 */ [ ":name*", undefined, [ { name: "name", prefix: "", suffix: "", modifier: "*", pattern: "[^\\/#\\?]+?", }, ], [["foobar", ["foobar", "foobar"]]], [[{ name: "foobar" }, "foobar"]], ], [ ":name+", undefined, [ { name: "name", prefix: "", suffix: "", modifier: "+", pattern: "[^\\/#\\?]+?", }, ], [["foobar", ["foobar", "foobar"]]], [[{ name: "foobar" }, "foobar"]], ],];
/** * Named capturing groups (available from 1812 version 10) */if (semver.gte(process.version, "10.0.0")) { TESTS.push( [ /\/(?<groupname>.+)/, undefined, [ { name: "groupname", prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/", null], ["/foo", ["/foo", "foo"]], ], [], ], [ /\/(?<test>.*).(?<format>html|json)/, undefined, [ { name: "test", prefix: "", suffix: "", modifier: "", pattern: "", }, { name: "format", prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/route", null], ["/route.txt", null], ["/route.html", ["/route.html", "route", "html"]], ["/route.json", ["/route.json", "route", "json"]], ], [], ], [ /\/(.+)\/(?<groupname>.+)\/(.+)/, undefined, [ { name: 0, prefix: "", suffix: "", modifier: "", pattern: "", }, { name: "groupname", prefix: "", suffix: "", modifier: "", pattern: "", }, { name: 1, prefix: "", suffix: "", modifier: "", pattern: "", }, ], [ ["/test", null], ["/test/testData", null], [ "/test/testData/extraStuff", ["/test/testData/extraStuff", "test", "testData", "extraStuff"], ], ], [], ] );}
/** * Dynamically generate the entire test suite. */describe("path-to-regexp", function () { const TEST_PATH = "/user/:id";
const TEST_PARAM = { name: "id", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", };
describe("arguments", function () { it("should work without different call combinations", function () { pathToRegexp.pathToRegexp("/test"); pathToRegexp.pathToRegexp("/test", []); pathToRegexp.pathToRegexp("/test", undefined, {});
pathToRegexp.pathToRegexp(/^\/test/); pathToRegexp.pathToRegexp(/^\/test/, []); pathToRegexp.pathToRegexp(/^\/test/, undefined, {});
pathToRegexp.pathToRegexp(["/a", "/b"]); pathToRegexp.pathToRegexp(["/a", "/b"], []); pathToRegexp.pathToRegexp(["/a", "/b"], undefined, {}); });
it("should accept an array of keys as the second argument", function () { const keys: pathToRegexp.Key[] = []; const re = pathToRegexp.pathToRegexp(TEST_PATH, keys, { end: false });
expect(keys).toEqual([TEST_PARAM]); expect(exec(re, "/user/123/show")).toEqual(["/user/123", "123"]); });
it("should throw on non-capturing pattern", function () { expect(function () { pathToRegexp.pathToRegexp("/:foo(?:\\d+(\\.\\d+)?)"); }).toThrow(new TypeError('Pattern cannot start with "?" at 6')); });
it("should throw on nested capturing group", function () { expect(function () { pathToRegexp.pathToRegexp("/:foo(\\d+(\\.\\d+)?)"); }).toThrow(new TypeError("Capturing groups are not allowed at 9")); });
it("should throw on unbalanced pattern", function () { expect(function () { pathToRegexp.pathToRegexp("/:foo(abc"); }).toThrow(new TypeError("Unbalanced pattern at 5")); });
it("should throw on missing pattern", function () { expect(function () { pathToRegexp.pathToRegexp("/:foo()"); }).toThrow(new TypeError("Missing pattern at 5")); });
it("should throw on missing name", function () { expect(function () { pathToRegexp.pathToRegexp("/:(test)"); }).toThrow(new TypeError("Missing parameter name at 1")); });
it("should throw on nested groups", function () { expect(function () { pathToRegexp.pathToRegexp("/{a{b:foo}}"); }).toThrow(new TypeError("Unexpected OPEN at 3, expected CLOSE")); });
it("should throw on misplaced modifier", function () { expect(function () { pathToRegexp.pathToRegexp("/foo?"); }).toThrow(new TypeError("Unexpected MODIFIER at 4, expected END")); }); });
describe("tokens", function () { const tokens = pathToRegexp.parse(TEST_PATH);
it("should expose method to compile tokens to regexp", function () { const re = pathToRegexp.tokensToRegexp(tokens);
expect(exec(re, "/user/123")).toEqual(["/user/123", "123"]); });
it("should expose method to compile tokens to a path function", function () { const fn = pathToRegexp.tokensToFunction(tokens);
expect(fn({ id: 123 })).toEqual("/user/123"); }); });
describe("rules", function () { TESTS.forEach(function (test) { const [path, opts, tokens, matchCases, compileCases] = test;
describe(util.inspect(path), function () { const keys: pathToRegexp.Key[] = []; const re = pathToRegexp.pathToRegexp(path, keys, opts);
// Parsing and compiling is only supported with string input. if (typeof path === "string") { it("should parse", function () { expect(pathToRegexp.parse(path, opts)).toEqual(tokens); });
describe("compile", function () { compileCases.forEach(function (io) { const [params, result, options] = io; const toPath = pathToRegexp.compile(path, { ...opts, ...options, });
if (result !== null) { it("should compile using " + util.inspect(params), function () { expect(toPath(params)).toEqual(result); }); } else { it( "should not compile using " + util.inspect(params), function () { expect(function () { toPath(params); }).toThrow(TypeError); } ); } }); }); } else { it("should parse keys", function () { expect(keys).toEqual( tokens.filter(function (token) { return typeof token !== "string"; }) ); }); }
describe( "match" + (opts ? " using " + util.inspect(opts) : ""), function () { matchCases.forEach(function (io) { const [pathname, matches, params, options] = io; const message = `should ${ matches ? "" : "not " }match ${util.inspect(pathname)}`;
it(message, function () { expect(exec(re, pathname)).toEqual(matches); });
if (typeof path === "string" && params !== undefined) { const match = pathToRegexp.match(path, options);
it(message + " params", function () { expect(match(pathname)).toEqual(params); }); } }); } ); }); }); });
describe("compile errors", function () { it("should throw when a required param is undefined", function () { const toPath = pathToRegexp.compile("/a/:b/c");
expect(function () { toPath(); }).toThrow(new TypeError('Expected "b" to be a string')); });
it("should throw when it does not match the pattern", function () { const toPath = pathToRegexp.compile("/:foo(\\d+)");
expect(function () { toPath({ foo: "abc" }); }).toThrow( new TypeError('Expected "foo" to match "\\d+", but got "abc"') ); });
it("should throw when expecting a repeated value", function () { const toPath = pathToRegexp.compile("/:foo+");
expect(function () { toPath({ foo: [] }); }).toThrow(new TypeError('Expected "foo" to not be empty')); });
it("should throw when not expecting a repeated value", function () { const toPath = pathToRegexp.compile("/:foo");
expect(function () { toPath({ foo: [] }); }).toThrow( new TypeError('Expected "foo" to not repeat, but got an array') ); });
it("should throw when repeated value does not match", function () { const toPath = pathToRegexp.compile("/:foo(\\d+)+");
expect(function () { toPath({ foo: [1, 2, 3, "a"] }); }).toThrow( new TypeError('Expected all "foo" to match "\\d+", but got "a"') ); }); });});
/** * Execute a regular expression and return a flat array for comparison. * * @param {RegExp} re * @param {String} str * @return {Array} */function exec(re: RegExp, str: string) { const match = re.exec(str);
return match && Array.prototype.slice.call(match);}