@jaredwray/mockhttp 1.8.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -7
- package/dist/index.d.mts +135 -33
- package/dist/index.mjs +360 -342
- package/package.json +22 -18
- package/site/dist/api/index.html +17983 -0
- package/site/dist/api/swagger.json +5487 -0
- package/site/dist/changelog/index.html +767 -0
- package/site/dist/changelog/page/2/index.html +578 -0
- package/site/dist/changelog/v0-1-0/index.html +453 -0
- package/site/dist/changelog/v0-2-0/index.html +437 -0
- package/site/dist/changelog/v0-2-1/index.html +438 -0
- package/site/dist/changelog/v0-2-2/index.html +436 -0
- package/site/dist/changelog/v0-2-3/index.html +440 -0
- package/site/dist/changelog/v0-3-0/index.html +443 -0
- package/site/dist/changelog/v0-4-0/index.html +437 -0
- package/site/dist/changelog/v0-4-1/index.html +441 -0
- package/site/dist/changelog/v0-4-2/index.html +446 -0
- package/site/dist/changelog/v0-4-3/index.html +437 -0
- package/site/dist/changelog/v0-5-0/index.html +443 -0
- package/site/dist/changelog/v0-6-0/index.html +444 -0
- package/site/dist/changelog/v0-6-1/index.html +441 -0
- package/site/dist/changelog/v0-7-0/index.html +445 -0
- package/site/dist/changelog/v0-8-0/index.html +440 -0
- package/site/dist/changelog/v0-9-0/index.html +437 -0
- package/site/dist/changelog/v1-0-0/index.html +446 -0
- package/site/dist/changelog/v1-0-1/index.html +437 -0
- package/site/dist/changelog/v1-1-0/index.html +445 -0
- package/site/dist/changelog/v1-2-0/index.html +443 -0
- package/site/dist/changelog/v1-3-0/index.html +448 -0
- package/site/dist/changelog/v1-4-0/index.html +445 -0
- package/site/dist/changelog/v1-5-0/index.html +439 -0
- package/site/dist/changelog/v1-5-1/index.html +443 -0
- package/site/dist/changelog/v1-6-0/index.html +467 -0
- package/site/dist/changelog/v1-7-0/index.html +462 -0
- package/site/dist/changelog/v1-8-0/index.html +481 -0
- package/site/dist/changelog/v1-8-1/index.html +457 -0
- package/site/dist/changelog/v1-9-0/index.html +495 -0
- package/site/dist/changelog/v2-0-0/index.html +500 -0
- package/site/dist/changelog-latest.json +269 -0
- package/site/dist/changelog.json +399 -0
- package/site/dist/css/api.css +1113 -0
- package/site/dist/css/highlight/highlight.min.js +1433 -0
- package/site/dist/css/highlight/styles/base16/docula.css +123 -0
- package/site/dist/css/home.css +133 -0
- package/site/dist/css/styles.css +1227 -0
- package/site/dist/css/variables.css +32 -0
- package/site/dist/docs/bins/index.html +942 -0
- package/site/dist/docs/configuration/index.html +771 -0
- package/site/dist/docs/hosted/index.html +544 -0
- package/site/dist/docs/https/index.html +758 -0
- package/site/dist/docs/index.html +601 -0
- package/site/dist/docs/library/index.html +780 -0
- package/site/dist/docs/taps/index.html +708 -0
- package/site/dist/favicon.svg +14 -0
- package/site/dist/feed.xml +1 -0
- package/site/dist/index.html +601 -0
- package/site/dist/js/api.js +363 -0
- package/site/dist/js/search.js +436 -0
- package/site/dist/llms-full.txt +7415 -0
- package/site/dist/llms.txt +40 -0
- package/site/dist/logo.svg +21 -0
- package/site/dist/robots.txt +2 -0
- package/site/dist/search-index.json +1 -0
- package/site/dist/sitemap.xml +1 -0
|
@@ -0,0 +1,708 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
7
|
+
<meta name="description" content="HTTP mock server and httpbin replacement for API testing. Run it at mockhttp.org, in Docker, or in Node.js.">
|
|
8
|
+
<link rel="stylesheet" href="/css/variables.css">
|
|
9
|
+
<link rel="stylesheet" href="/css/styles.css">
|
|
10
|
+
<link rel="stylesheet" href="/css/highlight/styles/base16/docula.css">
|
|
11
|
+
<link rel="icon" href="/logo.svg">
|
|
12
|
+
<script>
|
|
13
|
+
(function(){
|
|
14
|
+
window.__doculaThemeKey = 'docula:theme:' + ('https://mockhttp.org').replace(/^https?:\/\//, '');
|
|
15
|
+
var mode = localStorage.getItem(window.__doculaThemeKey) || 'light';
|
|
16
|
+
var resolved = mode === 'system'
|
|
17
|
+
? (window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark')
|
|
18
|
+
: mode;
|
|
19
|
+
if (resolved === 'light') document.documentElement.setAttribute('data-theme', 'light');
|
|
20
|
+
try {
|
|
21
|
+
var authState = JSON.parse(localStorage.getItem('docula-auth-state'));
|
|
22
|
+
if (authState) {
|
|
23
|
+
window.__doculaAuth = authState;
|
|
24
|
+
if (authState.loggedIn) {
|
|
25
|
+
document.documentElement.classList.add('docula-auth-logged-in');
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
} catch (e) {
|
|
29
|
+
// Ignore localStorage parsing errors
|
|
30
|
+
}
|
|
31
|
+
if (!window.__doculaAuth) {
|
|
32
|
+
window.__doculaAuth = { loggedIn: false, displayName: null };
|
|
33
|
+
}
|
|
34
|
+
})();
|
|
35
|
+
</script>
|
|
36
|
+
<title>MockHTTP - Taps</title>
|
|
37
|
+
<script type="application/ld+json">
|
|
38
|
+
{"@context":"https://schema.org","@type":"TechArticle","headline":"Taps","description":"","url":"https://mockhttp.org/docs/taps/","publisher":{"@type":"Organization","name":"MockHTTP"},"dateModified":"2026-09-18","keywords":[]}
|
|
39
|
+
</script>
|
|
40
|
+
</head>
|
|
41
|
+
|
|
42
|
+
<body>
|
|
43
|
+
<header class="header">
|
|
44
|
+
<div class="header-top">
|
|
45
|
+
<div class="header-top__content">
|
|
46
|
+
<button class="mobile-menu-toggle" id="mobile-menu-toggle" aria-label="Toggle navigation menu">
|
|
47
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="4" x2="20" y1="12" y2="12"/><line x1="4" x2="20" y1="6" y2="6"/><line x1="4" x2="20" y1="18" y2="18"/></svg>
|
|
48
|
+
</button>
|
|
49
|
+
<a href="/" class="logo-link">
|
|
50
|
+
<img alt="MockHTTP" class="logo__img" src="/logo.svg">
|
|
51
|
+
</a>
|
|
52
|
+
<nav class="header-bottom__nav">
|
|
53
|
+
<a class="header-bottom__item" href="/docs/" id="nav-docs">
|
|
54
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
|
|
55
|
+
<span>Documentation</span>
|
|
56
|
+
</a>
|
|
57
|
+
<a class="header-bottom__item" href="/api" id="nav-api">
|
|
58
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
|
|
59
|
+
<span>API Reference</span>
|
|
60
|
+
</a>
|
|
61
|
+
<a class="header-bottom__item" href="/changelog/" id="nav-changelog">
|
|
62
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
|
|
63
|
+
<span>Changelog</span>
|
|
64
|
+
</a>
|
|
65
|
+
</nav>
|
|
66
|
+
<div class="header-actions">
|
|
67
|
+
<button class="search-button" id="search-button" type="button" aria-label="Search" aria-keyshortcuts="Meta+K Control+K">
|
|
68
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.3-4.3"/></svg>
|
|
69
|
+
<span class="search-button__text">Search</span>
|
|
70
|
+
<span class="search-button__shortcut">⌘K</span>
|
|
71
|
+
</button>
|
|
72
|
+
<button class="theme-button" id="theme-toggle" aria-label="Theme: system (following system)">
|
|
73
|
+
<svg class="theme-button__icon theme-button__icon--system" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="2" y="3" width="20" height="14" rx="2"/><line x1="8" x2="16" y1="21" y2="21"/><line x1="12" x2="12" y1="17" y2="21"/></svg>
|
|
74
|
+
<svg class="theme-button__icon theme-button__icon--sun theme-button__icon--hidden" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="4"/><path d="M12 2v2"/><path d="M12 20v2"/><path d="m4.93 4.93 1.41 1.41"/><path d="m17.66 17.66 1.41 1.41"/><path d="M2 12h2"/><path d="M20 12h2"/><path d="m6.34 17.66-1.41 1.41"/><path d="m19.07 4.93-1.41 1.41"/></svg>
|
|
75
|
+
<svg class="theme-button__icon theme-button__icon--moon theme-button__icon--hidden" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401"/></svg>
|
|
76
|
+
</button>
|
|
77
|
+
</div>
|
|
78
|
+
</div>
|
|
79
|
+
</div>
|
|
80
|
+
</header>
|
|
81
|
+
<aside class="mobile-sidebar" id="mobile-sidebar">
|
|
82
|
+
<nav class="mobile-nav">
|
|
83
|
+
<a class="mobile-nav__item" href="/docs/">
|
|
84
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
|
|
85
|
+
<span>Documentation</span>
|
|
86
|
+
</a>
|
|
87
|
+
<a class="mobile-nav__item" href="/api">
|
|
88
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
|
|
89
|
+
<span>API Reference</span>
|
|
90
|
+
</a>
|
|
91
|
+
<a class="mobile-nav__item" href="/changelog/">
|
|
92
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
|
|
93
|
+
<span>Changelog</span>
|
|
94
|
+
</a>
|
|
95
|
+
</nav>
|
|
96
|
+
<div class="mobile-sidebar__docs" id="mobile-sidebar-docs"></div>
|
|
97
|
+
</aside>
|
|
98
|
+
<div class="sidebar-backdrop" id="sidebar-backdrop"></div>
|
|
99
|
+
<div class="search-modal" id="search-modal" hidden>
|
|
100
|
+
<div class="search-modal__backdrop" data-search-close></div>
|
|
101
|
+
<div class="search-modal__panel" role="dialog" aria-modal="true" aria-label="Search">
|
|
102
|
+
<div class="search-modal__header">
|
|
103
|
+
<svg class="search-modal__icon" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.3-4.3"/></svg>
|
|
104
|
+
<input
|
|
105
|
+
type="search"
|
|
106
|
+
id="search-input"
|
|
107
|
+
class="search-modal__input"
|
|
108
|
+
placeholder="Search"
|
|
109
|
+
autocomplete="off"
|
|
110
|
+
autocorrect="off"
|
|
111
|
+
autocapitalize="off"
|
|
112
|
+
spellcheck="false"
|
|
113
|
+
aria-label="Search"
|
|
114
|
+
aria-controls="search-results"
|
|
115
|
+
aria-activedescendant=""
|
|
116
|
+
role="combobox"
|
|
117
|
+
aria-expanded="true"
|
|
118
|
+
/>
|
|
119
|
+
<button class="search-modal__clear" id="search-clear" type="button" aria-label="Clear search" hidden>
|
|
120
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/></svg>
|
|
121
|
+
</button>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="search-modal__body">
|
|
124
|
+
<ul class="search-results" id="search-results" role="listbox" aria-label="Search results"></ul>
|
|
125
|
+
<div class="search-modal__empty" id="search-empty" hidden>
|
|
126
|
+
No results for "<span class="search-modal__empty-query" id="search-empty-query"></span>"
|
|
127
|
+
</div>
|
|
128
|
+
<div class="search-modal__initial" id="search-initial">
|
|
129
|
+
Type to search the documentation.
|
|
130
|
+
</div>
|
|
131
|
+
</div>
|
|
132
|
+
<div class="search-modal__footer">
|
|
133
|
+
<span class="search-modal__hint"><kbd class="search-modal__kbd">↑</kbd><kbd class="search-modal__kbd">↓</kbd> to navigate</span>
|
|
134
|
+
<span class="search-modal__hint"><kbd class="search-modal__kbd">↵</kbd> to select</span>
|
|
135
|
+
<span class="search-modal__hint"><kbd class="search-modal__kbd">esc</kbd> to close</span>
|
|
136
|
+
</div>
|
|
137
|
+
</div>
|
|
138
|
+
</div>
|
|
139
|
+
<script>
|
|
140
|
+
window.__doculaSearch = { indexUrl: "/search-index.json" };
|
|
141
|
+
</script>
|
|
142
|
+
<script src="/js/search.js" defer></script>
|
|
143
|
+
<div class="page-dropdown" id="page-dropdown">
|
|
144
|
+
<button class="page-dropdown__toggle" id="page-dropdown-toggle">
|
|
145
|
+
<span class="page-dropdown__title">Taps</span>
|
|
146
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m7 15 5 5 5-5"/><path d="m7 9 5-5 5 5"/></svg>
|
|
147
|
+
</button>
|
|
148
|
+
<div class="page-dropdown__list" id="page-dropdown-list">
|
|
149
|
+
<section class="nav-sidebar__section">
|
|
150
|
+
<ul class="nav-sidebar__list">
|
|
151
|
+
<li>
|
|
152
|
+
<a href="/docs/" class="nav-sidebar__item">Getting Started</a>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</section>
|
|
156
|
+
<section class="nav-sidebar__section">
|
|
157
|
+
<ul class="nav-sidebar__list">
|
|
158
|
+
<li>
|
|
159
|
+
<a href="/docs/https/" class="nav-sidebar__item">HTTPS and HTTP/2</a>
|
|
160
|
+
</li>
|
|
161
|
+
</ul>
|
|
162
|
+
</section>
|
|
163
|
+
<section class="nav-sidebar__section">
|
|
164
|
+
<ul class="nav-sidebar__list">
|
|
165
|
+
<li>
|
|
166
|
+
<a href="/docs/taps/" class="nav-sidebar__item">Taps</a>
|
|
167
|
+
</li>
|
|
168
|
+
</ul>
|
|
169
|
+
</section>
|
|
170
|
+
<section class="nav-sidebar__section">
|
|
171
|
+
<ul class="nav-sidebar__list">
|
|
172
|
+
<li>
|
|
173
|
+
<a href="/docs/bins/" class="nav-sidebar__item">Bins</a>
|
|
174
|
+
</li>
|
|
175
|
+
</ul>
|
|
176
|
+
</section>
|
|
177
|
+
<section class="nav-sidebar__section">
|
|
178
|
+
<ul class="nav-sidebar__list">
|
|
179
|
+
<li>
|
|
180
|
+
<a href="/docs/configuration/" class="nav-sidebar__item">Configuration</a>
|
|
181
|
+
</li>
|
|
182
|
+
</ul>
|
|
183
|
+
</section>
|
|
184
|
+
<section class="nav-sidebar__section">
|
|
185
|
+
<ul class="nav-sidebar__list">
|
|
186
|
+
<li>
|
|
187
|
+
<a href="/docs/library/" class="nav-sidebar__item">Library API</a>
|
|
188
|
+
</li>
|
|
189
|
+
</ul>
|
|
190
|
+
</section>
|
|
191
|
+
<section class="nav-sidebar__section">
|
|
192
|
+
<ul class="nav-sidebar__list">
|
|
193
|
+
<li>
|
|
194
|
+
<a href="/docs/hosted/" class="nav-sidebar__item">Hosted Service</a>
|
|
195
|
+
</li>
|
|
196
|
+
</ul>
|
|
197
|
+
</section>
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
<div class="content">
|
|
201
|
+
<aside class="nav-sidebar" id="nav-sidebar">
|
|
202
|
+
<section class="nav-sidebar__section">
|
|
203
|
+
<ul class="nav-sidebar__list">
|
|
204
|
+
<li>
|
|
205
|
+
<a href="/docs/" class="nav-sidebar__item">Getting Started</a>
|
|
206
|
+
</li>
|
|
207
|
+
</ul>
|
|
208
|
+
</section>
|
|
209
|
+
<section class="nav-sidebar__section">
|
|
210
|
+
<ul class="nav-sidebar__list">
|
|
211
|
+
<li>
|
|
212
|
+
<a href="/docs/https/" class="nav-sidebar__item">HTTPS and HTTP/2</a>
|
|
213
|
+
</li>
|
|
214
|
+
</ul>
|
|
215
|
+
</section>
|
|
216
|
+
<section class="nav-sidebar__section">
|
|
217
|
+
<ul class="nav-sidebar__list">
|
|
218
|
+
<li>
|
|
219
|
+
<a href="/docs/taps/" class="nav-sidebar__item">Taps</a>
|
|
220
|
+
</li>
|
|
221
|
+
</ul>
|
|
222
|
+
</section>
|
|
223
|
+
<section class="nav-sidebar__section">
|
|
224
|
+
<ul class="nav-sidebar__list">
|
|
225
|
+
<li>
|
|
226
|
+
<a href="/docs/bins/" class="nav-sidebar__item">Bins</a>
|
|
227
|
+
</li>
|
|
228
|
+
</ul>
|
|
229
|
+
</section>
|
|
230
|
+
<section class="nav-sidebar__section">
|
|
231
|
+
<ul class="nav-sidebar__list">
|
|
232
|
+
<li>
|
|
233
|
+
<a href="/docs/configuration/" class="nav-sidebar__item">Configuration</a>
|
|
234
|
+
</li>
|
|
235
|
+
</ul>
|
|
236
|
+
</section>
|
|
237
|
+
<section class="nav-sidebar__section">
|
|
238
|
+
<ul class="nav-sidebar__list">
|
|
239
|
+
<li>
|
|
240
|
+
<a href="/docs/library/" class="nav-sidebar__item">Library API</a>
|
|
241
|
+
</li>
|
|
242
|
+
</ul>
|
|
243
|
+
</section>
|
|
244
|
+
<section class="nav-sidebar__section">
|
|
245
|
+
<ul class="nav-sidebar__list">
|
|
246
|
+
<li>
|
|
247
|
+
<a href="/docs/hosted/" class="nav-sidebar__item">Hosted Service</a>
|
|
248
|
+
</li>
|
|
249
|
+
</ul>
|
|
250
|
+
</section>
|
|
251
|
+
</aside>
|
|
252
|
+
<article class="article">
|
|
253
|
+
<header class="article__header">
|
|
254
|
+
<h1 class="article__title">Taps</h1>
|
|
255
|
+
</header>
|
|
256
|
+
<div class="article__body">
|
|
257
|
+
<main class="article__main">
|
|
258
|
+
<p>The injection/tap feature allows you to "tap into" the request flow and inject custom responses for specific requests. This is particularly useful for:</p>
|
|
259
|
+
<ul>
|
|
260
|
+
<li><strong>Offline testing</strong> - Mock external API responses without network access</li>
|
|
261
|
+
<li><strong>Testing edge cases</strong> - Simulate errors, timeouts, or specific response scenarios</li>
|
|
262
|
+
<li><strong>Development</strong> - Work on your application without depending on external services</li>
|
|
263
|
+
</ul>
|
|
264
|
+
<h2 id="table-of-contents">Table of Contents</h2>
|
|
265
|
+
<ul>
|
|
266
|
+
<li><a href="#what-is-a-tap">What is a "Tap"?</a></li>
|
|
267
|
+
<li><a href="#basic-usage">Basic Usage</a></li>
|
|
268
|
+
<li><a href="#advanced-examples">Advanced Examples</a>
|
|
269
|
+
<ul>
|
|
270
|
+
<li><a href="#inject-json-response">Inject JSON Response</a></li>
|
|
271
|
+
<li><a href="#wildcard-url-matching">Wildcard URL Matching</a></li>
|
|
272
|
+
<li><a href="#multiple-injections">Multiple Injections</a></li>
|
|
273
|
+
<li><a href="#match-by-http-method">Match by HTTP Method</a></li>
|
|
274
|
+
<li><a href="#match-by-headers">Match by Headers</a></li>
|
|
275
|
+
<li><a href="#catch-all-injection">Catch-All Injection</a></li>
|
|
276
|
+
<li><a href="#dynamic-function-response">Dynamic Function Response</a></li>
|
|
277
|
+
</ul>
|
|
278
|
+
</li>
|
|
279
|
+
</ul>
|
|
280
|
+
<h2 id="what-is-a-tap">What is a "Tap"?</h2>
|
|
281
|
+
<p>A "tap" is a reference to an injected response, similar to "wiretapping" - you're intercepting requests and returning predefined responses. Each tap can be removed when you're done with it, restoring normal server behavior.</p>
|
|
282
|
+
<h2 id="basic-usage">Basic Usage</h2>
|
|
283
|
+
<pre><code class="hljs language-javascript"><span class="hljs-keyword">import</span> { mockhttp } <span class="hljs-keyword">from</span> <span class="hljs-string">'@jaredwray/mockhttp'</span>;
|
|
284
|
+
|
|
285
|
+
<span class="hljs-keyword">const</span> mock = <span class="hljs-keyword">new</span> <span class="hljs-title function_">mockhttp</span>();
|
|
286
|
+
<span class="hljs-keyword">await</span> mock.<span class="hljs-title function_">start</span>();
|
|
287
|
+
|
|
288
|
+
<span class="hljs-comment">// Inject a simple response</span>
|
|
289
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
290
|
+
{
|
|
291
|
+
<span class="hljs-attr">response</span>: <span class="hljs-string">"Hello, World!"</span>,
|
|
292
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">200</span>,
|
|
293
|
+
<span class="hljs-attr">headers</span>: { <span class="hljs-string">"Content-Type"</span>: <span class="hljs-string">"text/plain"</span> }
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
<span class="hljs-attr">url</span>: <span class="hljs-string">"/api/greeting"</span>,
|
|
297
|
+
<span class="hljs-attr">method</span>: <span class="hljs-string">"GET"</span>
|
|
298
|
+
}
|
|
299
|
+
);
|
|
300
|
+
|
|
301
|
+
<span class="hljs-comment">// Make requests - they will get the injected response</span>
|
|
302
|
+
<span class="hljs-keyword">const</span> response = <span class="hljs-keyword">await</span> <span class="hljs-title function_">fetch</span>(<span class="hljs-string">'http://localhost:3000/api/greeting'</span>);
|
|
303
|
+
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-keyword">await</span> response.<span class="hljs-title function_">text</span>()); <span class="hljs-comment">// "Hello, World!"</span>
|
|
304
|
+
|
|
305
|
+
<span class="hljs-comment">// Remove the injection when done</span>
|
|
306
|
+
mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">removeInjection</span>(tap);
|
|
307
|
+
|
|
308
|
+
<span class="hljs-keyword">await</span> mock.<span class="hljs-title function_">close</span>();
|
|
309
|
+
</code></pre>
|
|
310
|
+
<h2 id="advanced-examples">Advanced Examples</h2>
|
|
311
|
+
<h3 id="inject-json-response">Inject JSON Response</h3>
|
|
312
|
+
<pre><code class="hljs language-javascript"><span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
313
|
+
{
|
|
314
|
+
<span class="hljs-attr">response</span>: { <span class="hljs-attr">message</span>: <span class="hljs-string">"Success"</span>, <span class="hljs-attr">data</span>: { <span class="hljs-attr">id</span>: <span class="hljs-number">123</span> } },
|
|
315
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">200</span>
|
|
316
|
+
},
|
|
317
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/users/123"</span> }
|
|
318
|
+
);
|
|
319
|
+
</code></pre>
|
|
320
|
+
<h3 id="wildcard-url-matching">Wildcard URL Matching</h3>
|
|
321
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Match all requests under /api/</span>
|
|
322
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
323
|
+
{
|
|
324
|
+
<span class="hljs-attr">response</span>: <span class="hljs-string">"API is mocked"</span>,
|
|
325
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">503</span>
|
|
326
|
+
},
|
|
327
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/*"</span> }
|
|
328
|
+
);
|
|
329
|
+
</code></pre>
|
|
330
|
+
<h3 id="multiple-injections">Multiple Injections</h3>
|
|
331
|
+
<pre><code class="hljs language-javascript"><span class="hljs-keyword">const</span> tap1 = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
332
|
+
{ <span class="hljs-attr">response</span>: <span class="hljs-string">"Users data"</span> },
|
|
333
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/users"</span> }
|
|
334
|
+
);
|
|
335
|
+
|
|
336
|
+
<span class="hljs-keyword">const</span> tap2 = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
337
|
+
{ <span class="hljs-attr">response</span>: <span class="hljs-string">"Posts data"</span> },
|
|
338
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/posts"</span> }
|
|
339
|
+
);
|
|
340
|
+
|
|
341
|
+
<span class="hljs-comment">// View all active injections</span>
|
|
342
|
+
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(mock.<span class="hljs-property">taps</span>.<span class="hljs-property">injections</span>); <span class="hljs-comment">// Map of all active taps</span>
|
|
343
|
+
|
|
344
|
+
<span class="hljs-comment">// Remove specific injections</span>
|
|
345
|
+
mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">removeInjection</span>(tap1);
|
|
346
|
+
mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">removeInjection</span>(tap2);
|
|
347
|
+
</code></pre>
|
|
348
|
+
<h3 id="match-by-http-method">Match by HTTP Method</h3>
|
|
349
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Only intercept POST requests</span>
|
|
350
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
351
|
+
{ <span class="hljs-attr">response</span>: <span class="hljs-string">"Created"</span>, <span class="hljs-attr">statusCode</span>: <span class="hljs-number">201</span> },
|
|
352
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/users"</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">"POST"</span> }
|
|
353
|
+
);
|
|
354
|
+
</code></pre>
|
|
355
|
+
<h3 id="match-by-headers">Match by Headers</h3>
|
|
356
|
+
<pre><code class="hljs language-javascript"><span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
357
|
+
{ <span class="hljs-attr">response</span>: <span class="hljs-string">"Authenticated response"</span> },
|
|
358
|
+
{
|
|
359
|
+
<span class="hljs-attr">url</span>: <span class="hljs-string">"/api/secure"</span>,
|
|
360
|
+
<span class="hljs-attr">headers</span>: {
|
|
361
|
+
<span class="hljs-string">"authorization"</span>: <span class="hljs-string">"Bearer token123"</span>
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
);
|
|
365
|
+
</code></pre>
|
|
366
|
+
<h3 id="catch-all-injection">Catch-All Injection</h3>
|
|
367
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Match ALL requests (no matcher specified)</span>
|
|
368
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>({
|
|
369
|
+
<span class="hljs-attr">response</span>: <span class="hljs-string">"Server is in maintenance mode"</span>,
|
|
370
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">503</span>
|
|
371
|
+
});
|
|
372
|
+
</code></pre>
|
|
373
|
+
<h3 id="dynamic-function-response">Dynamic Function Response</h3>
|
|
374
|
+
<p>You can provide a function that dynamically generates the response based on the incoming request:</p>
|
|
375
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Function response with access to the request object</span>
|
|
376
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
377
|
+
<span class="hljs-function">(<span class="hljs-params">request</span>) =></span> {
|
|
378
|
+
<span class="hljs-keyword">return</span> {
|
|
379
|
+
<span class="hljs-attr">response</span>: {
|
|
380
|
+
<span class="hljs-attr">message</span>: <span class="hljs-string">`You requested <span class="hljs-subst">${request.url}</span>`</span>,
|
|
381
|
+
<span class="hljs-attr">method</span>: request.<span class="hljs-property">method</span>,
|
|
382
|
+
<span class="hljs-attr">timestamp</span>: <span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>().<span class="hljs-title function_">toISOString</span>()
|
|
383
|
+
},
|
|
384
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">200</span>,
|
|
385
|
+
<span class="hljs-attr">headers</span>: {
|
|
386
|
+
<span class="hljs-string">"X-Request-Path"</span>: request.<span class="hljs-property">url</span>
|
|
387
|
+
}
|
|
388
|
+
};
|
|
389
|
+
},
|
|
390
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/*"</span> }
|
|
391
|
+
);
|
|
392
|
+
</code></pre>
|
|
393
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Conditional responses based on request</span>
|
|
394
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(<span class="hljs-function">(<span class="hljs-params">request</span>) =></span> {
|
|
395
|
+
<span class="hljs-comment">// Return error for URLs containing 'error'</span>
|
|
396
|
+
<span class="hljs-keyword">if</span> (request.<span class="hljs-property">url</span>.<span class="hljs-title function_">includes</span>(<span class="hljs-string">'error'</span>)) {
|
|
397
|
+
<span class="hljs-keyword">return</span> {
|
|
398
|
+
<span class="hljs-attr">response</span>: { <span class="hljs-attr">error</span>: <span class="hljs-string">"Something went wrong"</span> },
|
|
399
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">500</span>
|
|
400
|
+
};
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
<span class="hljs-comment">// Return success for everything else</span>
|
|
404
|
+
<span class="hljs-keyword">return</span> {
|
|
405
|
+
<span class="hljs-attr">response</span>: { <span class="hljs-attr">status</span>: <span class="hljs-string">"success"</span> },
|
|
406
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">200</span>
|
|
407
|
+
};
|
|
408
|
+
});
|
|
409
|
+
</code></pre>
|
|
410
|
+
<pre><code class="hljs language-javascript"><span class="hljs-comment">// Dynamic headers based on request</span>
|
|
411
|
+
<span class="hljs-keyword">const</span> tap = mock.<span class="hljs-property">taps</span>.<span class="hljs-title function_">inject</span>(
|
|
412
|
+
<span class="hljs-function">(<span class="hljs-params">request</span>) =></span> ({
|
|
413
|
+
<span class="hljs-attr">response</span>: <span class="hljs-string">"OK"</span>,
|
|
414
|
+
<span class="hljs-attr">statusCode</span>: <span class="hljs-number">200</span>,
|
|
415
|
+
<span class="hljs-attr">headers</span>: {
|
|
416
|
+
<span class="hljs-string">"X-Original-Method"</span>: request.<span class="hljs-property">method</span>,
|
|
417
|
+
<span class="hljs-string">"X-Original-URL"</span>: request.<span class="hljs-property">url</span>,
|
|
418
|
+
<span class="hljs-string">"X-Original-Host"</span>: request.<span class="hljs-property">hostname</span>
|
|
419
|
+
}
|
|
420
|
+
}),
|
|
421
|
+
{ <span class="hljs-attr">url</span>: <span class="hljs-string">"/api/mirror"</span> }
|
|
422
|
+
);
|
|
423
|
+
</code></pre>
|
|
424
|
+
</main>
|
|
425
|
+
<aside class="content-aside">
|
|
426
|
+
<h2 class="content-aside__title">TABLE OF CONTENTS</h2>
|
|
427
|
+
<ul class="content-aside__list" id="toc-list">
|
|
428
|
+
</ul>
|
|
429
|
+
</aside>
|
|
430
|
+
</div>
|
|
431
|
+
<a class="article__edit-link" href="https://github.com/jaredwray/mockhttp/edit/main/site/docs/taps.md" target="_blank" rel="noopener noreferrer">
|
|
432
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M17 3a2.85 2.83 0 1 1 4 4L7.5 20.5 2 22l1.5-5.5Z"/><path d="m15 5 4 4"/></svg>
|
|
433
|
+
Edit this page
|
|
434
|
+
</a>
|
|
435
|
+
</article>
|
|
436
|
+
</div>
|
|
437
|
+
<footer>
|
|
438
|
+
<a href="/llms.txt" class="footer__link">llms.txt</a>
|
|
439
|
+
<a href="/feed.xml" class="footer__link" aria-label="RSS Feed">
|
|
440
|
+
<svg class="footer__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><circle cx="6.18" cy="17.82" r="2.18"/><path d="M4 4.44v2.83c7.03 0 12.73 5.7 12.73 12.73h2.83c0-8.59-6.97-15.56-15.56-15.56zm0 5.66v2.83c3.9 0 7.07 3.17 7.07 7.07h2.83c0-5.47-4.43-9.9-9.9-9.9z"/></svg>
|
|
441
|
+
</a>
|
|
442
|
+
|
|
443
|
+
<a href="https://docula.org/" target="_blank" rel="noopener noreferrer" class="footer__link" aria-label="Docula">
|
|
444
|
+
<svg class="footer__bat" xmlns="http://www.w3.org/2000/svg" viewBox="70 110 360 205" fill="currentColor"><path d="M420,173c-16.76-18-72.78-36.65-131.59-30.58A160.15,160.15,0,0,0,269,120.55c-3.78,4.52-11.15,9.45-19,9.45s-15.23-4.93-19-9.45a160.15,160.15,0,0,0-19.4,21.83C152.78,136.31,96.76,154.94,80,173c48.86,5.86,79.5,34.09,79.5,72.06,52.37,0,77,28,90.5,59.94C263.54,273,288.13,245,340.5,245,340.5,207,371.14,178.8,420,173Z"/><circle cx="239.19" cy="145.36" r="3.32" fill="#fff"/><circle cx="260.81" cy="145.36" r="3.32" fill="#fff"/></svg>
|
|
445
|
+
</a>
|
|
446
|
+
<span class="footer__updated">updated: 2026-09-18</span>
|
|
447
|
+
</footer>
|
|
448
|
+
<script src="/css/highlight/highlight.min.js"></script>
|
|
449
|
+
<script>
|
|
450
|
+
document.addEventListener('DOMContentLoaded', () => {
|
|
451
|
+
document.querySelectorAll('pre code').forEach(el => { el.textContent = el.textContent.trimEnd(); });
|
|
452
|
+
hljs.highlightAll();
|
|
453
|
+
var kbd = document.querySelector('.search-button__shortcut');
|
|
454
|
+
if (kbd) kbd.textContent = navigator.platform.indexOf('Mac') > -1 ? '⌘K' : 'Ctrl K';
|
|
455
|
+
|
|
456
|
+
// Copy code buttons
|
|
457
|
+
const copyIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>';
|
|
458
|
+
const checkIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="20 6 9 17 4 12"/></svg>';
|
|
459
|
+
document.querySelectorAll('pre').forEach(function(pre) {
|
|
460
|
+
const btn = document.createElement('button');
|
|
461
|
+
btn.className = 'copy-code-btn';
|
|
462
|
+
btn.innerHTML = copyIcon;
|
|
463
|
+
btn.setAttribute('aria-label', 'Copy code');
|
|
464
|
+
btn.addEventListener('click', function() {
|
|
465
|
+
const code = pre.querySelector('code');
|
|
466
|
+
const text = code ? code.textContent : pre.textContent;
|
|
467
|
+
navigator.clipboard.writeText(text || '').then(function() {
|
|
468
|
+
btn.innerHTML = checkIcon;
|
|
469
|
+
setTimeout(function() { btn.innerHTML = copyIcon; }, 2000);
|
|
470
|
+
});
|
|
471
|
+
});
|
|
472
|
+
pre.appendChild(btn);
|
|
473
|
+
});
|
|
474
|
+
});
|
|
475
|
+
</script>
|
|
476
|
+
<script>
|
|
477
|
+
(function() {
|
|
478
|
+
var themeKey = window.__doculaThemeKey;
|
|
479
|
+
function getMode() {
|
|
480
|
+
return localStorage.getItem(themeKey) || 'light';
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
function resolveTheme(mode) {
|
|
484
|
+
if (mode === 'system') {
|
|
485
|
+
return window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark';
|
|
486
|
+
}
|
|
487
|
+
return mode;
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
var cachedEls = null;
|
|
491
|
+
function getThemeEls() {
|
|
492
|
+
if (!cachedEls) {
|
|
493
|
+
cachedEls = {
|
|
494
|
+
systemIcon: document.querySelector('.theme-button__icon--system'),
|
|
495
|
+
sunIcon: document.querySelector('.theme-button__icon--sun'),
|
|
496
|
+
moonIcon: document.querySelector('.theme-button__icon--moon'),
|
|
497
|
+
toggle: document.getElementById('theme-toggle')
|
|
498
|
+
};
|
|
499
|
+
}
|
|
500
|
+
return cachedEls;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
function applyTheme(mode) {
|
|
504
|
+
var resolved = resolveTheme(mode);
|
|
505
|
+
if (resolved === 'light') {
|
|
506
|
+
document.documentElement.setAttribute('data-theme', 'light');
|
|
507
|
+
} else {
|
|
508
|
+
document.documentElement.removeAttribute('data-theme');
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
var els = getThemeEls();
|
|
512
|
+
if (els.systemIcon && els.sunIcon && els.moonIcon) {
|
|
513
|
+
els.systemIcon.classList.add('theme-button__icon--hidden');
|
|
514
|
+
els.sunIcon.classList.add('theme-button__icon--hidden');
|
|
515
|
+
els.moonIcon.classList.add('theme-button__icon--hidden');
|
|
516
|
+
if (mode === 'system') {
|
|
517
|
+
els.systemIcon.classList.remove('theme-button__icon--hidden');
|
|
518
|
+
} else if (mode === 'light') {
|
|
519
|
+
els.sunIcon.classList.remove('theme-button__icon--hidden');
|
|
520
|
+
} else {
|
|
521
|
+
els.moonIcon.classList.remove('theme-button__icon--hidden');
|
|
522
|
+
}
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
if (els.toggle) {
|
|
526
|
+
var labels = { system: 'Theme: system (following system)', light: 'Theme: light', dark: 'Theme: dark' };
|
|
527
|
+
els.toggle.setAttribute('aria-label', labels[mode] || 'Toggle theme');
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
function nextMode(current) {
|
|
532
|
+
var cycle = { system: 'light', light: 'dark', dark: 'system' };
|
|
533
|
+
return cycle[current] || 'system';
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
var currentMode = getMode();
|
|
537
|
+
|
|
538
|
+
document.addEventListener('DOMContentLoaded', function() {
|
|
539
|
+
applyTheme(currentMode);
|
|
540
|
+
|
|
541
|
+
var els = getThemeEls();
|
|
542
|
+
if (els.toggle) {
|
|
543
|
+
els.toggle.addEventListener('click', function() {
|
|
544
|
+
currentMode = nextMode(currentMode);
|
|
545
|
+
localStorage.setItem(themeKey, currentMode);
|
|
546
|
+
applyTheme(currentMode);
|
|
547
|
+
});
|
|
548
|
+
}
|
|
549
|
+
});
|
|
550
|
+
|
|
551
|
+
window.matchMedia('(prefers-color-scheme: light)').addEventListener('change', function() {
|
|
552
|
+
if (getMode() === 'system') {
|
|
553
|
+
applyTheme('system');
|
|
554
|
+
}
|
|
555
|
+
});
|
|
556
|
+
})();
|
|
557
|
+
</script>
|
|
558
|
+
<script defer>
|
|
559
|
+
document.addEventListener('DOMContentLoaded', () => {
|
|
560
|
+
const menuToggle = document.getElementById('mobile-menu-toggle');
|
|
561
|
+
const mobileSidebar = document.getElementById('mobile-sidebar');
|
|
562
|
+
const backdrop = document.getElementById('sidebar-backdrop');
|
|
563
|
+
if (menuToggle && mobileSidebar) {
|
|
564
|
+
menuToggle.addEventListener('click', () => {
|
|
565
|
+
mobileSidebar.classList.toggle('mobile-sidebar--open');
|
|
566
|
+
if (backdrop) backdrop.classList.toggle('sidebar-backdrop--visible');
|
|
567
|
+
});
|
|
568
|
+
if (backdrop) {
|
|
569
|
+
backdrop.addEventListener('click', () => {
|
|
570
|
+
mobileSidebar.classList.remove('mobile-sidebar--open');
|
|
571
|
+
backdrop.classList.remove('sidebar-backdrop--visible');
|
|
572
|
+
});
|
|
573
|
+
}
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
// Page dropdown toggle (docs pages)
|
|
577
|
+
const dropdownToggle = document.getElementById('page-dropdown-toggle');
|
|
578
|
+
const dropdownList = document.getElementById('page-dropdown-list');
|
|
579
|
+
if (dropdownToggle && dropdownList) {
|
|
580
|
+
dropdownToggle.addEventListener('click', () => {
|
|
581
|
+
dropdownList.classList.toggle('page-dropdown__list--open');
|
|
582
|
+
});
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
// Active sidebar link highlighting
|
|
586
|
+
const sidebarLinks = document.querySelectorAll('.nav-sidebar__item');
|
|
587
|
+
const currentPath = window.location.pathname;
|
|
588
|
+
sidebarLinks.forEach((link) => {
|
|
589
|
+
if (link.getAttribute('href') === currentPath || link.getAttribute('href') === currentPath.replace(/\/$/, '')) {
|
|
590
|
+
link.classList.add('nav-sidebar__item--active');
|
|
591
|
+
}
|
|
592
|
+
});
|
|
593
|
+
|
|
594
|
+
// Sidebar section collapse/expand
|
|
595
|
+
const SIDEBAR_STORAGE_KEY = 'docula:sidebar-sections';
|
|
596
|
+
const collapsibleSections = document.querySelectorAll('.nav-sidebar__section--collapsible');
|
|
597
|
+
if (collapsibleSections.length > 0) {
|
|
598
|
+
let storedSectionState = {};
|
|
599
|
+
try {
|
|
600
|
+
storedSectionState = JSON.parse(localStorage.getItem(SIDEBAR_STORAGE_KEY) || '{}');
|
|
601
|
+
} catch (e) { storedSectionState = {}; }
|
|
602
|
+
|
|
603
|
+
const setSectionOpen = (section, toggle, open) => {
|
|
604
|
+
toggle.setAttribute('aria-expanded', open ? 'true' : 'false');
|
|
605
|
+
section.classList.toggle('nav-sidebar__section--collapsed', !open);
|
|
606
|
+
};
|
|
607
|
+
|
|
608
|
+
collapsibleSections.forEach((section, idx) => {
|
|
609
|
+
const toggle = section.querySelector('.nav-sidebar__toggle');
|
|
610
|
+
const list = section.querySelector('.nav-sidebar__list');
|
|
611
|
+
if (!toggle || !list) return;
|
|
612
|
+
const listId = 'nav-sidebar-section-' + idx;
|
|
613
|
+
list.id = listId;
|
|
614
|
+
toggle.setAttribute('aria-controls', listId);
|
|
615
|
+
|
|
616
|
+
const key = 'section-' + idx;
|
|
617
|
+
const hasStored = Object.prototype.hasOwnProperty.call(storedSectionState, key);
|
|
618
|
+
const isOpen = hasStored ? !!storedSectionState[key] : true;
|
|
619
|
+
setSectionOpen(section, toggle, isOpen);
|
|
620
|
+
|
|
621
|
+
toggle.addEventListener('click', () => {
|
|
622
|
+
const next = toggle.getAttribute('aria-expanded') !== 'true';
|
|
623
|
+
setSectionOpen(section, toggle, next);
|
|
624
|
+
storedSectionState[key] = next;
|
|
625
|
+
try {
|
|
626
|
+
localStorage.setItem(SIDEBAR_STORAGE_KEY, JSON.stringify(storedSectionState));
|
|
627
|
+
} catch (e) { /* storage unavailable */ }
|
|
628
|
+
});
|
|
629
|
+
});
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
// Active nav link highlighting (header + mobile). Highlight only the
|
|
633
|
+
// single most-specific link: the one whose path is the longest prefix of
|
|
634
|
+
// the current path. A plain startsWith() check lights up every link whose
|
|
635
|
+
// path merely prefixes the current one, so when the site is embedded under
|
|
636
|
+
// a base path (e.g. served at /developer with docs at that root) the
|
|
637
|
+
// Documentation link — whose path is a prefix of every page — would stay
|
|
638
|
+
// highlighted everywhere. Trailing slashes are normalized so matches stop
|
|
639
|
+
// at a path boundary. We read the anchor's resolved origin/pathname so
|
|
640
|
+
// absolute, relative, and same-origin hrefs all work, while cross-origin
|
|
641
|
+
// links and non-anchor items (e.g. the mobile logout button) are skipped.
|
|
642
|
+
const withTrailingSlash = (p) => (p.endsWith('/') ? p : p + '/');
|
|
643
|
+
const here = withTrailingSlash(currentPath);
|
|
644
|
+
const markActiveNav = (selector, activeClass) => {
|
|
645
|
+
let bestLink = null;
|
|
646
|
+
let bestLength = -1;
|
|
647
|
+
document.querySelectorAll(selector).forEach((link) => {
|
|
648
|
+
// Only same-origin anchors can match the current pathname.
|
|
649
|
+
if (!link.href || link.origin !== window.location.origin) return;
|
|
650
|
+
const base = withTrailingSlash(link.pathname);
|
|
651
|
+
if (here.startsWith(base) && base.length > bestLength) {
|
|
652
|
+
bestLink = link;
|
|
653
|
+
bestLength = base.length;
|
|
654
|
+
}
|
|
655
|
+
});
|
|
656
|
+
if (bestLink) bestLink.classList.add(activeClass);
|
|
657
|
+
};
|
|
658
|
+
markActiveNav('.header-bottom__item', 'header-bottom__item--active');
|
|
659
|
+
markActiveNav('.mobile-nav__item', 'mobile-nav__item--active');
|
|
660
|
+
|
|
661
|
+
// TOC extraction: move the inline TOC into the right sidebar and hide the original
|
|
662
|
+
const tocHeading = document.getElementById('table-of-contents');
|
|
663
|
+
if (tocHeading) {
|
|
664
|
+
const tocList = tocHeading.nextElementSibling;
|
|
665
|
+
const tocTarget = document.getElementById('toc-list');
|
|
666
|
+
if (tocList && tocList.tagName === 'UL' && tocTarget) {
|
|
667
|
+
tocTarget.innerHTML = tocList.innerHTML;
|
|
668
|
+
tocHeading.style.display = 'none';
|
|
669
|
+
tocList.style.display = 'none';
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
// Hide the TOC aside if it has no entries
|
|
674
|
+
const tocSidebar = document.getElementById('toc-list');
|
|
675
|
+
if (tocSidebar && tocSidebar.children.length === 0) {
|
|
676
|
+
const aside = tocSidebar.closest('.content-aside');
|
|
677
|
+
if (aside) { aside.style.display = 'none'; }
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
// Image lightbox
|
|
681
|
+
const lightboxOverlay = document.createElement('div');
|
|
682
|
+
lightboxOverlay.className = 'lightbox-overlay';
|
|
683
|
+
lightboxOverlay.addEventListener('click', function(e) {
|
|
684
|
+
if (e.target !== lightboxImg) lightboxOverlay.classList.remove('lightbox-overlay--visible');
|
|
685
|
+
});
|
|
686
|
+
const lightboxClose = document.createElement('button');
|
|
687
|
+
lightboxClose.className = 'lightbox-close';
|
|
688
|
+
lightboxClose.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/></svg>';
|
|
689
|
+
lightboxClose.addEventListener('click', function() {
|
|
690
|
+
lightboxOverlay.classList.remove('lightbox-overlay--visible');
|
|
691
|
+
});
|
|
692
|
+
const lightboxImg = document.createElement('img');
|
|
693
|
+
lightboxOverlay.appendChild(lightboxClose);
|
|
694
|
+
lightboxOverlay.appendChild(lightboxImg);
|
|
695
|
+
document.body.appendChild(lightboxOverlay);
|
|
696
|
+
|
|
697
|
+
document.querySelectorAll('.article__main img, .changelog-entry-body img').forEach(function(img) {
|
|
698
|
+
if (img.closest('a')) return;
|
|
699
|
+
img.addEventListener('click', function() {
|
|
700
|
+
lightboxImg.src = img.src;
|
|
701
|
+
lightboxOverlay.classList.add('lightbox-overlay--visible');
|
|
702
|
+
});
|
|
703
|
+
});
|
|
704
|
+
});
|
|
705
|
+
</script>
|
|
706
|
+
</body>
|
|
707
|
+
|
|
708
|
+
</html>
|