1<!DOCTYPE html> 2<html lang="en-US"> 3 <head> 4 <meta charset="UTF-8"> 5 <title>pkl (0.32.1) ⢠Packages</title> 6
6<script src="../../scripts/pkldoc.js" defer="defer"></script>
6 7
7<script type="module"> 8 import perPackageData from "../../data/pkl/_/index.json" with { type: "json" } 9 import perPackageVersionData from "../../data/pkl/0.32.1/index.json" with { type: "json" } 10 11 runtimeData.knownVersions(perPackageData.knownVersions, "0.32.1"); 12 runtimeData.knownUsagesOrSubtypes("known-subtypes", perPackageVersionData.knownSubtypes); 13 runtimeData.knownUsagesOrSubtypes("known-usages", perPackageVersionData.knownUsages); 14 </script>
14 15
15<script src="../../scripts/scroll-into-view.min.js" defer="defer"></script>
15 16 <link href="../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet"> 17 <link rel="icon" type="image/svg+xml" href="../../images/favicon.svg"> 18 <link rel="apple-touch-icon" sizes="180x180" href="../../images/apple-touch-icon.png"> 19 <link rel="icon" type="image/png" sizes="32x32" href="../../images/favicon-32x32.png"> 20 <link rel="icon" type="image/png" sizes="16x16" href="../../images/favicon-16x16.png"> 21 </head> 22 <body onload="onLoad()"> 23 <header> 24 <div id="doc-title"><a href="../../index.html">Packages</a></div> 25 <div id="search"><label for="search-input"><i id="search-icon" class="material-icons">search</i></label><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="pkl" data-package-version="0.32.1" data-package-url-prefix="" data-root-url-prefix="../../"></div> 26 </header> 27 <main><a class="declaration-parent-link" href="../../index.html">Packages</a> 28 <h1 id="declaration-title">pkl<span id="declaration-version">0.32.1</span></h1> 29 <ul class="member-group-links"> 30 <li><a href="#_overview">Overview</a></li> 31 <li><a href="#_modules">Modules</a></li> 32 </ul> 33 <div id="_overview" class="anchor"> </div> 34 <div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i> 35 <div class="member-signature">package <span class="name-decl">pkl</span></div> 36 <div class="doc-comment"><p>The Pkl standard library.</p></div> 37 <dl class="member-info"> 38 <dt class="">Pkl version:</dt> 39 <dd>0.32.1 or higher</dd> 40 <dt class="">Authors:</dt> 41 <dd>[email protected]</dd> 42 <dt class="">Version:</dt> 43 <dd>0.32.1</dd> 44 <dt class="">Source code:</dt> 45 <dd><a href="https://github.com/apple/pkl/blob/0.32.1/stdlib/">https://github.com/apple/pkl/blob/0.32.1/stdlib/</a></dd> 46 <dt class="">Issue tracker:</dt> 47 <dd><a href="https://github.com/apple/pkl/issues">https://github.com/apple/pkl/issues</a></dd> 48 <dt class="runtime-data hidden">Known usages:</dt> 49 <dd id="known-usages" class="runtime-data hidden"></dd> 50 <dt class="runtime-data hidden">All versions:</dt> 51 <dd id="known-versions" class="runtime-data hidden"></dd> 52 </dl> 53 <div class="doc-comment expandable hidden collapsed"><p>The standard library is a set of Pkl modules versioned and distributed together with the language.</p> 54<p>To import a standard library module, use <code>import "pkl:<identifier>"</code>. 55For example, <code>import "pkl:json"</code> imports the <code>pkl.json</code> module.</p> 56<p>The <code>pkl.base</code> module defines the most fundamental properties, methods, and classes for using Pkl. 57Its members are automatically available in every module and hence it does not need to be imported.</p> 58<p>The default module allowlist (<code>--allowed-modules</code>) grants access to all standard library modules.</p></div> 59 </div> 60 <div class="member-group"> 61 <div id="_modules" class="anchor"> </div> 62 <h2 class="member-group-title">Modules</h2> 63 <ul> 64 <li> 65 <div id="pkl.analyze" class="anchor"> </div> 66 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.analyze">link</a> 67 <div class="member-left"> 68 <div class="member-modifiers">module </div> 69 </div> 70 <div class="member-main"> 71 <div class="member-signature"><a class="name-decl" href="./analyze/index.html">pkl.analyze</a></div> 72 <div class="doc-comment"><p>A library for statically analyzing Pkl modules.</p></div> 73 </div> 74 </div> 75 </li> 76 <li> 77 <div id="pkl.base" class="anchor"> </div> 78 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.base">link</a> 79 <div class="member-left"> 80 <div class="member-modifiers">module </div> 81 </div> 82 <div class="member-main"> 83 <div class="member-signature"><a class="name-decl" href="./base/index.html">pkl.base</a></div> 84 <div class="doc-comment"><p>Fundamental properties, methods, and classes for writing Pkl programs.</p></div> 85 </div> 86 </div> 87 </li> 88 <li> 89 <div id="pkl.Benchmark" class="anchor"> </div> 90 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.Benchmark">link</a> 91 <div class="member-left"> 92 <div class="member-modifiers">module </div> 93 </div> 94 <div class="member-main"> 95 <div class="member-signature"><a class="name-decl" href="./Benchmark/index.html">pkl.Benchmark</a></div> 96 <div class="doc-comment"><p>A template for writing and running benchmarks.</p></div> 97 </div> 98 </div> 99 </li> 100 <li> 101 <div id="pkl.Command" class="anchor"> </div> 102 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.Command">link</a> 103 <div class="member-left"> 104 <div class="member-modifiers">module </div> 105 </div> 106 <div class="member-main"> 107 <div class="member-signature"><a class="name-decl" href="./Command/index.html">pkl.Command</a></div> 108 <div class="doc-comment"><p>
108Defines inputs and outputs for CLI commands implemented in Pkl.</p></div> 109 </div> 110 </div> 111 </li> 112 <li> 113 <div id="pkl.DocPackageInfo" class="anchor"> </div> 114 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.DocPackageInfo">link</a> 115 <div class="member-left"> 116 <div class="member-modifiers">module </div> 117 </div> 118 <div class="member-main"> 119 <div class="member-signature"><a class="name-decl" href="./DocPackageInfo/index.html">pkl.DocPackageInfo</a></div> 120 <div class="doc-comment"><p>Template for <em>doc-package-info.pkl</em>, the descriptor for a package.</p></div> 121 </div> 122 </div> 123 </li> 124 <li> 125 <div id="pkl.DocsiteInfo" class="anchor"> </div> 126 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.DocsiteInfo">link</a> 127 <div class="member-left"> 128 <div class="member-modifiers">module </div> 129 </div> 130 <div class="member-main"> 131 <div class="member-signature"><a class="name-decl" href="./DocsiteInfo/index.html">pkl.DocsiteInfo</a></div> 132 <div class="doc-comment"><p>Template for <em>docsite-info.pkl</em>, the descriptor for a Pkldoc website.</p></div> 133 </div> 134 </div> 135 </li> 136 <li> 137 <div id="pkl.EvaluatorSettings" class="anchor"> </div> 138 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.EvaluatorSettings">link</a> 139 <div class="member-left"> 140 <div class="member-modifiers">module </div> 141 </div> 142 <div class="member-main"> 143 <div class="member-signature"><a class="name-decl" href="./EvaluatorSettings/index.html">pkl.EvaluatorSettings</a></div> 144 <div class="doc-comment"><p>Common settings for Pkl's own evaluator.</p></div> 145 </div> 146 </div> 147 </li> 148 <li> 149 <div id="pkl.json" class="anchor"> </div> 150 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.json">link</a> 151 <div class="member-left"> 152 <div class="member-modifiers">module </div> 153 </div> 154 <div class="member-main"> 155 <div class="member-signature"><a class="name-decl" href="./json/index.html">pkl.json</a></div> 156 <div class="doc-comment"><p>A JSON parser.</p></div> 157 </div> 158 </div> 159 </li> 160 <li> 161 <div id="pkl.jsonnet" class="anchor"> </div> 162 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.jsonnet">link</a> 163 <div class="member-left"> 164 <div class="member-modifiers">module </div> 165 </div> 166 <div class="member-main"> 167 <div class="member-signature"><a class="name-decl" href="./jsonnet/index.html">pkl.jsonnet</a></div> 168 <div class="doc-comment"><p>A <a href="https://jsonnet.org">Jsonnet</a> renderer.</p></div> 169 </div> 170 </div> 171 </li> 172 <li> 173 <div id="pkl.math" class="anchor"> </div> 174 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.math">link</a> 175 <div class="member-left"> 176 <div class="member-modifiers">module </div> 177 </div> 178 <div class="member-main"> 179 <div class="member-signature"><a class="name-decl" href="./math/index.html">pkl.math</a></div> 180 <div class="doc-comment"><p>Basic mathematical constants and functions.</p></div> 181 </div> 182 </div> 183 </li> 184 <li> 185 <div id="pkl.pklbinary" class="anchor"> </div> 186 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.pklbinary">link</a> 187 <div class="member-left"> 188 <div class="member-modifiers">module </div> 189 </div> 190 <div class="member-main"> 191 <div class="member-signature"><a class="name-decl" href="./pklbinary/index.html">pkl.pklbinary</a></div> 192 <div class="doc-comment"><p>APIs for working with <code>pkl-binary</code> encoding.</p></div> 193 </div> 194 </div> 195 </li> 196 <li> 197 <div id="pkl.platform" class="anchor"> </div> 198 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.platform">link</a> 199 <div class="member-left"> 200 <div class="member-modifiers">module </div> 201 </div> 202 <div class="member-main"> 203 <div class="member-signature"><a class="name-decl" href="./platform/index.html">pkl.platform</a></div> 204 <div class="doc-comment"><p>Information about the platform that the current program runs on.</p></div> 205 </div> 206 </div> 207 </li> 208 <li> 209 <div id="pkl.Project" class="anchor"> </div> 210 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.Project">link</a> 211 <div class="member-left"> 212 <div class="member-modifiers">module </div> 213 </div> 214 <div class="member-main"> 215 <div class="member-signature"><a class="name-decl" href="./Project/index.html">pkl.Project</a></div> 216 <div class="doc-comment"><p>A manifest that defines the presence of a project.</p></div> 217 </div> 218 </div> 219 </li> 220 <li> 221 <div id="pkl.protobuf" class="anchor"> </div> 222 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.protobuf">link</a> 223 <div class="member-left"> 224 <div class="member-modifiers">module </div> 225 </div> 226 <div class="member-main"> 227 <div class="member-signature"><a class="name-decl" href="./protobuf/index.html">pkl.protobuf</a></div> 228 <div class="doc-comment"><p>A renderer for <a href="https://developers.google.com/protocol-buffers">Protocol Buffers</a>. 229Note: This module is <em>experimental</em> and not ready for production use.</p></div> 230 </div> 231 </div> 232 </li> 233 <li> 234 <div id="pkl.ref" class="anchor"> </div> 235 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.ref">link</a> 236 <div class="member-left"> 237 <div class="member-modifiers">module </div> 238 </div> 239 <div class="member-main"> 240 <div class="member-signature"><a class="name-decl" href="./ref/index.html">pkl.ref</a></div> 241 <div class="doc-comment"><p>
241Type-safe deferred references to values not known at evaluation time.</p></div> 242 </div> 243 </div> 244 </li> 245 <li> 246 <div id="pkl.reflect" class="anchor"> </div> 247 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.reflect">link</a> 248 <div class="member-left"> 249 <div class="member-modifiers">module </div> 250 </div> 251 <div class="member-main"> 252 <div class="member-signature"><a class="name-decl" href="./reflect/index.html">pkl.reflect</a></div> 253 <div class="doc-comment"><p>A mirror-based reflection library.</p></div> 254 </div> 255 </div> 256 </li> 257 <li> 258 <div id="pkl.release" class="anchor"> </div> 259 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.release">link</a> 260 <div class="member-left"> 261 <div class="member-modifiers">module </div> 262 </div> 263 <div class="member-main"> 264 <div class="member-signature"><a class="name-decl" href="./release/index.html">pkl.release</a></div> 265 <div class="doc-comment"><p>Information about the Pkl release that the current program runs on.</p></div> 266 </div> 267 </div> 268 </li> 269 <li> 270 <div id="pkl.semver" class="anchor"> </div> 271 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.semver">link</a> 272 <div class="member-left"> 273 <div class="member-modifiers">module </div> 274 </div> 275 <div class="member-main"> 276 <div class="member-signature"><a class="name-decl" href="./semver/index.html">pkl.semver</a></div> 277 <div class="doc-comment"><p>Parsing, comparison, and manipulation of <a href="https://semver.org/spec/v2.0.0.html">semantic version</a> numbers.</p></div> 278 </div> 279 </div> 280 </li> 281 <li> 282 <div id="pkl.settings" class="anchor"> </div> 283 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.settings">link</a> 284 <div class="member-left"> 285 <div class="member-modifiers">module </div> 286 </div> 287 <div class="member-main"> 288 <div class="member-signature"><a class="name-decl" href="./settings/index.html">pkl.settings</a></div> 289 <div class="doc-comment"><p>Configuration settings for Pkl itself.</p></div> 290 </div> 291 </div> 292 </li> 293 <li> 294 <div id="pkl.shell" class="anchor"> </div> 295 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.shell">link</a> 296 <div class="member-left"> 297 <div class="member-modifiers">module </div> 298 </div> 299 <div class="member-main"> 300 <div class="member-signature"><a class="name-decl" href="./shell/index.html">pkl.shell</a></div> 301 <div class="doc-comment"><p>Utilities for generating shell scripts.</p></div> 302 </div> 303 </div> 304 </li> 305 <li> 306 <div id="pkl.test" class="anchor"> </div> 307 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.test">link</a> 308 <div class="member-left"> 309 <div class="member-modifiers">module </div> 310 </div> 311 <div class="member-main"> 312 <div class="member-signature"><a class="name-decl" href="./test/index.html">pkl.test</a></div> 313 <div class="doc-comment"><p>A template for writing tests.</p></div> 314 </div> 315 </div> 316 </li> 317 <li> 318 <div id="pkl.xml" class="anchor"> </div> 319 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.xml">link</a> 320 <div class="member-left"> 321 <div class="member-modifiers">module </div> 322 </div> 323 <div class="member-main"> 324 <div class="member-signature"><a class="name-decl" href="./xml/index.html">pkl.xml</a></div> 325 <div class="doc-comment"><p>An XML renderer.</p></div> 326 </div> 327 </div> 328 </li> 329 <li> 330 <div id="pkl.yaml" class="anchor"> </div> 331 <div class="member with-page-link"><a class="member-selflink material-icons" href="#pkl.yaml">link</a> 332 <div class="member-left"> 333 <div class="member-modifiers">module </div> 334 </div> 335 <div class="member-main"> 336 <div class="member-signature"><a class="name-decl" href="./yaml/index.html">pkl.yaml</a></div> 337 <div class="doc-comment"><p>A YAML 1.2 compliant YAML parser.</p></div> 338 </div> 339 </div> 340 </li> 341 </ul> 342 </div> 343 </main> 344 </body> 345</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.