-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
306 lines (301 loc) · 15.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html>
<html lang="en" data-accent-color="amber" data-content_root="">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Litestar Framework</title><link rel="shortcut icon" href="_static/favicon.svg"/><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Usage" href="usage/index.html" /><script>
function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
setColorMode(localStorage._theme||"auto");
</script><link rel="stylesheet" type="text/css" href="_static/pygments.css?v=397bb51e" />
<link rel="stylesheet" type="text/css" href="_static/shibuya.css?v=36d120a7" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="_static/sphinx_paramlinks.css" />
<link media="print" rel="stylesheet" type="text/css" href="_static/print.css?v=20ff2c19" />
<link rel="stylesheet" type="text/css" href="_static/style.css" />
<link rel="stylesheet" type="text/css" href="_static/litestar-sphinx-theme.css?v=9989272a" />
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
<style>
:root {
--sy-f-text: "Inter", var(--sy-f-sys), var(--sy-f-cjk), sans-serif;
--sy-f-heading: "Inter", var(--sy-f-sys), var(--sy-f-cjk), sans-serif;
}
</style>
<meta property="og:type" content="website"/><meta property="og:title" content="Type Lens"/>
<meta name="twitter:card" content="summary"/>
<meta property="og:image" content="_static/logo-light.png"/>
</head>
<body><div class="sy-head">
<div class="sy-head-blur"></div>
<div class="sy-head-inner sy-container mx-auto">
<a class="sy-head-brand" href="/">
<img class="light-logo" src="_static/logo-light.png" alt="type-lens" height="28" loading="lazy" />
<img class="dark-logo" src="_static/logo-dark.png" alt="type-lens" height="28" loading="lazy" />
<strong>type-lens</strong>
</a>
<div class="sy-head-nav" id="HeadNav">
<nav class="sy-head-links"><ul><li class="link"><a href="#">Home</a></li>
<li class="link"><button type="button">
<span>Community</span>
<i class="i-lucide chevron-down"></i>
</button>
<ul><li><a href="contribution-guide.html">
<span>Contributing</span>
<small>Learn how to contribute to the Type Lens project</small>
</a></li><li><a href="https://github.com/litestar-org/.github?tab=coc-ov-file">
<span>Code of Conduct</span>
<small>Review the etiquette for interacting with the Litestar community</small>
</a></li><li><a href="https://github.com/litestar-org/.github?tab=coc-ov-file#security-ov-file">
<span>Security</span>
<small>Overview of Litestar's security protocols</small>
</a></li></ul>
</li>
<li class="link"><button type="button">
<span>About</span>
<i class="i-lucide chevron-down"></i>
</button>
<ul><li><a href="https://litestar.dev/about/organization">
<span>Litestar Organization</span>
<small>Details about the Litestar organization</small>
</a></li><li><a href="releases.html">
<span>Releases</span>
<small>Explore the release process, versioning, and deprecation policy for Litestar</small>
</a></li></ul>
</li>
<li class="link"><button type="button">
<span>Release notes</span>
<i class="i-lucide chevron-down"></i>
</button>
<ul><li><a href="changelog.html">
<span>1.x Changelog</span>
<small>All changes in the 1.x series</small>
</a></li></ul>
</li>
<li class="link"><button type="button">
<span>Help</span>
<i class="i-lucide chevron-down"></i>
</button>
<ul><li><a href="https://discord.gg/litestar">
<span>Discord Help Forum</span>
<small>Dedicated Discord help forum</small>
</a></li><li><a href="https://github.com/litestar-org/type-lens/discussions">
<span>GitHub Discussions</span>
<small>GitHub Discussions</small>
</a></li><li><a href="https://stackoverflow.com/questions/tagged/litestar">
<span>Stack Overflow</span>
<small>We monitor the <code><b>litestar</b></code> tag on Stack Overflow</small>
</a></li></ul>
</li><li class="link">
<a href="https://github.com/sponsors/Litestar-Org">
<span>Sponsor</span></a>
</li></ul></nav>
<div class="sy-head-extra flex items-center print:hidden"><form class="searchbox flex items-center" action="search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<kbd>/</kbd>
</form><div class="nav-versions">
<button type="button" aria-label="Versions">
<span class="md:hidden">Versions</span>
<span class="hidden md:inline">latest</span>
<i class="i-lucide chevron-down"></i>
</button>
<div class="nav-versions-choices"><ul><li><a href="/latest">latest</a></li><li><a href="/main">development</a></li></ul></div>
</div><div class="sy-head-socials">
<a href="https://twitter.com/LitestarAPI" aria-label="X (Twitter)">
<iconify-icon icon="prime:twitter"></iconify-icon>
</a>
<a href="https://discord.gg/litestar" aria-label="Discord">
<iconify-icon icon="simple-icons:discord"></iconify-icon>
</a></div></div>
</div>
<div class="sy-head-actions flex items-center shrink-0 print:hidden"><button class="js-theme theme-switch flex items-center"
data-aria-auto="Switch to light color mode"
data-aria-light="Switch to dark color mode"
data-aria-dark="Switch to auto color mode">
<i class="i-lucide theme-icon"></i>
</button><button class="md:hidden flex items-center js-menu" aria-label="Menu" type="button" aria-controls="HeadNav" aria-expanded="false">
<div class="hamburger">
<span class="hamburger_1"></span>
<span class="hamburger_2 -translate-x-2"></span>
<span class="hamburger_3 -translate-x-1"></span>
</div>
</button>
</div>
</div>
</div>
<div class="sy-page sy-container flex mx-auto">
<aside id="lside" class="sy-lside md:w-72 md:shrink-0 print:hidden">
<div class="sy-lside-inner md:sticky">
<div class="sy-scrollbar p-6"><div class="sidebar-links">
<ul>
<li><a class="icon-link" href="https://github.com/orgs/litestar-org/discussions">
<span class="icon">
<svg viewBox="0 0 24 24" fill="none">
<path fill="var(--accent-9)" fill-rule="evenodd" clip-rule="evenodd" d="M11 5a6 6 0 0 0-4.687 9.746c.215.27.315.62.231.954l-.514 2.058a1 1 0 0 0 1.485 1.1l2.848-1.71c.174-.104.374-.15.576-.148H13a6 6 0 0 0 0-12h-2Z"/>
<circle fill="white" cx="12" cy="11" r="1"/>
<circle fill="white" cx="9" cy="11" r="1"/>
<circle fill="white" cx="15" cy="11" r="1"/>
</svg>
</span>
<span class="text">Discussion</span>
</a></li>
</ul>
</div>
<div class="globaltoc" data-expand-depth="0"><p class="caption" role="heading" aria-level="3"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage/placeholder.html">Placeholder</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">API Reference</a><ul class="simple">
</ul>
</li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution-guide.html">Contribution guide</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+repo%3A%22type-lens%22&type=issues">Available Issues</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/litestar-org/.github?tab=coc-ov-file#readme">Code of Conduct</a></li>
</ul>
</div>
</div></div>
</aside>
<div class="lside-overlay js-menu" role="button" aria-label="Close left sidebar" aria-controls="lside" aria-expanded="false"></div>
<aside id="rside" class="sy-rside pb-3 w-64 shrink-0 order-last">
<button class="rside-close js-menu xl:hidden" aria-label="Close Table of Contents" type="button" aria-controls="rside" aria-expanded="false">
<i class="i-lucide close"></i>
</button>
<div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><div class="localtoc"><h3>On this page</h3><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#purpose">Purpose</a><ul>
</ul>
</li>
</ul>
</div><a class="js-repo-stats repo-stats flex items-center" href="https://github.com/litestar-org/type-lens"
data-type="github" data-user="litestar-org" data-repo="type-lens">
<span class="w-8 flex items-center justify-around shrink-0 text-3xl">
<iconify-icon icon="simple-icons:github"></iconify-icon>
</span>
<span class="flex-grow px-2 break-all">
<span>litestar-org/type-lens</span>
<span class="flex text-sm repo-stats-count">
<span class="flex items-center pr-3">
<iconify-icon icon="lucide:star"></iconify-icon>
<strong class="js-repo-stars ml-1">0</strong>
</span>
<span class="flex items-center">
<iconify-icon icon="lucide:git-fork"></iconify-icon>
<strong class="js-repo-forks ml-1">0</strong>
</span>
</span>
</span>
</a><div class="edit-this-page">
<a href="https://github.com/litestar-org/type-lens/blob/master/docs/index.rst">Edit this page</a>
</div><div id="ethical-ad-placement" data-ea-publisher="readthedocs"></div></div>
</aside>
<div class="rside-overlay js-menu" role="button" aria-label="Close Table of Contents" aria-controls="rside" aria-expanded="false"></div>
<main class="sy-main w-full max-sm:max-w-full print:pt-6"><div class="sy-breadcrumbs" role="navigation">
<div class="sy-breadcrumbs-inner flex items-center">
<div class="md:hidden mr-3">
<button class="js-menu" aria-label="Menu" type="button" aria-controls="lside" aria-expanded="false">
<i class="i-lucide menu"></i>
</button>
</div>
<ol class="flex-1" itemscope itemtype="https://schema.org/BreadcrumbList"><li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
<a itemprop="item" href="#"><span itemprop="name">type-lens</span></a>
<span>/</span>
<meta itemprop="position" content="1" />
</li><li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
<strong itemprop="name">Type Lens</strong>
<meta itemprop="position" content="2" />
</li></ol>
<div class="xl:hidden ml-1">
<button class="js-menu" aria-label="Show table of contents" type="button" aria-controls="rside"
aria-expanded="false">
<i class="i-lucide outdent"></i>
</button>
</div>
</div>
</div><div class="flex flex-col break-words justify-between">
<div class="min-w-0 max-w-6xl px-6 pb-6 pt-8 xl:px-12">
<article class="yue" role="main">
<section id="type-lens">
<h1>Type Lens<a class="headerlink" href="#type-lens" title="Permalink to this heading">¶</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Pre-Release Alpha Stage</p>
<p>Please note that <code class="docutils literal notranslate"><span class="pre">type-lens</span></code> is currently in a pre-release alpha stage of development. This means the library is still
under active development, and its API is subject to change. We encourage developers to experiment with <code class="docutils literal notranslate"><span class="pre">type-lens</span></code> and
provide feedback, but we recommend against using it in production environments until a stable release is available.</p>
<p>Please see <a class="reference internal" href="releases.html"><span class="doc">Type Lens Releases</span></a> for more information on the stability policy.</p>
</div>
<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">type-lens</span></code> library is cool.</p>
</section>
<section id="purpose">
<h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">type-lens</span></code> is built to do stuff.</p>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</section>
</section>
</article><button class="back-to-top" type="button">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</button><div class="navigation flex print:hidden"><div class="navigation-next">
<a href="usage/index.html">
<div class="page-info">
<span>Next</span>
<div class="title">Usage</div>
</div>
<i class="i-lucide chevron-right"></i>
</a>
</div></div></div>
</div>
</main>
</div>
<footer class="sy-foot">
<div class="sy-foot-inner sy-container mx-auto">
<div class="sy-foot-reserved md:flex justify-between items-center">
<div class="sy-foot-copyright"><p>2024, Litestar Organization</p>
<p>
Made with
<a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a href="https://shibuya.lepture.com">Shibuya theme</a>.
</p>
</div>
<div class="sy-foot-socials">
<a href="https://twitter.com/LitestarAPI" aria-label="X (Twitter)">
<iconify-icon icon="prime:twitter"></iconify-icon>
</a>
<a href="https://discord.gg/litestar" aria-label="Discord">
<iconify-icon icon="simple-icons:discord"></iconify-icon>
</a>
<a href="https://www.reddit.com/r/LitestarAPI" aria-label="Reddit">
<iconify-icon icon="simple-icons:reddit"></iconify-icon>
</a></div>
</div>
</div>
</footer>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2c5cfeb5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/litestar-theme.js?v=ab2dcc9e"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js?v=4a39c7ea"></script>
<script src="_static/design-tabs.js?v=36754332"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="_static/shibuya.js?v=c5fc9e80"></script>
<script src="_static/versioning.js"></script></body>
</html>