[{"data":1,"prerenderedAt":1201},["ShallowReactive",2],{"page:\u002Fextensions\u002Fkubb-labs\u002Fplugin-msw\u002Foptions":3},{"id":4,"frontmatter":5,"title":6,"heading":6,"body":7,"path":1200,"source":4},"extensions\u002Fkubb-labs\u002Fplugin-msw\u002Foptions.md",{},"Options",{"type":8,"value":9,"toc":1187},"minimark",[10,25,30,249,253,257,263,279,310,312,318,346,383,548,550,552,589,635,896,898,922,951],[11,12,13,14,18,19,24],"p",{},"Pass these options to ",[15,16,17],"code",{},"pluginMsw()",". Shared options link to ",[20,21,23],"a",{"href":22},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options","Shared plugin options",".",[26,27,29],"h2",{"id":28},"options-overview","Options overview",[31,32,33,49],"table",{},[34,35,36],"thead",{},[37,38,39,43,46],"tr",{},[40,41,42],"th",{},"Option",[40,44,45],{},"Purpose",[40,47,48],{},"Default",[50,51,52,87,109,124,146,164,179,197,214,232],"tbody",{},[37,53,54,63,82],{},[55,56,57],"td",{},[20,58,60],{"href":59},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#output",[15,61,62],{},"output",[55,64,65,66,69,70,69,73,69,76,69,79,24],{},"Where files are written: ",[15,67,68],{},"path",", ",[15,71,72],{},"mode",[15,74,75],{},"barrel",[15,77,78],{},"banner",[15,80,81],{},"footer",[55,83,84],{},[15,85,86],{},"{ path: 'handlers', barrel: { type: 'named' } }",[37,88,89,97,106],{},[55,90,91],{},[20,92,94],{"href":93},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#group",[15,95,96],{},"group",[55,98,99,100,69,103,24],{},"Split output by tag or path: ",[15,101,102],{},"type",[15,104,105],{},"name",[55,107,108],{},"None",[37,110,111,119,122],{},[55,112,113],{},[20,114,116],{"href":115},"#baseurl",[15,117,118],{},"baseURL",[55,120,121],{},"Base URL prepended to every handler's request.",[55,123,108],{},[37,125,126,134,141],{},[55,127,128],{},[20,129,131],{"href":130},"#handlers",[15,132,133],{},"handlers",[55,135,136,137,140],{},"Emit a ",[15,138,139],{},"handlers.ts"," that re-exports every handler.",[55,142,143],{},[15,144,145],{},"false",[37,147,148,156,159],{},[55,149,150],{},[20,151,153],{"href":152},"#parser",[15,154,155],{},"parser",[55,157,158],{},"Source of the response body each handler returns.",[55,160,161],{},[15,162,163],{},"'data'",[37,165,166,174,177],{},[55,167,168],{},[20,169,171],{"href":170},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#include",[15,172,173],{},"include",[55,175,176],{},"Keep only operations that match.",[55,178,108],{},[37,180,181,189,192],{},[55,182,183],{},[20,184,186],{"href":185},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#exclude",[15,187,188],{},"exclude",[55,190,191],{},"Skip operations that match.",[55,193,194],{},[15,195,196],{},"[]",[37,198,199,207,210],{},[55,200,201],{},[20,202,204],{"href":203},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#override",[15,205,206],{},"override",[55,208,209],{},"Apply different options per pattern.",[55,211,212],{},[15,213,196],{},[37,215,216,224,227],{},[55,217,218],{},[20,219,221],{"href":220},"#resolver",[15,222,223],{},"resolver",[55,225,226],{},"Customize generated names and file paths.",[55,228,229],{},[15,230,231],{},"resolverMsw",[37,233,234,242,245],{},[55,235,236],{},[20,237,239],{"href":238},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#macros",[15,240,241],{},"macros",[55,243,244],{},"Rewrite AST nodes before printing.",[55,246,247],{},[15,248,196],{},[26,250,252],{"id":251},"option-details","Option details",[254,255,118],"h3",{"id":256},"baseurl",[11,258,259,260,24],{},"Base URL prepended to every handler's request. When omitted, no host is prepended and each handler matches the operation's relative path from the spec. Set it to point at a different environment than the spec. Leave off the trailing slash, because operation paths already start with ",[15,261,262],{},"\u002F",[11,264,265,266,269,270,273,274,24],{},"A value with a template expression, such as ",[15,267,268],{},"'${process.env.API_URL}'",", is evaluated when the handler is created. To set the base URL at runtime instead, pass ",[15,271,272],{},"{ baseURL }"," to a handler or to ",[20,275,276],{"href":130},[15,277,278],{},"createHandlers",[31,280,281,289],{},[34,282,283],{},[37,284,285,287],{},[40,286],{},[40,288],{},[50,290,291,301],{},[37,292,293,296],{},[55,294,295],{},"Type",[55,297,298],{},[15,299,300],{},"string",[37,302,303,306],{},[55,304,305],{},"Required",[55,307,308],{},[15,309,145],{},[254,311,133],{"id":133},[11,313,314,315,317],{},"Emits a ",[15,316,139],{}," file with every generated handler in operation order. It exports two things:",[319,320,321,337],"ul",{},[322,323,324,326,327,329,330,333,334,24],"li",{},[15,325,133],{},": the collection with the configured ",[15,328,118],{},". Spread it into ",[15,331,332],{},"setupServer(...handlers)"," or ",[15,335,336],{},"setupWorker(...handlers)",[322,338,339,342,343,345],{},[15,340,341],{},"createHandlers(options?)",": builds the same collection with a ",[15,344,118],{}," you pass at runtime.",[31,347,348,356],{},[34,349,350],{},[37,351,352,354],{},[40,353],{},[40,355],{},[50,357,358,367,375],{},[37,359,360,362],{},[55,361,295],{},[55,363,364],{},[15,365,366],{},"boolean",[37,368,369,371],{},[55,370,305],{},[55,372,373],{},[15,374,145],{},[37,376,377,379],{},[55,378,48],{},[55,380,381],{},[15,382,145],{},[384,385,390],"pre",{"language":386,"filename":387,"code":388,"class":389},"typescript","gen\u002Fhandlers.ts","import { getPetHandler } from '.\u002FgetPetHandler'\nimport { addPetHandler } from '.\u002FaddPetHandler'\n\nexport function createHandlers(options?: { baseURL?: string }) {\n  return [getPetHandler(undefined, options), addPetHandler(undefined, options)] as const\n}\n\nexport const handlers = createHandlers()","highlights",[15,391,393,420,421,420,437,420,439,420,475,420,523,420,528,420,530],{"class":392},"language-typescript",[394,395,398,402,406,410,413,416],"span",{"class":396,"style":397},"line","display: inline",[394,399,401],{"style":400},"color:#d73a49;--hls-dark:#f97583","import ",[394,403,405],{"style":404},"color:#005cc5;--hls-dark:#79b8ff","{ ",[394,407,409],{"style":408},"color:#24292e;--hls-dark:#e1e4e8","getPetHandler ",[394,411,412],{"style":404},"} ",[394,414,415],{"style":400},"from ",[394,417,419],{"style":418},"color:#032f62;--hls-dark:#9ecbff","'.\u002FgetPetHandler'","\n",[394,422,423,425,427,430,432,434],{"class":396,"style":397},[394,424,401],{"style":400},[394,426,405],{"style":404},[394,428,429],{"style":408},"addPetHandler ",[394,431,412],{"style":404},[394,433,415],{"style":400},[394,435,436],{"style":418},"'.\u002FaddPetHandler'",[394,438],{"class":396,"style":397},[394,440,441,444,447,450,453,456,459,462,464,466,469,472],{"class":396,"style":397},[394,442,443],{"style":400},"export ",[394,445,446],{"style":400},"function ",[394,448,278],{"style":449},"color:#6f42c1;--hls-dark:#b392f0",[394,451,452],{"style":404},"(",[394,454,455],{"style":408},"options",[394,457,458],{"style":408},"?",[394,460,461],{"style":400},": ",[394,463,405],{"style":404},[394,465,118],{"style":404},[394,467,468],{"style":408},"?: ",[394,470,471],{"style":449},"string ",[394,473,474],{"style":404},"}) {",[394,476,477,480,483,486,489,491,494,496,498,501,503,506,508,510,512,514,517,520],{"class":396,"style":397},[394,478,479],{"style":404},"  ",[394,481,482],{"style":400},"return ",[394,484,485],{"style":404},"[",[394,487,488],{"style":449},"getPetHandler",[394,490,452],{"style":404},[394,492,493],{"style":404},"undefined",[394,495,69],{"style":400},[394,497,455],{"style":408},[394,499,500],{"style":404},")",[394,502,69],{"style":400},[394,504,505],{"style":449},"addPetHandler",[394,507,452],{"style":404},[394,509,493],{"style":404},[394,511,69],{"style":400},[394,513,455],{"style":408},[394,515,516],{"style":404},")] ",[394,518,519],{"style":400},"as ",[394,521,522],{"style":400},"const",[394,524,525],{"class":396,"style":397},[394,526,527],{"style":404},"}",[394,529],{"class":396,"style":397},[394,531,532,534,537,540,543,545],{"class":396,"style":397},[394,533,443],{"style":400},[394,535,536],{"style":400},"const ",[394,538,539],{"style":408},"handlers ",[394,541,542],{"style":400},"= ",[394,544,278],{"style":449},[394,546,547],{"style":404},"()",[254,549,155],{"id":155},[11,551,158],{},[31,553,554,562],{},[34,555,556],{},[37,557,558,560],{},[40,559],{},[40,561],{},[50,563,564,573,581],{},[37,565,566,568],{},[55,567,295],{},[55,569,570],{},[15,571,572],{},"'data' | 'faker'",[37,574,575,577],{},[55,576,305],{},[55,578,579],{},[15,580,145],{},[37,582,583,585],{},[55,584,48],{},[55,586,587],{},[15,588,163],{},[590,591,592,603],"field-group",{},[593,594,595,596,599,600,24],"field",{"name":163},"Default value. Returns the data you pass to the handler, typed with the ",[15,597,598],{},"@kubb\u002Fplugin-ts"," types. The handler uses ",[15,601,602],{},"new HttpResponse(JSON.stringify(data), ...)",[593,604,606,607,610,611,614,615,333,617,620,621,69,624,626,627,630,631,634],{"name":605},"'faker'","Falls back to a value generated by ",[15,608,609],{},"@kubb\u002Fplugin-faker"," when ",[15,612,613],{},"data"," is ",[15,616,493],{},[15,618,619],{},"null",". Other falsy values, such as ",[15,622,623],{},"0",[15,625,145],{},", or ",[15,628,629],{},"''",", are sent as the response body. Register ",[15,632,633],{},"pluginFaker()"," alongside this plugin.",[384,636,638],{"language":386,"filename":605,"code":637,"class":389},"export function getPetHandler(data?: GetPetQueryResponse | ((info: Parameters\u003CParameters\u003Ctypeof http.get>[1]>[0]) => Response | Promise\u003CResponse>)) {\n  return http.get('\u002Fpet\u002F:petId', function handler(info) {\n    if (typeof data === 'function') return data(info)\n\n    return new HttpResponse(JSON.stringify(data ?? createGetPetQueryResponse(data)), {\n      status: 200,\n      headers: { 'Content-Type': 'application\u002Fjson' },\n    })\n  })\n}",[15,639,640,420,730,420,761,420,795,420,797,420,841,420,857,420,880,420,887,420,892],{"class":392},[394,641,642,644,646,648,650,652,654,657,660,663,666,668,671,674,676,678,681,684,686,689,692,694,697,700,702,704,706,709,712,715,717,720,722,725,727],{"class":396,"style":397},[394,643,443],{"style":400},[394,645,446],{"style":400},[394,647,488],{"style":449},[394,649,452],{"style":404},[394,651,613],{"style":408},[394,653,468],{"style":408},[394,655,656],{"style":449},"GetPetQueryResponse ",[394,658,659],{"style":400},"| ",[394,661,662],{"style":404},"((",[394,664,665],{"style":408},"info",[394,667,461],{"style":408},[394,669,670],{"style":449},"Parameters",[394,672,673],{"style":400},"\u003C",[394,675,670],{"style":449},[394,677,673],{"style":400},[394,679,680],{"style":400},"typeof ",[394,682,683],{"style":408},"http",[394,685,24],{"style":400},[394,687,688],{"style":404},"get",[394,690,691],{"style":400},">",[394,693,485],{"style":404},[394,695,696],{"style":404},"1",[394,698,699],{"style":404},"]",[394,701,691],{"style":400},[394,703,485],{"style":404},[394,705,623],{"style":404},[394,707,708],{"style":404},"]) ",[394,710,711],{"style":400},"=> ",[394,713,714],{"style":449},"Response ",[394,716,659],{"style":400},[394,718,719],{"style":449},"Promise",[394,721,673],{"style":400},[394,723,724],{"style":449},"Response",[394,726,691],{"style":400},[394,728,729],{"style":404},")) {",[394,731,732,734,736,738,740,742,744,747,749,751,754,756,758],{"class":396,"style":397},[394,733,479],{"style":404},[394,735,482],{"style":400},[394,737,683],{"style":408},[394,739,24],{"style":400},[394,741,688],{"style":449},[394,743,452],{"style":404},[394,745,746],{"style":418},"'\u002Fpet\u002F:petId'",[394,748,69],{"style":400},[394,750,446],{"style":400},[394,752,753],{"style":449},"handler",[394,755,452],{"style":404},[394,757,665],{"style":408},[394,759,760],{"style":404},") {",[394,762,763,766,769,771,773,776,779,782,785,787,789,791,793],{"class":396,"style":397},[394,764,765],{"style":404},"    ",[394,767,768],{"style":400},"if ",[394,770,452],{"style":404},[394,772,680],{"style":400},[394,774,775],{"style":408},"data ",[394,777,778],{"style":400},"=== ",[394,780,781],{"style":418},"'function'",[394,783,784],{"style":404},") ",[394,786,482],{"style":400},[394,788,613],{"style":449},[394,790,452],{"style":404},[394,792,665],{"style":408},[394,794,500],{"style":404},[394,796],{"class":396,"style":397},[394,798,799,801,803,806,809,811,814,816,819,821,823,826,829,831,833,836,838],{"class":396,"style":397},[394,800,765],{"style":404},[394,802,482],{"style":400},[394,804,805],{"style":400},"new ",[394,807,808],{"style":449},"HttpResponse",[394,810,452],{"style":404},[394,812,813],{"style":404},"JSON",[394,815,24],{"style":400},[394,817,818],{"style":449},"stringify",[394,820,452],{"style":404},[394,822,775],{"style":408},[394,824,825],{"style":400},"?? ",[394,827,828],{"style":449},"createGetPetQueryResponse",[394,830,452],{"style":404},[394,832,613],{"style":408},[394,834,835],{"style":404},"))",[394,837,69],{"style":400},[394,839,840],{"style":404},"{",[394,842,843,846,849,851,854],{"class":396,"style":397},[394,844,845],{"style":404},"      ",[394,847,848],{"style":404},"status",[394,850,461],{"style":400},[394,852,853],{"style":404},"200",[394,855,856],{"style":400},",",[394,858,859,861,864,866,868,871,873,876,878],{"class":396,"style":397},[394,860,845],{"style":400},[394,862,863],{"style":404},"headers",[394,865,461],{"style":400},[394,867,405],{"style":404},[394,869,870],{"style":418},"'Content-Type'",[394,872,461],{"style":400},[394,874,875],{"style":418},"'application\u002Fjson' ",[394,877,527],{"style":404},[394,879,856],{"style":400},[394,881,882,884],{"class":396,"style":397},[394,883,765],{"style":400},[394,885,886],{"style":404},"})",[394,888,889],{"class":396,"style":397},[394,890,891],{"style":404},"  })",[394,893,894],{"class":396,"style":397},[394,895,527],{"style":404},[254,897,223],{"id":223},[11,899,900,901,903,904,69,906,69,909,912,913,916,917,24],{},"Overrides generated file and symbol names. Omitted members keep ",[15,902,231],{},". The shared members (",[15,905,105],{},[15,907,908],{},"file",[15,910,911],{},"imports",") and the ",[15,914,915],{},"this"," context are described under ",[20,918,920],{"href":919},"https:\u002F\u002Fkubb.dev\u002Fdocs\u002F5.x\u002Freference\u002Fplugin-options#resolver",[15,921,223],{},[31,923,924,932],{},[34,925,926],{},[37,927,928,930],{},[40,929],{},[40,931],{},[50,933,934,943],{},[37,935,936,938],{},[55,937,295],{},[55,939,940],{},[15,941,942],{},"ResolverPatch\u003CResolverMsw>",[37,944,945,947],{},[55,946,305],{},[55,948,949],{},[15,950,145],{},[384,952,955],{"language":386,"filename":953,"code":954,"class":389},"Partial override","type ResolverMswPatch = {\n  name?(name: string): string\n  file?: {\n    baseName?(params: { name: string; extname: string }): string\n    path?(params: { baseName: string; output: Output }): string\n  }\n  imports?(options: ResolveImportsOptions): Array\u003CImportNode>\n  handler?: {\n    name?(node: OperationNode): string  \u002F\u002F → 'getPetHandler'\n    listName?(): string                 \u002F\u002F → 'handlers'\n  }\n}",[15,956,957,420,969,420,991,420,1003,420,1043,420,1080,420,1086,420,1117,420,1129,420,1158,420,1177,420,1183],{"class":392},[394,958,959,962,965,967],{"class":396,"style":397},[394,960,961],{"style":400},"type ",[394,963,964],{"style":449},"ResolverMswPatch ",[394,966,542],{"style":400},[394,968,840],{"style":404},[394,970,971,973,975,977,979,981,983,985,987,989],{"class":396,"style":397},[394,972,479],{"style":404},[394,974,105],{"style":408},[394,976,458],{"style":400},[394,978,452],{"style":404},[394,980,105],{"style":408},[394,982,461],{"style":408},[394,984,300],{"style":449},[394,986,500],{"style":404},[394,988,461],{"style":408},[394,990,300],{"style":449},[394,992,993,995,997,999,1001],{"class":396,"style":397},[394,994,479],{"style":449},[394,996,908],{"style":408},[394,998,458],{"style":408},[394,1000,461],{"style":400},[394,1002,840],{"style":404},[394,1004,1005,1007,1010,1012,1014,1017,1019,1021,1023,1025,1027,1030,1033,1035,1037,1039,1041],{"class":396,"style":397},[394,1006,765],{"style":404},[394,1008,1009],{"style":408},"baseName",[394,1011,458],{"style":400},[394,1013,452],{"style":404},[394,1015,1016],{"style":408},"params",[394,1018,461],{"style":400},[394,1020,405],{"style":404},[394,1022,105],{"style":404},[394,1024,461],{"style":408},[394,1026,300],{"style":449},[394,1028,1029],{"style":400},"; ",[394,1031,1032],{"style":404},"extname",[394,1034,461],{"style":408},[394,1036,471],{"style":449},[394,1038,886],{"style":404},[394,1040,461],{"style":408},[394,1042,300],{"style":449},[394,1044,1045,1047,1049,1051,1053,1055,1057,1059,1061,1063,1065,1067,1069,1071,1074,1076,1078],{"class":396,"style":397},[394,1046,765],{"style":449},[394,1048,68],{"style":408},[394,1050,458],{"style":400},[394,1052,452],{"style":404},[394,1054,1016],{"style":408},[394,1056,461],{"style":400},[394,1058,405],{"style":404},[394,1060,1009],{"style":404},[394,1062,461],{"style":408},[394,1064,300],{"style":449},[394,1066,1029],{"style":400},[394,1068,62],{"style":404},[394,1070,461],{"style":408},[394,1072,1073],{"style":449},"Output ",[394,1075,886],{"style":404},[394,1077,461],{"style":408},[394,1079,300],{"style":449},[394,1081,1082,1084],{"class":396,"style":397},[394,1083,479],{"style":449},[394,1085,527],{"style":404},[394,1087,1088,1090,1092,1094,1096,1098,1100,1103,1105,1107,1110,1112,1115],{"class":396,"style":397},[394,1089,479],{"style":404},[394,1091,911],{"style":408},[394,1093,458],{"style":400},[394,1095,452],{"style":404},[394,1097,455],{"style":408},[394,1099,461],{"style":408},[394,1101,1102],{"style":449},"ResolveImportsOptions",[394,1104,500],{"style":404},[394,1106,461],{"style":408},[394,1108,1109],{"style":449},"Array",[394,1111,673],{"style":400},[394,1113,1114],{"style":449},"ImportNode",[394,1116,691],{"style":400},[394,1118,1119,1121,1123,1125,1127],{"class":396,"style":397},[394,1120,479],{"style":400},[394,1122,753],{"style":408},[394,1124,458],{"style":408},[394,1126,461],{"style":400},[394,1128,840],{"style":404},[394,1130,1131,1133,1135,1137,1139,1142,1144,1147,1149,1151,1154],{"class":396,"style":397},[394,1132,765],{"style":404},[394,1134,105],{"style":408},[394,1136,458],{"style":400},[394,1138,452],{"style":404},[394,1140,1141],{"style":408},"node",[394,1143,461],{"style":408},[394,1145,1146],{"style":449},"OperationNode",[394,1148,500],{"style":404},[394,1150,461],{"style":408},[394,1152,1153],{"style":449},"string  ",[394,1155,1157],{"style":1156},"color:#6a737d;--hls-dark:#6a737d","\u002F\u002F → 'getPetHandler'",[394,1159,1160,1162,1165,1167,1169,1171,1174],{"class":396,"style":397},[394,1161,765],{"style":1156},[394,1163,1164],{"style":408},"listName",[394,1166,458],{"style":400},[394,1168,547],{"style":404},[394,1170,461],{"style":408},[394,1172,1173],{"style":449},"string                 ",[394,1175,1176],{"style":1156},"\u002F\u002F → 'handlers'",[394,1178,1179,1181],{"class":396,"style":397},[394,1180,479],{"style":1156},[394,1182,527],{"style":404},[394,1184,1185],{"class":396,"style":397},[394,1186,527],{"style":404},{"title":1188,"searchDepth":1189,"depth":1189,"links":1190},"",5,[1191,1193],{"id":28,"depth":1192,"text":29},2,{"id":251,"depth":1192,"text":252,"children":1194},[1195,1197,1198,1199],{"id":256,"depth":1196,"text":118},3,{"id":133,"depth":1196,"text":133},{"id":155,"depth":1196,"text":155},{"id":223,"depth":1196,"text":223},"\u002Fextensions\u002Fkubb-labs\u002Fplugin-msw\u002Foptions",1793747912657]