mirror/ascode
1
1
Fork 0
mirror of https://github.com/mcuadros/ascode synced 2025-02-20 16:41:14 +01:00
Code Issues
gh-pages
ascode/docs/reference/time/index.html

22 lines
10 KiB
HTML
Raw Permalink Blame History

<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>time - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a href=/docs/reference/http/>http</a></li><li><a href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a href=/docs/reference/re/>re</a></li><li><a class=active href=/docs/reference/time/>time</a></li><li><a href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>time</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bdurationb>def <b>duration</b></a></li><li><a href=#def-bfromtimestamptimeb>def <b>fromtimestamptime</b></a></li><li><a href=#def-blocationb>def <b>location</b></a></li><li><a href=#def-bnowb>def <b>now</b></a></li><li><a href=#def-btimeb>def <b>time</b></a></li><li><a href=#def-bzerob>def <b>zero</b></a></li></ul></li><li><a href=#types>Types</a><ul><li><a href=#type-bdurationb>type <b>duration</b></a></li><li><a href=#type-btimeb>type <b>time</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>time defines time primitives for starlark</p><h2 id=functions>Functions</h2><h3 id=def-bdurationb>def <b>duration</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>duration</span><span class=p>(</span><span class=kt>string</span><span class=p>)</span> <span class=nx>duration</span>
</code></pre></div><p>parse a duration</p><h3 id=def-bfromtimestamptimeb>def <b>fromtimestamptime</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>fromtimestamptime</span><span class=p>(</span><span class=kt>int</span><span class=p>)</span> <span class=nx>time</span>
</code></pre></div><p>parse a Unix timestamp</p><h3 id=def-blocationb>def <b>location</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>location</span><span class=p>(</span><span class=kt>string</span><span class=p>)</span> <span class=nx>location</span>
</code></pre></div><p>parse a location</p><h3 id=def-bnowb>def <b>now</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>now</span><span class=p>()</span> <span class=nx>time</span>
</code></pre></div><p>implementations would be able to make this a constant</p><h3 id=def-btimeb>def <b>time</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>time</span><span class=p>(</span><span class=kt>string</span><span class=p>,</span> <span class=nx>format</span><span class=p>=</span><span class=o>...</span><span class=p>,</span> <span class=nx>location</span><span class=p>=</span><span class=o>...</span><span class=p>)</span> <span class=nx>time</span>
</code></pre></div><p>parse a time</p><h3 id=def-bzerob>def <b>zero</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>zero</span><span class=p>()</span> <span class=nx>time</span>
</code></pre></div><p>a constant</p><h2 id=types>Types</h2><h3 id=type-bdurationb>type <b>duration</b></h3><h6 id=properties>Properties</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>hours</code></td><td><code>float</code></td><td></td></tr><tr><td><code>minutes</code></td><td><code>float</code></td><td></td></tr><tr><td><code>nanoseconds</code></td><td><code>int</code></td><td></td></tr><tr><td><code>seconds</code></td><td><code>float</code></td><td></td></tr></tbody></table><h3 id=type-btimeb>type <b>time</b></h3><h6 id=methods>Methods</h6><h4 id=def-itimeibyearb>def <i>time</i>.<b>year</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>year</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibmonthb>def <i>time</i>.<b>month</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>month</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibdayb>def <i>time</i>.<b>day</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>day</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibhourb>def <i>time</i>.<b>hour</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>hour</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibminuteb>def <i>time</i>.<b>minute</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>minute</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibsecondb>def <i>time</i>.<b>second</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>second</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibnanosecondb>def <i>time</i>.<b>nanosecond</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>nanosecond</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibunixb>def <i>time</i>.<b>unix</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>unix</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibunix_nanob>def <i>time</i>.<b>unix_nano</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>unix_nano</span><span class=p>()</span> <span class=kt>int</span>
</code></pre></div><h4 id=def-itimeibin_locationb>def <i>time</i>.<b>in_location</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>in_location</span><span class=p>(</span><span class=kt>string</span><span class=p>)</span> <span class=nx>time</span>
</code></pre></div><p>get time representing the same instant but in a different location</p><h4 id=def-itimeibformatb>def <i>time</i>.<b>format</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>format</span><span class=p>(</span><span class=kt>string</span><span class=p>)</span> <span class=kt>string</span>
</code></pre></div><p>textual representation of time formatted according to the provided
layout string</p><h4 id=def-itimeibstrftimeb>def <i>time</i>.<b>strftime</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>time</span><span class=p>.</span><span class=nf>strftime</span><span class=p>(</span><span class=kt>string</span><span class=p>)</span> <span class=kt>string</span>
</code></pre></div><p>textual representation of time formatted according to the provided C-style strftime format string
layout string</p><h6 id=operators>Operators</h6><table><thead><tr><th>operator</th><th>description</th></tr></thead><tbody><tr><td>time == time = boolean</td><td></td></tr><tr><td>time &lt; time = boolean</td><td></td></tr><tr><td>time + duration = time</td><td></td></tr><tr><td>time - duration = time</td><td></td></tr><tr><td>time - time = duration</td><td></td></tr></tbody></table></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html>
View Git Blame Copy Permalink