Module
x/path_to_regexp/index.spec.ts
Turn a path string such as `/user/:name` into a regular expression
Very Popular
Latest
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944import { describe, it, expect } from "vitest";import * 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\\"]]], [[["123\\"], "/route(\\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"]], ], [[{ res: "240" }, "/icon-240.png"]], ],
/** * 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", ], [ ["/foo(test)/bar", ["/foo(test)/bar", "foo"]], ["/another/bar", null], ], [[{ foo: "foo" }, "/foo(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", () => { const TEST_PATH = "/user/:id";
const TEST_PARAM = { name: "id", prefix: "/", suffix: "", modifier: "", pattern: "[^\\/#\\?]+?", };
describe("arguments", () => { it("should work without different call combinations", () => { 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", () => { 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", () => { expect(() => { pathToRegexp.pathToRegexp("/:foo(?:\\d+(\\.\\d+)?)"); }).toThrow(new TypeError('Pattern cannot start with "?" at 6')); });
it("should throw on nested capturing group", () => { expect(() => { pathToRegexp.pathToRegexp("/:foo(\\d+(\\.\\d+)?)"); }).toThrow(new TypeError("Capturing groups are not allowed at 9")); });
it("should throw on unbalanced pattern", () => { expect(() => { pathToRegexp.pathToRegexp("/:foo(abc"); }).toThrow(new TypeError("Unbalanced pattern at 5")); });
it("should throw on missing pattern", () => { expect(() => { pathToRegexp.pathToRegexp("/:foo()"); }).toThrow(new TypeError("Missing pattern at 5")); });
it("should throw on missing name", () => { expect(() => { pathToRegexp.pathToRegexp("/:(test)"); }).toThrow(new TypeError("Missing parameter name at 1")); });
it("should throw on nested groups", () => { expect(() => { pathToRegexp.pathToRegexp("/{a{b:foo}}"); }).toThrow(new TypeError("Unexpected OPEN at 3, expected CLOSE")); });
it("should throw on misplaced modifier", () => { expect(() => { pathToRegexp.pathToRegexp("/foo?"); }).toThrow(new TypeError("Unexpected MODIFIER at 4, expected END")); }); });
describe("tokens", () => { const tokens = pathToRegexp.parse(TEST_PATH);
it("should expose method to compile tokens to regexp", () => { 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", () => { const fn = pathToRegexp.tokensToFunction(tokens);
expect(fn({ id: 123 })).toEqual("/user/123"); }); });
describe("rules", () => { TESTS.forEach(([path, opts, tokens, matchCases, compileCases]) => { describe(util.inspect(path), () => { 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", () => { expect(pathToRegexp.parse(path, opts)).toEqual(tokens); });
describe("compile", () => { compileCases.forEach(([params, result, options]) => { const toPath = pathToRegexp.compile(path, { ...opts, ...options, });
if (result !== null) { it("should compile using " + util.inspect(params), () => { expect(toPath(params)).toEqual(result); }); } else { it("should not compile using " + util.inspect(params), () => { expect(() => { toPath(params); }).toThrow(TypeError); }); } }); }); } else { it("should parse keys", () => { expect(keys).toEqual( tokens.filter((token) => typeof token !== "string"), ); }); }
describe("match" + (opts ? " using " + util.inspect(opts) : ""), () => { matchCases.forEach(([pathname, matches, params, options]) => { const message = `should ${ matches ? "" : "not " }match ${util.inspect(pathname)}`;
it(message, () => { expect(exec(re, pathname)).toEqual(matches); });
if (typeof path === "string" && params !== undefined) { const match = pathToRegexp.match(path, options);
it(message + " params", () => { expect(match(pathname)).toEqual(params); }); } }); }); }); }); });
describe("compile errors", () => { it("should throw when a required param is undefined", () => { const toPath = pathToRegexp.compile("/a/:b/c");
expect(() => { toPath(); }).toThrow(new TypeError('Expected "b" to be a string')); });
it("should throw when it does not match the pattern", () => { const toPath = pathToRegexp.compile("/:foo(\\d+)");
expect(() => { toPath({ foo: "abc" }); }).toThrow( new TypeError('Expected "foo" to match "\\d+", but got "abc"'), ); });
it("should throw when expecting a repeated value", () => { const toPath = pathToRegexp.compile("/:foo+");
expect(() => { toPath({ foo: [] }); }).toThrow(new TypeError('Expected "foo" to not be empty')); });
it("should throw when not expecting a repeated value", () => { const toPath = pathToRegexp.compile("/:foo");
expect(() => { toPath({ foo: [] }); }).toThrow( new TypeError('Expected "foo" to not repeat, but got an array'), ); });
it("should throw when repeated value does not match", () => { const toPath = pathToRegexp.compile("/:foo(\\d+)+");
expect(() => { 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);}