@grain/stdlib 0.7.0 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/array.md +491 -491
- package/bigint.md +198 -198
- package/buffer.gr +66 -1
- package/buffer.md +395 -272
- package/bytes.gr +1 -0
- package/bytes.md +200 -199
- package/char.md +125 -125
- package/exception.md +9 -9
- package/float32.md +195 -195
- package/float64.md +195 -195
- package/fs.md +115 -115
- package/hash.md +16 -16
- package/int16.md +155 -155
- package/int32.gr +1 -1
- package/int32.md +207 -207
- package/int64.gr +1 -1
- package/int64.md +207 -207
- package/int8.md +155 -155
- package/json.md +59 -59
- package/list.md +347 -347
- package/map.md +222 -222
- package/marshal.md +12 -12
- package/number.gr +119 -5
- package/number.md +503 -261
- package/option.md +141 -141
- package/package.json +2 -2
- package/path.gr +82 -65
- package/path.md +210 -141
- package/pervasives.md +238 -238
- package/priorityqueue.md +112 -112
- package/queue.md +117 -117
- package/random.md +37 -37
- package/range.md +36 -36
- package/rational.md +107 -107
- package/regex.md +91 -91
- package/result.md +102 -102
- package/runtime/atof/decimal.md +6 -6
- package/runtime/compare.md +7 -7
- package/runtime/dataStructures.md +178 -178
- package/runtime/equal.md +7 -7
- package/runtime/exception.md +15 -15
- package/runtime/malloc.md +9 -9
- package/runtime/numbers.md +269 -269
- package/runtime/string.md +17 -17
- package/runtime/unsafe/conv.md +6 -6
- package/runtime/unsafe/memory.gr +2 -19
- package/runtime/unsafe/memory.md +10 -10
- package/runtime/utf8.md +31 -31
- package/runtime/wasi.md +9 -9
- package/set.md +211 -211
- package/stack.md +122 -122
- package/string.md +228 -228
- package/uint16.md +148 -148
- package/uint32.md +192 -192
- package/uint64.md +192 -192
- package/uint8.md +148 -148
- package/uri.md +77 -77
- package/wasi/file.md +269 -269
- package/wasi/process.md +21 -21
- package/wasi/random.md +9 -9
- package/wasi/time.md +12 -12
package/runtime/numbers.md
CHANGED
|
@@ -173,15 +173,15 @@ Finds the numerator of the rational number.
|
|
|
173
173
|
|
|
174
174
|
Parameters:
|
|
175
175
|
|
|
176
|
-
|param|type|description|
|
|
177
|
-
|
|
178
|
-
|
|
176
|
+
| param | type | description |
|
|
177
|
+
| ----- | ---------- | ------------------------------ |
|
|
178
|
+
| `x` | `Rational` | The rational number to inspect |
|
|
179
179
|
|
|
180
180
|
Returns:
|
|
181
181
|
|
|
182
|
-
|type|description|
|
|
183
|
-
|
|
184
|
-
|
|
182
|
+
| type | description |
|
|
183
|
+
| -------- | ------------------------------------ |
|
|
184
|
+
| `Number` | The numerator of the rational number |
|
|
185
185
|
|
|
186
186
|
### Numbers.**rationalDenominator**
|
|
187
187
|
|
|
@@ -198,15 +198,15 @@ Finds the denominator of the rational number.
|
|
|
198
198
|
|
|
199
199
|
Parameters:
|
|
200
200
|
|
|
201
|
-
|param|type|description|
|
|
202
|
-
|
|
203
|
-
|
|
201
|
+
| param | type | description |
|
|
202
|
+
| ----- | ---------- | ------------------------------ |
|
|
203
|
+
| `x` | `Rational` | The rational number to inspect |
|
|
204
204
|
|
|
205
205
|
Returns:
|
|
206
206
|
|
|
207
|
-
|type|description|
|
|
208
|
-
|
|
209
|
-
|
|
207
|
+
| type | description |
|
|
208
|
+
| -------- | -------------------------------------- |
|
|
209
|
+
| `Number` | The denominator of the rational number |
|
|
210
210
|
|
|
211
211
|
### Numbers.**cmp**
|
|
212
212
|
|
|
@@ -229,16 +229,16 @@ Checks if the first operand is less than the second operand.
|
|
|
229
229
|
|
|
230
230
|
Parameters:
|
|
231
231
|
|
|
232
|
-
|param|type|description|
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
232
|
+
| param | type | description |
|
|
233
|
+
| ------ | -------- | ------------------ |
|
|
234
|
+
| `num1` | `Number` | The first operand |
|
|
235
|
+
| `num2` | `Number` | The second operand |
|
|
236
236
|
|
|
237
237
|
Returns:
|
|
238
238
|
|
|
239
|
-
|type|description|
|
|
240
|
-
|
|
241
|
-
|
|
239
|
+
| type | description |
|
|
240
|
+
| ------ | -------------------------------------------------------------------------------- |
|
|
241
|
+
| `Bool` | `true` if the first operand is less than the second operand or `false` otherwise |
|
|
242
242
|
|
|
243
243
|
### Numbers.**(>)**
|
|
244
244
|
|
|
@@ -255,16 +255,16 @@ Checks if the first operand is greater than the second operand.
|
|
|
255
255
|
|
|
256
256
|
Parameters:
|
|
257
257
|
|
|
258
|
-
|param|type|description|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
258
|
+
| param | type | description |
|
|
259
|
+
| ------ | -------- | ------------------ |
|
|
260
|
+
| `num1` | `Number` | The first operand |
|
|
261
|
+
| `num2` | `Number` | The second operand |
|
|
262
262
|
|
|
263
263
|
Returns:
|
|
264
264
|
|
|
265
|
-
|type|description|
|
|
266
|
-
|
|
267
|
-
|
|
265
|
+
| type | description |
|
|
266
|
+
| ------ | ----------------------------------------------------------------------------------- |
|
|
267
|
+
| `Bool` | `true` if the first operand is greater than the second operand or `false` otherwise |
|
|
268
268
|
|
|
269
269
|
### Numbers.**(<=)**
|
|
270
270
|
|
|
@@ -281,16 +281,16 @@ Checks if the first operand is less than or equal to the second operand.
|
|
|
281
281
|
|
|
282
282
|
Parameters:
|
|
283
283
|
|
|
284
|
-
|param|type|description|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
284
|
+
| param | type | description |
|
|
285
|
+
| ------ | -------- | ------------------ |
|
|
286
|
+
| `num1` | `Number` | The first operand |
|
|
287
|
+
| `num2` | `Number` | The second operand |
|
|
288
288
|
|
|
289
289
|
Returns:
|
|
290
290
|
|
|
291
|
-
|type|description|
|
|
292
|
-
|
|
293
|
-
|
|
291
|
+
| type | description |
|
|
292
|
+
| ------ | -------------------------------------------------------------------------------------------- |
|
|
293
|
+
| `Bool` | `true` if the first operand is less than or equal to the second operand or `false` otherwise |
|
|
294
294
|
|
|
295
295
|
### Numbers.**(>=)**
|
|
296
296
|
|
|
@@ -307,16 +307,16 @@ Checks if the first operand is greater than or equal to the second operand.
|
|
|
307
307
|
|
|
308
308
|
Parameters:
|
|
309
309
|
|
|
310
|
-
|param|type|description|
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
310
|
+
| param | type | description |
|
|
311
|
+
| ------ | -------- | ------------------ |
|
|
312
|
+
| `num1` | `Number` | The first operand |
|
|
313
|
+
| `num2` | `Number` | The second operand |
|
|
314
314
|
|
|
315
315
|
Returns:
|
|
316
316
|
|
|
317
|
-
|type|description|
|
|
318
|
-
|
|
319
|
-
|
|
317
|
+
| type | description |
|
|
318
|
+
| ------ | ----------------------------------------------------------------------------------------------- |
|
|
319
|
+
| `Bool` | `true` if the first operand is greater than or equal to the second operand or `false` otherwise |
|
|
320
320
|
|
|
321
321
|
### Numbers.**compare**
|
|
322
322
|
|
|
@@ -345,15 +345,15 @@ Computes the bitwise NOT of the operand.
|
|
|
345
345
|
|
|
346
346
|
Parameters:
|
|
347
347
|
|
|
348
|
-
|param|type|description|
|
|
349
|
-
|
|
350
|
-
|
|
348
|
+
| param | type | description |
|
|
349
|
+
| ------- | -------- | ----------- |
|
|
350
|
+
| `value` | `Number` | The operand |
|
|
351
351
|
|
|
352
352
|
Returns:
|
|
353
353
|
|
|
354
|
-
|type|description|
|
|
355
|
-
|
|
356
|
-
|
|
354
|
+
| type | description |
|
|
355
|
+
| -------- | ------------------------------------------- |
|
|
356
|
+
| `Number` | Containing the inverted bits of the operand |
|
|
357
357
|
|
|
358
358
|
### Numbers.**(<<)**
|
|
359
359
|
|
|
@@ -378,16 +378,16 @@ Shifts the bits of the value left by the given number of bits.
|
|
|
378
378
|
|
|
379
379
|
Parameters:
|
|
380
380
|
|
|
381
|
-
|param|type|description|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
381
|
+
| param | type | description |
|
|
382
|
+
| -------- | -------- | ------------------------------ |
|
|
383
|
+
| `value` | `Number` | The value to shift |
|
|
384
|
+
| `amount` | `Number` | The number of bits to shift by |
|
|
385
385
|
|
|
386
386
|
Returns:
|
|
387
387
|
|
|
388
|
-
|type|description|
|
|
389
|
-
|
|
390
|
-
|
|
388
|
+
| type | description |
|
|
389
|
+
| -------- | ----------------- |
|
|
390
|
+
| `Number` | The shifted value |
|
|
391
391
|
|
|
392
392
|
### Numbers.**(>>>)**
|
|
393
393
|
|
|
@@ -412,16 +412,16 @@ Shifts the bits of the value right by the given number of bits, preserving the s
|
|
|
412
412
|
|
|
413
413
|
Parameters:
|
|
414
414
|
|
|
415
|
-
|param|type|description|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
415
|
+
| param | type | description |
|
|
416
|
+
| -------- | -------- | ---------------------- |
|
|
417
|
+
| `value` | `Number` | The value to shift |
|
|
418
|
+
| `amount` | `Number` | The amount to shift by |
|
|
419
419
|
|
|
420
420
|
Returns:
|
|
421
421
|
|
|
422
|
-
|type|description|
|
|
423
|
-
|
|
424
|
-
|
|
422
|
+
| type | description |
|
|
423
|
+
| -------- | ----------------- |
|
|
424
|
+
| `Number` | The shifted value |
|
|
425
425
|
|
|
426
426
|
### Numbers.**(&)**
|
|
427
427
|
|
|
@@ -446,16 +446,16 @@ Computes the bitwise AND (`&`) on the given operands.
|
|
|
446
446
|
|
|
447
447
|
Parameters:
|
|
448
448
|
|
|
449
|
-
|param|type|description|
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
449
|
+
| param | type | description |
|
|
450
|
+
| -------- | -------- | ------------------ |
|
|
451
|
+
| `value1` | `Number` | The first operand |
|
|
452
|
+
| `value2` | `Number` | The second operand |
|
|
453
453
|
|
|
454
454
|
Returns:
|
|
455
455
|
|
|
456
|
-
|type|description|
|
|
457
|
-
|
|
458
|
-
|
|
456
|
+
| type | description |
|
|
457
|
+
| -------- | ----------------------------------------------------------------------------------------------- |
|
|
458
|
+
| `Number` | Containing a `1` in each bit position for which the corresponding bits of both operands are `1` |
|
|
459
459
|
|
|
460
460
|
### Numbers.**(|)**
|
|
461
461
|
|
|
@@ -480,16 +480,16 @@ Computes the bitwise OR (`|`) on the given operands.
|
|
|
480
480
|
|
|
481
481
|
Parameters:
|
|
482
482
|
|
|
483
|
-
|param|type|description|
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
483
|
+
| param | type | description |
|
|
484
|
+
| -------- | -------- | ------------------ |
|
|
485
|
+
| `value1` | `Number` | The first operand |
|
|
486
|
+
| `value2` | `Number` | The second operand |
|
|
487
487
|
|
|
488
488
|
Returns:
|
|
489
489
|
|
|
490
|
-
|type|description|
|
|
491
|
-
|
|
492
|
-
|
|
490
|
+
| type | description |
|
|
491
|
+
| -------- | --------------------------------------------------------------------------------------------------------- |
|
|
492
|
+
| `Number` | Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1` |
|
|
493
493
|
|
|
494
494
|
### Numbers.**(^)**
|
|
495
495
|
|
|
@@ -515,16 +515,16 @@ Computes the bitwise XOR (`^`) on the given operands.
|
|
|
515
515
|
|
|
516
516
|
Parameters:
|
|
517
517
|
|
|
518
|
-
|param|type|description|
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
518
|
+
| param | type | description |
|
|
519
|
+
| -------- | -------- | ------------------ |
|
|
520
|
+
| `value1` | `Number` | The first operand |
|
|
521
|
+
| `value2` | `Number` | The second operand |
|
|
522
522
|
|
|
523
523
|
Returns:
|
|
524
524
|
|
|
525
|
-
|type|description|
|
|
526
|
-
|
|
527
|
-
|
|
525
|
+
| type | description |
|
|
526
|
+
| -------- | -------------------------------------------------------------------------------------------------------------- |
|
|
527
|
+
| `Number` | Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1` |
|
|
528
528
|
|
|
529
529
|
### Numbers.**(>>)**
|
|
530
530
|
|
|
@@ -549,16 +549,16 @@ Shifts the bits of the value right by the given number of bits.
|
|
|
549
549
|
|
|
550
550
|
Parameters:
|
|
551
551
|
|
|
552
|
-
|param|type|description|
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
552
|
+
| param | type | description |
|
|
553
|
+
| -------- | -------- | ---------------------- |
|
|
554
|
+
| `value` | `Number` | The value to shift |
|
|
555
|
+
| `amount` | `Number` | The amount to shift by |
|
|
556
556
|
|
|
557
557
|
Returns:
|
|
558
558
|
|
|
559
|
-
|type|description|
|
|
560
|
-
|
|
561
|
-
|
|
559
|
+
| type | description |
|
|
560
|
+
| -------- | ----------------- |
|
|
561
|
+
| `Number` | The shifted value |
|
|
562
562
|
|
|
563
563
|
### Numbers.**coerceNumberToInt8**
|
|
564
564
|
|
|
@@ -575,15 +575,15 @@ Converts a Number to an Int8.
|
|
|
575
575
|
|
|
576
576
|
Parameters:
|
|
577
577
|
|
|
578
|
-
|param|type|description|
|
|
579
|
-
|
|
580
|
-
|
|
578
|
+
| param | type | description |
|
|
579
|
+
| -------- | -------- | -------------------- |
|
|
580
|
+
| `number` | `Number` | The value to convert |
|
|
581
581
|
|
|
582
582
|
Returns:
|
|
583
583
|
|
|
584
|
-
|type|description|
|
|
585
|
-
|
|
586
|
-
|
|
584
|
+
| type | description |
|
|
585
|
+
| ------ | --------------------------------- |
|
|
586
|
+
| `Int8` | The Number represented as an Int8 |
|
|
587
587
|
|
|
588
588
|
### Numbers.**coerceNumberToInt16**
|
|
589
589
|
|
|
@@ -600,15 +600,15 @@ Converts a Number to an Int16.
|
|
|
600
600
|
|
|
601
601
|
Parameters:
|
|
602
602
|
|
|
603
|
-
|param|type|description|
|
|
604
|
-
|
|
605
|
-
|
|
603
|
+
| param | type | description |
|
|
604
|
+
| -------- | -------- | -------------------- |
|
|
605
|
+
| `number` | `Number` | The value to convert |
|
|
606
606
|
|
|
607
607
|
Returns:
|
|
608
608
|
|
|
609
|
-
|type|description|
|
|
610
|
-
|
|
611
|
-
|
|
609
|
+
| type | description |
|
|
610
|
+
| ------- | ---------------------------------- |
|
|
611
|
+
| `Int16` | The Number represented as an Int16 |
|
|
612
612
|
|
|
613
613
|
### Numbers.**coerceNumberToUint8**
|
|
614
614
|
|
|
@@ -625,15 +625,15 @@ Converts a Number to a Uint8.
|
|
|
625
625
|
|
|
626
626
|
Parameters:
|
|
627
627
|
|
|
628
|
-
|param|type|description|
|
|
629
|
-
|
|
630
|
-
|
|
628
|
+
| param | type | description |
|
|
629
|
+
| -------- | -------- | -------------------- |
|
|
630
|
+
| `number` | `Number` | The value to convert |
|
|
631
631
|
|
|
632
632
|
Returns:
|
|
633
633
|
|
|
634
|
-
|type|description|
|
|
635
|
-
|
|
636
|
-
|
|
634
|
+
| type | description |
|
|
635
|
+
| ------- | --------------------------------- |
|
|
636
|
+
| `Uint8` | The Number represented as a Uint8 |
|
|
637
637
|
|
|
638
638
|
### Numbers.**coerceNumberToUint16**
|
|
639
639
|
|
|
@@ -650,15 +650,15 @@ Converts a Number to a Uint16.
|
|
|
650
650
|
|
|
651
651
|
Parameters:
|
|
652
652
|
|
|
653
|
-
|param|type|description|
|
|
654
|
-
|
|
655
|
-
|
|
653
|
+
| param | type | description |
|
|
654
|
+
| -------- | -------- | -------------------- |
|
|
655
|
+
| `number` | `Number` | The value to convert |
|
|
656
656
|
|
|
657
657
|
Returns:
|
|
658
658
|
|
|
659
|
-
|type|description|
|
|
660
|
-
|
|
661
|
-
|
|
659
|
+
| type | description |
|
|
660
|
+
| -------- | ---------------------------------- |
|
|
661
|
+
| `Uint16` | The Number represented as a Uint16 |
|
|
662
662
|
|
|
663
663
|
### Numbers.**coerceNumberToInt32**
|
|
664
664
|
|
|
@@ -675,15 +675,15 @@ Converts a Number to an Int32.
|
|
|
675
675
|
|
|
676
676
|
Parameters:
|
|
677
677
|
|
|
678
|
-
|param|type|description|
|
|
679
|
-
|
|
680
|
-
|
|
678
|
+
| param | type | description |
|
|
679
|
+
| -------- | -------- | -------------------- |
|
|
680
|
+
| `number` | `Number` | The value to convert |
|
|
681
681
|
|
|
682
682
|
Returns:
|
|
683
683
|
|
|
684
|
-
|type|description|
|
|
685
|
-
|
|
686
|
-
|
|
684
|
+
| type | description |
|
|
685
|
+
| ------- | ---------------------------------- |
|
|
686
|
+
| `Int32` | The Number represented as an Int32 |
|
|
687
687
|
|
|
688
688
|
### Numbers.**coerceNumberToInt64**
|
|
689
689
|
|
|
@@ -700,15 +700,15 @@ Converts a Number to an Int64.
|
|
|
700
700
|
|
|
701
701
|
Parameters:
|
|
702
702
|
|
|
703
|
-
|param|type|description|
|
|
704
|
-
|
|
705
|
-
|
|
703
|
+
| param | type | description |
|
|
704
|
+
| -------- | -------- | -------------------- |
|
|
705
|
+
| `number` | `Number` | The value to convert |
|
|
706
706
|
|
|
707
707
|
Returns:
|
|
708
708
|
|
|
709
|
-
|type|description|
|
|
710
|
-
|
|
711
|
-
|
|
709
|
+
| type | description |
|
|
710
|
+
| ------- | ---------------------------------- |
|
|
711
|
+
| `Int64` | The Number represented as an Int64 |
|
|
712
712
|
|
|
713
713
|
### Numbers.**coerceNumberToBigInt**
|
|
714
714
|
|
|
@@ -725,15 +725,15 @@ Converts a Number to a BigInt.
|
|
|
725
725
|
|
|
726
726
|
Parameters:
|
|
727
727
|
|
|
728
|
-
|param|type|description|
|
|
729
|
-
|
|
730
|
-
|
|
728
|
+
| param | type | description |
|
|
729
|
+
| -------- | -------- | -------------------- |
|
|
730
|
+
| `number` | `Number` | The value to convert |
|
|
731
731
|
|
|
732
732
|
Returns:
|
|
733
733
|
|
|
734
|
-
|type|description|
|
|
735
|
-
|
|
736
|
-
|
|
734
|
+
| type | description |
|
|
735
|
+
| -------- | ---------------------------------- |
|
|
736
|
+
| `BigInt` | The Number represented as a BigInt |
|
|
737
737
|
|
|
738
738
|
### Numbers.**coerceNumberToRational**
|
|
739
739
|
|
|
@@ -750,15 +750,15 @@ Converts a Number to a Rational.
|
|
|
750
750
|
|
|
751
751
|
Parameters:
|
|
752
752
|
|
|
753
|
-
|param|type|description|
|
|
754
|
-
|
|
755
|
-
|
|
753
|
+
| param | type | description |
|
|
754
|
+
| -------- | -------- | -------------------- |
|
|
755
|
+
| `number` | `Number` | The value to convert |
|
|
756
756
|
|
|
757
757
|
Returns:
|
|
758
758
|
|
|
759
|
-
|type|description|
|
|
760
|
-
|
|
761
|
-
|
|
759
|
+
| type | description |
|
|
760
|
+
| ---------- | ------------------------------------ |
|
|
761
|
+
| `Rational` | The Number represented as a Rational |
|
|
762
762
|
|
|
763
763
|
### Numbers.**coerceNumberToFloat32**
|
|
764
764
|
|
|
@@ -775,15 +775,15 @@ Converts a Number to a Float32.
|
|
|
775
775
|
|
|
776
776
|
Parameters:
|
|
777
777
|
|
|
778
|
-
|param|type|description|
|
|
779
|
-
|
|
780
|
-
|
|
778
|
+
| param | type | description |
|
|
779
|
+
| -------- | -------- | -------------------- |
|
|
780
|
+
| `number` | `Number` | The value to convert |
|
|
781
781
|
|
|
782
782
|
Returns:
|
|
783
783
|
|
|
784
|
-
|type|description|
|
|
785
|
-
|
|
786
|
-
|
|
784
|
+
| type | description |
|
|
785
|
+
| --------- | ----------------------------------- |
|
|
786
|
+
| `Float32` | The Number represented as a Float32 |
|
|
787
787
|
|
|
788
788
|
### Numbers.**coerceNumberToFloat64**
|
|
789
789
|
|
|
@@ -800,15 +800,15 @@ Converts a Number to a Float64.
|
|
|
800
800
|
|
|
801
801
|
Parameters:
|
|
802
802
|
|
|
803
|
-
|param|type|description|
|
|
804
|
-
|
|
805
|
-
|
|
803
|
+
| param | type | description |
|
|
804
|
+
| -------- | -------- | -------------------- |
|
|
805
|
+
| `number` | `Number` | The value to convert |
|
|
806
806
|
|
|
807
807
|
Returns:
|
|
808
808
|
|
|
809
|
-
|type|description|
|
|
810
|
-
|
|
811
|
-
|
|
809
|
+
| type | description |
|
|
810
|
+
| --------- | ----------------------------------- |
|
|
811
|
+
| `Float64` | The Number represented as a Float64 |
|
|
812
812
|
|
|
813
813
|
### Numbers.**coerceInt8ToNumber**
|
|
814
814
|
|
|
@@ -825,15 +825,15 @@ Converts an Int8 to a Number.
|
|
|
825
825
|
|
|
826
826
|
Parameters:
|
|
827
827
|
|
|
828
|
-
|param|type|description|
|
|
829
|
-
|
|
830
|
-
|
|
828
|
+
| param | type | description |
|
|
829
|
+
| ------- | ------ | -------------------- |
|
|
830
|
+
| `value` | `Int8` | The value to convert |
|
|
831
831
|
|
|
832
832
|
Returns:
|
|
833
833
|
|
|
834
|
-
|type|description|
|
|
835
|
-
|
|
836
|
-
|
|
834
|
+
| type | description |
|
|
835
|
+
| -------- | -------------------------------- |
|
|
836
|
+
| `Number` | The Int8 represented as a Number |
|
|
837
837
|
|
|
838
838
|
### Numbers.**coerceInt16ToNumber**
|
|
839
839
|
|
|
@@ -850,15 +850,15 @@ Converts an Int16 to a Number.
|
|
|
850
850
|
|
|
851
851
|
Parameters:
|
|
852
852
|
|
|
853
|
-
|param|type|description|
|
|
854
|
-
|
|
855
|
-
|
|
853
|
+
| param | type | description |
|
|
854
|
+
| ------- | ------- | -------------------- |
|
|
855
|
+
| `value` | `Int16` | The value to convert |
|
|
856
856
|
|
|
857
857
|
Returns:
|
|
858
858
|
|
|
859
|
-
|type|description|
|
|
860
|
-
|
|
861
|
-
|
|
859
|
+
| type | description |
|
|
860
|
+
| -------- | --------------------------------- |
|
|
861
|
+
| `Number` | The Int16 represented as a Number |
|
|
862
862
|
|
|
863
863
|
### Numbers.**coerceUint8ToNumber**
|
|
864
864
|
|
|
@@ -875,15 +875,15 @@ Converts a Uint8 to a Number.
|
|
|
875
875
|
|
|
876
876
|
Parameters:
|
|
877
877
|
|
|
878
|
-
|param|type|description|
|
|
879
|
-
|
|
880
|
-
|
|
878
|
+
| param | type | description |
|
|
879
|
+
| ------- | ------- | -------------------- |
|
|
880
|
+
| `value` | `Uint8` | The value to convert |
|
|
881
881
|
|
|
882
882
|
Returns:
|
|
883
883
|
|
|
884
|
-
|type|description|
|
|
885
|
-
|
|
886
|
-
|
|
884
|
+
| type | description |
|
|
885
|
+
| -------- | --------------------------------- |
|
|
886
|
+
| `Number` | The Uint8 represented as a Number |
|
|
887
887
|
|
|
888
888
|
### Numbers.**coerceUint16ToNumber**
|
|
889
889
|
|
|
@@ -900,15 +900,15 @@ Converts a Uint16 to a Number.
|
|
|
900
900
|
|
|
901
901
|
Parameters:
|
|
902
902
|
|
|
903
|
-
|param|type|description|
|
|
904
|
-
|
|
905
|
-
|
|
903
|
+
| param | type | description |
|
|
904
|
+
| ------- | -------- | -------------------- |
|
|
905
|
+
| `value` | `Uint16` | The value to convert |
|
|
906
906
|
|
|
907
907
|
Returns:
|
|
908
908
|
|
|
909
|
-
|type|description|
|
|
910
|
-
|
|
911
|
-
|
|
909
|
+
| type | description |
|
|
910
|
+
| -------- | ---------------------------------- |
|
|
911
|
+
| `Number` | The Uint16 represented as a Number |
|
|
912
912
|
|
|
913
913
|
### Numbers.**coerceInt32ToNumber**
|
|
914
914
|
|
|
@@ -925,15 +925,15 @@ Converts an Int32 to a Number.
|
|
|
925
925
|
|
|
926
926
|
Parameters:
|
|
927
927
|
|
|
928
|
-
|param|type|description|
|
|
929
|
-
|
|
930
|
-
|
|
928
|
+
| param | type | description |
|
|
929
|
+
| ------- | ------- | -------------------- |
|
|
930
|
+
| `value` | `Int32` | The value to convert |
|
|
931
931
|
|
|
932
932
|
Returns:
|
|
933
933
|
|
|
934
|
-
|type|description|
|
|
935
|
-
|
|
936
|
-
|
|
934
|
+
| type | description |
|
|
935
|
+
| -------- | --------------------------------- |
|
|
936
|
+
| `Number` | The Int32 represented as a Number |
|
|
937
937
|
|
|
938
938
|
### Numbers.**coerceInt64ToNumber**
|
|
939
939
|
|
|
@@ -950,15 +950,15 @@ Converts an Int64 to a Number.
|
|
|
950
950
|
|
|
951
951
|
Parameters:
|
|
952
952
|
|
|
953
|
-
|param|type|description|
|
|
954
|
-
|
|
955
|
-
|
|
953
|
+
| param | type | description |
|
|
954
|
+
| ------- | ------- | -------------------- |
|
|
955
|
+
| `value` | `Int64` | The value to convert |
|
|
956
956
|
|
|
957
957
|
Returns:
|
|
958
958
|
|
|
959
|
-
|type|description|
|
|
960
|
-
|
|
961
|
-
|
|
959
|
+
| type | description |
|
|
960
|
+
| -------- | --------------------------------- |
|
|
961
|
+
| `Number` | The Int64 represented as a Number |
|
|
962
962
|
|
|
963
963
|
### Numbers.**coerceBigIntToNumber**
|
|
964
964
|
|
|
@@ -975,15 +975,15 @@ Converts a BigInt to a Number.
|
|
|
975
975
|
|
|
976
976
|
Parameters:
|
|
977
977
|
|
|
978
|
-
|param|type|description|
|
|
979
|
-
|
|
980
|
-
|
|
978
|
+
| param | type | description |
|
|
979
|
+
| ----- | -------- | -------------------- |
|
|
980
|
+
| `num` | `BigInt` | The value to convert |
|
|
981
981
|
|
|
982
982
|
Returns:
|
|
983
983
|
|
|
984
|
-
|type|description|
|
|
985
|
-
|
|
986
|
-
|
|
984
|
+
| type | description |
|
|
985
|
+
| -------- | ---------------------------------- |
|
|
986
|
+
| `Number` | The BigInt represented as a Number |
|
|
987
987
|
|
|
988
988
|
### Numbers.**coerceRationalToNumber**
|
|
989
989
|
|
|
@@ -1000,15 +1000,15 @@ Converts a Rational to a Number.
|
|
|
1000
1000
|
|
|
1001
1001
|
Parameters:
|
|
1002
1002
|
|
|
1003
|
-
|param|type|description|
|
|
1004
|
-
|
|
1005
|
-
|
|
1003
|
+
| param | type | description |
|
|
1004
|
+
| ---------- | ---------- | -------------------- |
|
|
1005
|
+
| `rational` | `Rational` | The value to convert |
|
|
1006
1006
|
|
|
1007
1007
|
Returns:
|
|
1008
1008
|
|
|
1009
|
-
|type|description|
|
|
1010
|
-
|
|
1011
|
-
|
|
1009
|
+
| type | description |
|
|
1010
|
+
| -------- | ------------------------------------ |
|
|
1011
|
+
| `Number` | The Rational represented as a Number |
|
|
1012
1012
|
|
|
1013
1013
|
### Numbers.**coerceFloat32ToNumber**
|
|
1014
1014
|
|
|
@@ -1025,15 +1025,15 @@ Converts a Float32 to a Number.
|
|
|
1025
1025
|
|
|
1026
1026
|
Parameters:
|
|
1027
1027
|
|
|
1028
|
-
|param|type|description|
|
|
1029
|
-
|
|
1030
|
-
|
|
1028
|
+
| param | type | description |
|
|
1029
|
+
| ------- | --------- | -------------------- |
|
|
1030
|
+
| `float` | `Float32` | The value to convert |
|
|
1031
1031
|
|
|
1032
1032
|
Returns:
|
|
1033
1033
|
|
|
1034
|
-
|type|description|
|
|
1035
|
-
|
|
1036
|
-
|
|
1034
|
+
| type | description |
|
|
1035
|
+
| -------- | ----------------------------------- |
|
|
1036
|
+
| `Number` | The Float32 represented as a Number |
|
|
1037
1037
|
|
|
1038
1038
|
### Numbers.**coerceFloat64ToNumber**
|
|
1039
1039
|
|
|
@@ -1050,15 +1050,15 @@ Converts a Float64 to a Number.
|
|
|
1050
1050
|
|
|
1051
1051
|
Parameters:
|
|
1052
1052
|
|
|
1053
|
-
|param|type|description|
|
|
1054
|
-
|
|
1055
|
-
|
|
1053
|
+
| param | type | description |
|
|
1054
|
+
| ------- | --------- | -------------------- |
|
|
1055
|
+
| `float` | `Float64` | The value to convert |
|
|
1056
1056
|
|
|
1057
1057
|
Returns:
|
|
1058
1058
|
|
|
1059
|
-
|type|description|
|
|
1060
|
-
|
|
1061
|
-
|
|
1059
|
+
| type | description |
|
|
1060
|
+
| -------- | ----------------------------------- |
|
|
1061
|
+
| `Number` | The Float64 represented as a Number |
|
|
1062
1062
|
|
|
1063
1063
|
### Numbers.**convertExactToInexact**
|
|
1064
1064
|
|
|
@@ -1087,16 +1087,16 @@ Computes the sum of its operands.
|
|
|
1087
1087
|
|
|
1088
1088
|
Parameters:
|
|
1089
1089
|
|
|
1090
|
-
|param|type|description|
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1090
|
+
| param | type | description |
|
|
1091
|
+
| ------ | -------- | ------------------ |
|
|
1092
|
+
| `num1` | `Number` | The first operand |
|
|
1093
|
+
| `num2` | `Number` | The second operand |
|
|
1094
1094
|
|
|
1095
1095
|
Returns:
|
|
1096
1096
|
|
|
1097
|
-
|type|description|
|
|
1098
|
-
|
|
1099
|
-
|
|
1097
|
+
| type | description |
|
|
1098
|
+
| -------- | --------------------------- |
|
|
1099
|
+
| `Number` | The sum of the two operands |
|
|
1100
1100
|
|
|
1101
1101
|
### Numbers.**(-)**
|
|
1102
1102
|
|
|
@@ -1113,16 +1113,16 @@ Computes the difference of its operands.
|
|
|
1113
1113
|
|
|
1114
1114
|
Parameters:
|
|
1115
1115
|
|
|
1116
|
-
|param|type|description|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1116
|
+
| param | type | description |
|
|
1117
|
+
| ------ | -------- | ------------------ |
|
|
1118
|
+
| `num1` | `Number` | The first operand |
|
|
1119
|
+
| `num2` | `Number` | The second operand |
|
|
1120
1120
|
|
|
1121
1121
|
Returns:
|
|
1122
1122
|
|
|
1123
|
-
|type|description|
|
|
1124
|
-
|
|
1125
|
-
|
|
1123
|
+
| type | description |
|
|
1124
|
+
| -------- | ---------------------------------- |
|
|
1125
|
+
| `Number` | The difference of the two operands |
|
|
1126
1126
|
|
|
1127
1127
|
### Numbers.**(*)**
|
|
1128
1128
|
|
|
@@ -1139,16 +1139,16 @@ Computes the product of its operands.
|
|
|
1139
1139
|
|
|
1140
1140
|
Parameters:
|
|
1141
1141
|
|
|
1142
|
-
|param|type|description|
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1142
|
+
| param | type | description |
|
|
1143
|
+
| ------ | -------- | ------------------ |
|
|
1144
|
+
| `num1` | `Number` | The first operand |
|
|
1145
|
+
| `num2` | `Number` | The second operand |
|
|
1146
1146
|
|
|
1147
1147
|
Returns:
|
|
1148
1148
|
|
|
1149
|
-
|type|description|
|
|
1150
|
-
|
|
1151
|
-
|
|
1149
|
+
| type | description |
|
|
1150
|
+
| -------- | ------------------------------- |
|
|
1151
|
+
| `Number` | The product of the two operands |
|
|
1152
1152
|
|
|
1153
1153
|
### Numbers.**(/)**
|
|
1154
1154
|
|
|
@@ -1165,16 +1165,16 @@ Computes the quotient of its operands.
|
|
|
1165
1165
|
|
|
1166
1166
|
Parameters:
|
|
1167
1167
|
|
|
1168
|
-
|param|type|description|
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1168
|
+
| param | type | description |
|
|
1169
|
+
| ------ | -------- | ------------------ |
|
|
1170
|
+
| `num1` | `Number` | The first operand |
|
|
1171
|
+
| `num2` | `Number` | The second operand |
|
|
1172
1172
|
|
|
1173
1173
|
Returns:
|
|
1174
1174
|
|
|
1175
|
-
|type|description|
|
|
1176
|
-
|
|
1177
|
-
|
|
1175
|
+
| type | description |
|
|
1176
|
+
| -------- | -------------------------------- |
|
|
1177
|
+
| `Number` | The quotient of the two operands |
|
|
1178
1178
|
|
|
1179
1179
|
### Numbers.**(%)**
|
|
1180
1180
|
|
|
@@ -1192,16 +1192,16 @@ The result will have the sign of the second operand.
|
|
|
1192
1192
|
|
|
1193
1193
|
Parameters:
|
|
1194
1194
|
|
|
1195
|
-
|param|type|description|
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1195
|
+
| param | type | description |
|
|
1196
|
+
| ------ | -------- | ------------------ |
|
|
1197
|
+
| `num1` | `Number` | The first operand |
|
|
1198
|
+
| `num2` | `Number` | The second operand |
|
|
1199
1199
|
|
|
1200
1200
|
Returns:
|
|
1201
1201
|
|
|
1202
|
-
|type|description|
|
|
1203
|
-
|
|
1204
|
-
|
|
1202
|
+
| type | description |
|
|
1203
|
+
| -------- | --------------------------- |
|
|
1204
|
+
| `Number` | The modulus of its operands |
|
|
1205
1205
|
|
|
1206
1206
|
### Numbers.**incr**
|
|
1207
1207
|
|
|
@@ -1218,15 +1218,15 @@ Increments the value by one.
|
|
|
1218
1218
|
|
|
1219
1219
|
Parameters:
|
|
1220
1220
|
|
|
1221
|
-
|param|type|description|
|
|
1222
|
-
|
|
1223
|
-
|
|
1221
|
+
| param | type | description |
|
|
1222
|
+
| ------- | -------- | ---------------------- |
|
|
1223
|
+
| `value` | `Number` | The value to increment |
|
|
1224
1224
|
|
|
1225
1225
|
Returns:
|
|
1226
1226
|
|
|
1227
|
-
|type|description|
|
|
1228
|
-
|
|
1229
|
-
|
|
1227
|
+
| type | description |
|
|
1228
|
+
| -------- | --------------------- |
|
|
1229
|
+
| `Number` | The incremented value |
|
|
1230
1230
|
|
|
1231
1231
|
### Numbers.**decr**
|
|
1232
1232
|
|
|
@@ -1243,15 +1243,15 @@ Decrements the value by one.
|
|
|
1243
1243
|
|
|
1244
1244
|
Parameters:
|
|
1245
1245
|
|
|
1246
|
-
|param|type|description|
|
|
1247
|
-
|
|
1248
|
-
|
|
1246
|
+
| param | type | description |
|
|
1247
|
+
| ------- | -------- | ---------------------- |
|
|
1248
|
+
| `value` | `Number` | The value to decrement |
|
|
1249
1249
|
|
|
1250
1250
|
Returns:
|
|
1251
1251
|
|
|
1252
|
-
|type|description|
|
|
1253
|
-
|
|
1254
|
-
|
|
1252
|
+
| type | description |
|
|
1253
|
+
| -------- | --------------------- |
|
|
1254
|
+
| `Number` | The decremented value |
|
|
1255
1255
|
|
|
1256
1256
|
### Numbers.**isBigInt**
|
|
1257
1257
|
|
|
@@ -1274,16 +1274,16 @@ Multiplies a floating-point number by an integral power of 2.
|
|
|
1274
1274
|
|
|
1275
1275
|
Parameters:
|
|
1276
1276
|
|
|
1277
|
-
|param|type|description|
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1277
|
+
| param | type | description |
|
|
1278
|
+
| ----- | --------- | ------------------------ |
|
|
1279
|
+
| `x` | `WasmF64` | The floating-point value |
|
|
1280
|
+
| `n` | `WasmI32` | The Integer exponent |
|
|
1281
1281
|
|
|
1282
1282
|
Returns:
|
|
1283
1283
|
|
|
1284
|
-
|type|description|
|
|
1285
|
-
|
|
1286
|
-
|
|
1284
|
+
| type | description |
|
|
1285
|
+
| --------- | --------------------- |
|
|
1286
|
+
| `WasmF64` | The result of x * 2^n |
|
|
1287
1287
|
|
|
1288
1288
|
### Numbers.**powf**
|
|
1289
1289
|
|
|
@@ -1313,14 +1313,14 @@ Computes the exponentiation of the given base and power.
|
|
|
1313
1313
|
|
|
1314
1314
|
Parameters:
|
|
1315
1315
|
|
|
1316
|
-
|param|type|description|
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1316
|
+
| param | type | description |
|
|
1317
|
+
| ------- | -------- | ------------------- |
|
|
1318
|
+
| `base` | `Number` | The base number |
|
|
1319
|
+
| `power` | `Number` | The exponent number |
|
|
1320
1320
|
|
|
1321
1321
|
Returns:
|
|
1322
1322
|
|
|
1323
|
-
|type|description|
|
|
1324
|
-
|
|
1325
|
-
|
|
1323
|
+
| type | description |
|
|
1324
|
+
| -------- | ---------------------------------- |
|
|
1325
|
+
| `Number` | The base raised to the given power |
|
|
1326
1326
|
|