Skip to content

Commit 8a6734c

Browse files
CMCDragonkaiCMCDragonkai
committed
Update module names
1 parent c42e90d commit 8a6734c

File tree

6 files changed

+36
-36
lines changed

6 files changed

+36
-36
lines changed

‎dist/index.browser.umd.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,7 @@ function allocate(tree, counter, snapshot) {
729729
// $FlowFixMe: changed is initialised
730730
return [counter, changed, treeNew];
731731
}
732-
/** @module CounterUtil */
732+
/** @module counterUtil */
733733

734734
function deallocate(tree, counter, snapshot) {
735735
var changed = void 0;
@@ -2251,7 +2251,7 @@ var bitset = createCommonjsModule(function (module, exports) {
22512251
})(commonjsGlobal);
22522252
});
22532253

2254-
/** @module BitMap */
2254+
/** @module bitMap */
22552255

22562256
// bitset library uses 32 bits numbers internally
22572257
// it preemptively adds an extra number whan it detects it's full

‎dist/index.node.cjs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ function allocate(tree, counter, snapshot) {
2020
// $FlowFixMe: changed is initialised
2121
return [counter, changed, treeNew];
2222
}
23-
/** @module CounterUtil */
23+
/** @module counterUtil */
2424

2525
function deallocate(tree, counter, snapshot) {
2626
let changed;
@@ -41,7 +41,7 @@ function check(tree, counter) {
4141
return !!set;
4242
}
4343

44-
/** @module BitMap */
44+
/** @module bitMap */
4545

4646
// bitset library uses 32 bits numbers internally
4747
// it preemptively adds an extra number whan it detects it's full

‎dist/index.node.es.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ function allocate(tree, counter, snapshot) {
1414
// $FlowFixMe: changed is initialised
1515
return [counter, changed, treeNew];
1616
}
17-
/** @module CounterUtil */
17+
/** @module counterUtil */
1818

1919
function deallocate(tree, counter, snapshot) {
2020
let changed;
@@ -35,7 +35,7 @@ function check(tree, counter) {
3535
return !!set;
3636
}
3737

38-
/** @module BitMap */
38+
/** @module bitMap */
3939

4040
// bitset library uses 32 bits numbers internally
4141
// it preemptively adds an extra number whan it detects it's full

‎doc/index.html

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ <h3 class='mb0 no-anchor'>resource-counter</h3>
2727
<li><a
2828
href='#bitmap'
2929
class="">
30-
BitMap
30+
bitMap
3131

3232
</a>
3333

@@ -379,7 +379,7 @@ <h3 class='mb0 no-anchor'>resource-counter</h3>
379379
<li><a
380380
href='#counterutil'
381381
class="">
382-
CounterUtil
382+
counterUtil
383383

384384
</a>
385385

@@ -401,7 +401,7 @@ <h3 class='mb0 no-anchor'>resource-counter</h3>
401401
<div class='clearfix'>
402402

403403
<h3 class='fl m0' id='bitmap'>
404-
BitMap
404+
bitMap
405405
</h3>
406406

407407

@@ -410,7 +410,7 @@ <h3 class='fl m0' id='bitmap'>
410410

411411

412412

413-
<div class='pre p1 fill-light mt0'>BitMap</div>
413+
<div class='pre p1 fill-light mt0'>bitMap</div>
414414

415415

416416

@@ -457,7 +457,7 @@ <h3 class='fl m0' id='createbitmap'>
457457
<p>Creates a new bitmap sized according to the block size</p>
458458

459459

460-
<div class='pre p1 fill-light mt0'>createBitMap(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="#bitmap">BitMap</a></div>
460+
<div class='pre p1 fill-light mt0'>createBitMap(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): BitMap</div>
461461

462462

463463

@@ -488,7 +488,7 @@ <h3 class='fl m0' id='createbitmap'>
488488

489489

490490
<div class='py1 quiet mt1 prose-big'>Returns</div>
491-
<code><a href="#bitmap">BitMap</a></code>
491+
<code>BitMap</code>
492492

493493

494494

@@ -522,7 +522,7 @@ <h3 class='fl m0' id='setbit'>
522522
<p>Set a bit</p>
523523

524524

525-
<div class='pre p1 fill-light mt0'>setBit(bitMap: <a href="#bitmap">BitMap</a>, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="#bitmap">BitMap</a></div>
525+
<div class='pre p1 fill-light mt0'>setBit(bitMap: BitMap, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): BitMap</div>
526526

527527

528528

@@ -539,7 +539,7 @@ <h3 class='fl m0' id='setbit'>
539539

540540
<div class='space-bottom0'>
541541
<div>
542-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
542+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
543543

544544
</div>
545545

@@ -561,7 +561,7 @@ <h3 class='fl m0' id='setbit'>
561561

562562

563563
<div class='py1 quiet mt1 prose-big'>Returns</div>
564-
<code><a href="#bitmap">BitMap</a></code>
564+
<code>BitMap</code>
565565

566566

567567

@@ -595,7 +595,7 @@ <h3 class='fl m0' id='unsetbit'>
595595
<p>Unsets a bit</p>
596596

597597

598-
<div class='pre p1 fill-light mt0'>unsetBit(bitMap: <a href="#bitmap">BitMap</a>, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="#bitmap">BitMap</a></div>
598+
<div class='pre p1 fill-light mt0'>unsetBit(bitMap: BitMap, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): BitMap</div>
599599

600600

601601

@@ -612,7 +612,7 @@ <h3 class='fl m0' id='unsetbit'>
612612

613613
<div class='space-bottom0'>
614614
<div>
615-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
615+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
616616

617617
</div>
618618

@@ -634,7 +634,7 @@ <h3 class='fl m0' id='unsetbit'>
634634

635635

636636
<div class='py1 quiet mt1 prose-big'>Returns</div>
637-
<code><a href="#bitmap">BitMap</a></code>
637+
<code>BitMap</code>
638638

639639

640640

@@ -668,7 +668,7 @@ <h3 class='fl m0' id='allset'>
668668
<p>Checks if the entire bitmap is set</p>
669669

670670

671-
<div class='pre p1 fill-light mt0'>allSet(bitMap: <a href="#bitmap">BitMap</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
671+
<div class='pre p1 fill-light mt0'>allSet(bitMap: BitMap): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
672672

673673

674674

@@ -685,7 +685,7 @@ <h3 class='fl m0' id='allset'>
685685

686686
<div class='space-bottom0'>
687687
<div>
688-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
688+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
689689

690690
</div>
691691

@@ -733,7 +733,7 @@ <h3 class='fl m0' id='allunset'>
733733
<p>Checks if the entire bitmap is unset</p>
734734

735735

736-
<div class='pre p1 fill-light mt0'>allUnset(bitMap: <a href="#bitmap">BitMap</a>, blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
736+
<div class='pre p1 fill-light mt0'>allUnset(bitMap: BitMap, blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
737737

738738

739739

@@ -750,7 +750,7 @@ <h3 class='fl m0' id='allunset'>
750750

751751
<div class='space-bottom0'>
752752
<div>
753-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
753+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
754754

755755
</div>
756756

@@ -807,7 +807,7 @@ <h3 class='fl m0' id='firstunset'>
807807
If null is returned, all items have been set</p>
808808

809809

810-
<div class='pre p1 fill-light mt0'>firstUnset(bitMap: <a href="#bitmap">BitMap</a>): (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> | null)</div>
810+
<div class='pre p1 fill-light mt0'>firstUnset(bitMap: BitMap): (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> | null)</div>
811811

812812

813813

@@ -824,7 +824,7 @@ <h3 class='fl m0' id='firstunset'>
824824

825825
<div class='space-bottom0'>
826826
<div>
827-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
827+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
828828

829829
</div>
830830

@@ -872,7 +872,7 @@ <h3 class='fl m0' id='isset'>
872872
<p>Checks if a bit is set.</p>
873873

874874

875-
<div class='pre p1 fill-light mt0'>isSet(bitMap: <a href="#bitmap">BitMap</a>, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
875+
<div class='pre p1 fill-light mt0'>isSet(bitMap: BitMap, i: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
876876

877877

878878

@@ -889,7 +889,7 @@ <h3 class='fl m0' id='isset'>
889889

890890
<div class='space-bottom0'>
891891
<div>
892-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
892+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
893893

894894
</div>
895895

@@ -1001,7 +1001,7 @@ <h3 class='fl m0' id='bitmaptree'>
10011001
unnecessarily.</p>
10021002

10031003

1004-
<div class='pre p1 fill-light mt0'>new BitMapTree(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, depth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: <a href="#bitmap">BitMap</a>)</div>
1004+
<div class='pre p1 fill-light mt0'>new BitMapTree(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, depth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: BitMap)</div>
10051005

10061006

10071007

@@ -1050,7 +1050,7 @@ <h3 class='fl m0' id='bitmaptree'>
10501050

10511051
<div class='space-bottom0'>
10521052
<div>
1053-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
1053+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
10541054

10551055
</div>
10561056

@@ -1094,7 +1094,7 @@ <h3 class='fl m0' id='leaf'>
10941094
This represents the base case of the lazy recursive bitmap tree.</p>
10951095

10961096

1097-
<div class='pre p1 fill-light mt0'>new Leaf(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: <a href="#bitmap">BitMap</a>)</div>
1097+
<div class='pre p1 fill-light mt0'>new Leaf(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: BitMap)</div>
10981098

10991099

11001100
<p>
@@ -1142,7 +1142,7 @@ <h3 class='fl m0' id='leaf'>
11421142

11431143
<div class='space-bottom0'>
11441144
<div>
1145-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
1145+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
11461146

11471147
</div>
11481148

@@ -1424,7 +1424,7 @@ <h3 class='fl m0' id='node'>
14241424
<p>Class representing a Node of the recursive bitmap tree.</p>
14251425

14261426

1427-
<div class='pre p1 fill-light mt0'>new Node(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, depth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: <a href="#bitmap">BitMap</a>, bitMapTrees: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;Tree>)</div>
1427+
<div class='pre p1 fill-light mt0'>new Node(blockSize: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, shrink: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, begin: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, depth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, bitMap: BitMap, bitMapTrees: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;Tree>)</div>
14281428

14291429

14301430
<p>
@@ -1480,7 +1480,7 @@ <h3 class='fl m0' id='node'>
14801480

14811481
<div class='space-bottom0'>
14821482
<div>
1483-
<span class='code bold'>bitMap</span> <code class='quiet'>(<a href="#bitmap">BitMap</a>)</code>
1483+
<span class='code bold'>bitMap</span> <code class='quiet'>(BitMap)</code>
14841484

14851485
</div>
14861486

@@ -3002,7 +3002,7 @@ <h3 class='fl m0' id='counterimmutable'>
30023002
<div class='clearfix'>
30033003

30043004
<h3 class='fl m0' id='counterutil'>
3005-
CounterUtil
3005+
counterUtil
30063006
</h3>
30073007

30083008

@@ -3011,7 +3011,7 @@ <h3 class='fl m0' id='counterutil'>
30113011

30123012

30133013

3014-
<div class='pre p1 fill-light mt0'>CounterUtil</div>
3014+
<div class='pre p1 fill-light mt0'>counterUtil</div>
30153015

30163016

30173017

‎lib/bitMap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// @flow
2-
/** @module BitMap */
2+
/** @module bitMap */
33

44
import BitSet from 'bitset.js';
55

‎lib/counterUtil.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// @flow
2-
/** @module CounterUtil */
2+
/** @module counterUtil */
33

44
import type { Tree, SnapShot } from './BitMapTree.js';
55

0 commit comments

Comments
 (0)