Markdown SourceGFM Spec
2051 chars•265 words•78 lines
UTF-8 Local Only
Clean Compiled HTML10.9 KB
HTML CODE
<h1 id="cloudflare-edge-worker-api"><a href="#cloudflare-edge-worker-api" class="heading-anchor" aria-label="Link to Cloudflare Edge Worker API 🚀">#</a> Cloudflare Edge Worker API 🚀</h1>
<blockquote>High-throughput, client-side verified API documentation for distributed serverless workers.</blockquote>
<p><a href="#" target="_blank" rel="noopener noreferrer" class="markdown-link"><img src="https://img.shields.io/badge/Status-Operational-emerald" alt="Status" loading="lazy" class="markdown-image" /></a> <a href="#" target="_blank" rel="noopener noreferrer" class="markdown-link"><img src="https://img.shields.io/badge/API-v2.4.0-blue" alt="Version" loading="lazy" class="markdown-image" /></a> <a href="#" target="_blank" rel="noopener noreferrer" class="markdown-link"><img src="https://img.shields.io/badge/P99-<15ms-purple" alt="Latency" loading="lazy" class="markdown-image" /></a></p>
<hr class="markdown-divider" />
<h2 id="endpoint-specifications"><a href="#endpoint-specifications" class="heading-anchor" aria-label="Link to 📋 Endpoint Specifications">#</a> 📋 Endpoint Specifications</h2>
<div class="table-container overflow-x-auto my-4 rounded-xl border border-zinc-800 shadow-md">
<table class="min-w-full divide-y divide-zinc-800 border-collapse">
<thead class="bg-zinc-900/90 text-zinc-200 border-b border-zinc-800 text-xs font-semibold uppercase tracking-wider">
<tr>
<th class="px-4 py-3 text-left border-r last:border-r-0 border-zinc-800">Method</th>
<th class="px-4 py-3 text-left border-r last:border-r-0 border-zinc-800">Endpoint</th>
<th class="px-4 py-3 text-left border-r last:border-r-0 border-zinc-800">Description</th>
<th class="px-4 py-3 text-center border-r last:border-r-0 border-zinc-800">Auth Required</th>
<th class="px-4 py-3 text-right border-r last:border-r-0 border-zinc-800">Rate Limit</th>
</tr>
</thead>
<tbody class="divide-y divide-zinc-800/60 text-sm text-zinc-300">
<tr class="bg-zinc-950/40 hover:bg-zinc-800/40 transition">
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">GET</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">/v2/workers</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60">List active worker deployments</td>
<td class="px-4 py-2.5 text-center border-r last:border-r-0 border-zinc-800/60">Bearer Token</td>
<td class="px-4 py-2.5 text-right border-r last:border-r-0 border-zinc-800/60">1,000 / min</td>
</tr>
<tr class="bg-zinc-900/20 hover:bg-zinc-800/40 transition">
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">POST</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">/v2/compile</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60">Live Markdown to HTML compilation</td>
<td class="px-4 py-2.5 text-center border-r last:border-r-0 border-zinc-800/60">None (Local)</td>
<td class="px-4 py-2.5 text-right border-r last:border-r-0 border-zinc-800/60">Unlimited</td>
</tr>
<tr class="bg-zinc-950/40 hover:bg-zinc-800/40 transition">
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">PUT</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">/v2/cache/keys</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60">Set edge distributed KV values</td>
<td class="px-4 py-2.5 text-center border-r last:border-r-0 border-zinc-800/60">Bearer Token</td>
<td class="px-4 py-2.5 text-right border-r last:border-r-0 border-zinc-800/60">500 / min</td>
</tr>
<tr class="bg-zinc-900/20 hover:bg-zinc-800/40 transition">
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">DELETE</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60"><code class="inline-code">/v2/cache/purge</code></td>
<td class="px-4 py-2.5 text-left border-r last:border-r-0 border-zinc-800/60">Invalidate global CDN edge cache</td>
<td class="px-4 py-2.5 text-center border-r last:border-r-0 border-zinc-800/60">Admin Secret</td>
<td class="px-4 py-2.5 text-right border-r last:border-r-0 border-zinc-800/60">100 / min</td>
</tr>
</tbody>
</table>
</div>
<div class="markdown-alert alert-note">
<p class="markdown-alert-title">Note</p>
<div class="markdown-alert-body">All compilations happen <strong>strictly inside your local browser sandbox</strong>. Zero packets are dispatched to external infrastructure.</div>
</div>
<div class="markdown-alert alert-tip">
<p class="markdown-alert-title">Tip</p>
<div class="markdown-alert-body">Use HTTP/2 or HTTP/3 multiplexing for optimal concurrent stream throughput.</div>
</div>
<hr class="markdown-divider" />
<h2 id="client-request-example-typescript"><a href="#client-request-example-typescript" class="heading-anchor" aria-label="Link to ⚡ Client Request Example (TypeScript)">#</a> ⚡ Client Request Example (TypeScript)</h2>
<pre class="code-block language-typescript"><code class="code-inner language-typescript"><span class="token keyword">import</span> <span class="token punctuation">{</span> createClient <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">"@toolsaa/compiler"</span><span class="token punctuation">;</span>
<span class="token keyword">interface</span> CompileResponse <span class="token punctuation">{</span>
html<span class="token operator">:</span> string<span class="token punctuation">;</span>
tokens<span class="token operator">:</span> number<span class="token punctuation">;</span>
durationMs<span class="token operator">:</span> number<span class="token punctuation">;</span>
<span class="token punctuation">}</span>
<span class="token keyword">export</span> <span class="token keyword">async</span> <span class="token keyword">function</span> <span class="token function">compileMarkdown</span><span class="token punctuation">(</span>source<span class="token operator">:</span> string<span class="token punctuation">)</span><span class="token operator">:</span> <span class="token class-name">Promise</span><span class="token operator"><</span>CompileResponse<span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token keyword">const</span> startTime <span class="token operator">=</span> performance<span class="token operator">.</span><span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// 100% In-Browser Pure Client-Side compilation</span>
<span class="token keyword">const</span> html <span class="token operator">=</span> <span class="token keyword">await</span> clientCompiler<span class="token operator">.</span><span class="token function">render</span><span class="token punctuation">(</span>source<span class="token punctuation">,</span> <span class="token punctuation">{</span>
prismHighlight<span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
sanitize<span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">return</span> <span class="token punctuation">{</span>
html<span class="token punctuation">,</span>
tokens<span class="token operator">:</span> source<span class="token operator">.</span>length<span class="token punctuation">,</span>
durationMs<span class="token operator">:</span> <span class="token class-name">Math</span><span class="token operator">.</span><span class="token function">round</span><span class="token punctuation">(</span>performance<span class="token operator">.</span><span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">-</span> startTime<span class="token punctuation">)</span><span class="token punctuation">,</span>
<span class="token punctuation">}</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span></code></pre>
<h2 id="json-response-payload"><a href="#json-response-payload" class="heading-anchor" aria-label="Link to 📦 JSON Response Payload">#</a> 📦 JSON Response Payload</h2>
<pre class="code-block language-json"><code class="code-inner language-json"><span class="token punctuation">{</span>
<span class="token property">"status"</span><span class="token punctuation">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span>
<span class="token property">"data"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
<span class="token property">"version"</span><span class="token punctuation">:</span> <span class="token string">"2.4.0"</span><span class="token punctuation">,</span>
<span class="token property">"cached"</span><span class="token punctuation">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
<span class="token property">"metrics"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
<span class="token property">"executionTimeMs"</span><span class="token punctuation">:</span> <span class="token number">0.42</span><span class="token punctuation">,</span>
<span class="token property">"memoryUsageMb"</span><span class="token punctuation">:</span> <span class="token number">1.2</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span></code></pre>
<h2 id="feature-checklist"><a href="#feature-checklist" class="heading-anchor" aria-label="Link to ✅ Feature Checklist">#</a> ✅ Feature Checklist</h2>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" disabled checked /><span class="task-done">100% Client-Side Privacy Architecture</span></li>
<li class="task-list-item"><input type="checkbox" disabled checked /><span class="task-done">GitHub Flavored Markdown (GFM) Tables</span></li>
<li class="task-list-item"><input type="checkbox" disabled checked /><span class="task-done">Prism.js Code Syntax Highlighting</span></li>
<li class="task-list-item"><input type="checkbox" disabled /><span>Automated Webhook Dispatcher</span></li>
</ul>RENDERED PREVIEWLive Sync
# Cloudflare Edge Worker API 🚀
High-throughput, client-side verified API documentation for distributed serverless workers.
# 📋 Endpoint Specifications
| Method | Endpoint | Description | Auth Required | Rate Limit |
|---|---|---|---|---|
GET |
/v2/workers |
List active worker deployments | Bearer Token | 1,000 / min |
POST |
/v2/compile |
Live Markdown to HTML compilation | None (Local) | Unlimited |
PUT |
/v2/cache/keys |
Set edge distributed KV values | Bearer Token | 500 / min |
DELETE |
/v2/cache/purge |
Invalidate global CDN edge cache | Admin Secret | 100 / min |
Note
All compilations happen strictly inside your local browser sandbox. Zero packets are dispatched to external infrastructure.
Tip
Use HTTP/2 or HTTP/3 multiplexing for optimal concurrent stream throughput.
# ⚡ Client Request Example (TypeScript)
import { createClient } from "@toolsaa/compiler";
interface CompileResponse {
html: string;
tokens: number;
durationMs: number;
}
export async function compileMarkdown(source: string): Promise<CompileResponse> {
const startTime = performance.now();
// 100% In-Browser Pure Client-Side compilation
const html = await clientCompiler.render(source, {
prismHighlight: true,
sanitize: true,
});
return {
html,
tokens: source.length,
durationMs: Math.round(performance.now() - startTime),
};
}
# 📦 JSON Response Payload
{
"status": "success",
"data": {
"version": "2.4.0",
"cached": false,
"metrics": {
"executionTimeMs": 0.42,
"memoryUsageMb": 1.2
}
}
}
# ✅ Feature Checklist
- 100% Client-Side Privacy Architecture
- GitHub Flavored Markdown (GFM) Tables
- Prism.js Code Syntax Highlighting
- Automated Webhook Dispatcher
Headings: 5•Tables: 1•Code Blocks: 2
Ready to Export