UNPKG

repeating-interval

Version:

IS0 8601 repeating interval parsing and manipulation

886 lines (885 loc) 55.4 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Interval | repeating-interval</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script src="../assets/js/modernizr.js"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">repeating-interval</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_interval_.html">&quot;interval&quot;</a> </li> <li> <a href="_interval_.interval.html">Interval</a> </li> </ul> <h1>Class Interval</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Class to describe ISO 8601 time intervals, including the repeating functionality.</p> </div> <p>The class is primarily backed by moment.js and contains the start, end, duration, and number of repetitions found in the ISO8601 string or overridden in the constructor. Typical usage of the class is to construct one with a ISO8601 string in the constructor.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Interval</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_interval_.interval.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_duration" class="tsd-kind-icon">_duration</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_end" class="tsd-kind-icon">_end</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_first" class="tsd-kind-icon">_first</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_infinitespan" class="tsd-kind-icon">_infinite<wbr>Span</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_last" class="tsd-kind-icon">_last</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_recurs" class="tsd-kind-icon">_recurs</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_repetitions" class="tsd-kind-icon">_repetitions</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_interval_.interval.html#_start" class="tsd-kind-icon">_start</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#duration" class="tsd-kind-icon">duration</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#end" class="tsd-kind-icon">end</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#first" class="tsd-kind-icon">first</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#isinfinite" class="tsd-kind-icon">is<wbr>Infinite</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#isinfinitenegative" class="tsd-kind-icon">is<wbr>Infinite<wbr>Negative</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#isinfinitepositive" class="tsd-kind-icon">is<wbr>Infinite<wbr>Positive</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#isrepeating" class="tsd-kind-icon">is<wbr>Repeating</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#last" class="tsd-kind-icon">last</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#repetitions" class="tsd-kind-icon">repetitions</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_interval_.interval.html#start" class="tsd-kind-icon">start</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#durationbetween" class="tsd-kind-icon">duration<wbr>Between</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#indexafter" class="tsd-kind-icon">index<wbr>After</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#indexbefore" class="tsd-kind-icon">index<wbr>Before</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#occurrence" class="tsd-kind-icon">occurrence</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#occurrenceafter" class="tsd-kind-icon">occurrence<wbr>After</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#slice" class="tsd-kind-icon">slice</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#toisostring" class="tsd-kind-icon">toISOString</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_interval_.interval.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_interval_.interval.html#extents" class="tsd-kind-icon">extents</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Interval<span class="tsd-signature-symbol">(</span>interval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_interval_.interval.html" class="tsd-signature-type">Interval</a>, repetitions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_interval_.interval.html" class="tsd-signature-type">Interval</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L215">interval.ts:215</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> interval: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_interval_.interval.html" class="tsd-signature-type">Interval</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>either ISO8601 string or an instance to copy</p> </div> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> repetitions: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>the number of times to repeat, null for infinite</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_interval_.interval.html" class="tsd-signature-type">Interval</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_duration" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _duration</h3> <div class="tsd-signature tsd-kind-icon">_duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Duration</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L105">interval.ts:105</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_end" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _end</h3> <div class="tsd-signature tsd-kind-icon">_end<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L103">interval.ts:103</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_first" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _first</h3> <div class="tsd-signature tsd-kind-icon">_first<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L111">interval.ts:111</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_infinitespan" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _infinite<wbr>Span</h3> <div class="tsd-signature tsd-kind-icon">_infinite<wbr>Span<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L117">interval.ts:117</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_last" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _last</h3> <div class="tsd-signature tsd-kind-icon">_last<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L113">interval.ts:113</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_recurs" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _recurs</h3> <div class="tsd-signature tsd-kind-icon">_recurs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L106">interval.ts:106</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_repetitions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _repetitions</h3> <div class="tsd-signature tsd-kind-icon">_repetitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L108">interval.ts:108</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_start" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _start</h3> <div class="tsd-signature tsd-kind-icon">_start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L101">interval.ts:101</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="duration" class="tsd-anchor"></a> <h3>duration</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> duration<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Duration</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L148">interval.ts:148</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The duration of a single repition of the interval</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Duration</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="end" class="tsd-anchor"></a> <h3>end</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> end<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L137">interval.ts:137</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The end of all intervals, if this is a repeating interval then this is then end of the last repitition. Returns an invalid moment if there are infinite positive repetitions</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="first" class="tsd-anchor"></a> <h3>first</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> first<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L204">interval.ts:204</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Index of the first occurrence, Number.NEGATIVE_INFINITY if the interval is reverse repeating indefinitely</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="isinfinite" class="tsd-anchor"></a> <h3>is<wbr>Infinite</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isInfinite<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L163">interval.ts:163</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>True if the schedule is infintely long</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="isinfinitenegative" class="tsd-anchor"></a> <h3>is<wbr>Infinite<wbr>Negative</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isInfiniteNegative<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L179">interval.ts:179</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>True if the schedule progresses infinitely in the negative</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="isinfinitepositive" class="tsd-anchor"></a> <h3>is<wbr>Infinite<wbr>Positive</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isInfinitePositive<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L171">interval.ts:171</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>True if the schedule progresses infinitely in the positive</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="isrepeating" class="tsd-anchor"></a> <h3>is<wbr>Repeating</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isRepeating<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L187">interval.ts:187</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>True if the schedule repeats (has more than one occurrence)</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="last" class="tsd-anchor"></a> <h3>last</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> last<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L213">interval.ts:213</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Index of the last occurrence, Number.POSITIVE_INFINITY if the interval is forward repeating indefinitely</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="repetitions" class="tsd-anchor"></a> <h3>repetitions</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> repetitions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L195">interval.ts:195</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The number of repetitions</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="start" class="tsd-anchor"></a> <h3>start</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L124">interval.ts:124</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The start of all intervals, if this is a repeating interval then this is the start of the first repitition. Returns an invalid moment if there are infinite negative repetitions</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="durationbetween" class="tsd-anchor"></a> <h3>duration<wbr>Between</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">duration<wbr>Between<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Duration</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L411">interval.ts:411</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>to: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Duration</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="indexafter" class="tsd-anchor"></a> <h3>index<wbr>After</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">index<wbr>After<span class="tsd-signature-symbol">(</span>after<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L385">interval.ts:385</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the recurrence (the index of the occurrence) after the supplied time</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>after: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span></h5> <div class="tsd-comment tsd-typography"> <p>Moment or something that it parses (if a number, then in epoc ms)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="indexbefore" class="tsd-anchor"></a> <h3>index<wbr>Before</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">index<wbr>Before<span class="tsd-signature-symbol">(</span>before<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L397">interval.ts:397</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>before: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="occurrence" class="tsd-anchor"></a> <h3>occurrence</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">occurrence<span class="tsd-signature-symbol">(</span>idx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L322">interval.ts:322</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>idx: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="occurrenceafter" class="tsd-anchor"></a> <h3>occurrence<wbr>After</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">occurrence<wbr>After<span class="tsd-signature-symbol">(</span>after<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L405">interval.ts:405</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the occurrence happening after the supplied date. Throws Error if there is no occurrence after the supplied date</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>after: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Moment</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="slice" class="tsd-anchor"></a> <h3>slice</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">slice<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, to<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L341">interval.ts:341</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a list of the occurrences for an interval, if no parameters are supplied then all occurrences are returned.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> from: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> to: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="toisostring" class="tsd-anchor"></a> <h3>toISOString</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">toISOString<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L421">interval.ts:421</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L444">interval.ts:444</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="extents" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> extents</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">extents<span class="tsd-signature-symbol">(</span>intervalList<span class="tsd-signature-symbol">: </span><a href="_interval_.interval.html" class="tsd-signature-type">Interval</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_interval_.interval.html" class="tsd-signature-type">Interval</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/enriched/repeating-interval/blob/fe4c331/src/interval.ts#L415">interval.ts:415</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>intervalList: <a href="_interval_.interval.html" class="tsd-signature-type">Interval</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_interval_.interval.html" class="tsd-signature-type">Interval</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_interval_.html">"interval"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../enums/_interval_.string8601type.html" class="tsd-kind-icon">String8601<wbr>Type</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_interval_.interval.html" class="tsd-kind-icon">Interval</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_interval_.interval.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_duration" class="tsd-kind-icon">_duration</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_end" class="tsd-kind-icon">_end</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_first" class="tsd-kind-icon">_first</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_infinitespan" class="tsd-kind-icon">_infinite<wbr>Span</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_last" class="tsd-kind-icon">_last</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_recurs" class="tsd-kind-icon">_recurs</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_repetitions" class="tsd-kind-icon">_repetitions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_interval_.interval.html#_start" class="tsd-kind-icon">_start</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#duration" class="tsd-kind-icon">duration</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#end" class="tsd-kind-icon">end</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#first" class="tsd-kind-icon">first</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#isinfinite" class="tsd-kind-icon">is<wbr>Infinite</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#isinfinitenegative" class="tsd-kind-icon">is<wbr>Infinite<wbr>Negative</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#isinfinitepositive" class="tsd-kind-icon">is<wbr>Infinite<wbr>Positive</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#isrepeating" class="tsd-kind-icon">is<wbr>Repeating</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#last" class="tsd-kind-icon">last</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#repetitions" class="tsd-kind-icon">repetitions</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="_interval_.interval.html#start" class="tsd-kind-icon">start</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#durationbetween" class="tsd-kind-icon">duration<wbr>Between</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#indexafter" class="tsd-kind-icon">index<wbr>After</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#indexbefore" class="tsd-kind-icon">index<wbr>Before</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#occurrence" class="tsd-kind-icon">occurrence</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#occurrenceafter" class="tsd-kind-icon">occurrence<wbr>After</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#slice" class="tsd-kind-icon">slice</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#toisostring" class="tsd-kind-icon">toISOString</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_interval_.interval.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_interval_.interval.html#extents" class="tsd-kind-icon">extents</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../interfaces/_interval_.parsed8601string.html" class="tsd-kind-icon">parsed8601<wbr>String</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#moment" class="tsd-kind-icon">Moment</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#dateregex" class="tsd-kind-icon">date<wbr>Regex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#durationregex" class="tsd-kind-icon">duration<wbr>Regex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millisperday" class="tsd-kind-icon">millis<wbr>Per<wbr>Day</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millisperhour" class="tsd-kind-icon">millis<wbr>Per<wbr>Hour</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millisperminute" class="tsd-kind-icon">millis<wbr>Per<wbr>Minute</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millispersecond" class="tsd-kind-icon">millis<wbr>Per<wbr>Second</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millisperweek" class="tsd-kind-icon">millis<wbr>Per<wbr>Week</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#millisperyear" class="tsd-kind-icon">millis<wbr>Per<wbr>Year</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#rangedatedateregex" class="tsd-kind-icon">range<wbr>Date<wbr>Date<wbr>Regex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#rangedatedurationregex" class="tsd-kind-icon">range<wbr>Date<wbr>Duration<wbr>Regex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#rangedurationdateregex" class="tsd-kind-icon">range<wbr>Duration<wbr>Date<wbr>Regex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#recurrenceregex" class="tsd-kind-icon">recurrence<wbr>Regex</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#isduration" class="tsd-kind-icon">is<wbr>Duration</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#isinfinite" class="tsd-kind-icon">is<wbr>Infinite</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#isrepeating" class="tsd-kind-icon">is<wbr>Repeating</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_interval_.html#istime" class="tsd-kind-icon">is<wbr>Time</a>