From 360d06b4b227230616f4e9273391751f8fcb88f0 Mon Sep 17 00:00:00 2001 From: Juanra Dikal Date: Mon, 3 Oct 2022 23:20:46 +0200 Subject: [PATCH] minor fixes --- README.md | 6 +++--- docs/API.md | 16 ++++++++-------- src/docs/index.md | 6 +++--- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 232e0af..3e32b7d 100644 --- a/README.md +++ b/README.md @@ -61,13 +61,13 @@ console.log(bigintCryptoUtils.modInv(2n, 5n)) // prints 3 console.log(bigintCryptoUtils.modInv(BigInt('3'), BigInt('5'))) // prints 2 -console.log(bigintCryptoUtils.randBetween(2n ** 256n)) // Prints a cryptographically secure random number between 1 and 2**256 (both included). +console.log(bigintCryptoUtils.randBetween(2n ** 256n)) // prints a cryptographically secure random number between 1 and 2**256 (both included). async function primeTesting (): void { - // Output of a probable prime of 2048 bits + // Let us print out a probable prime of 2048 bits console.log(await bigintCryptoUtils.prime(2048)) - // Testing if a number is a probable prime (Miller-Rabin) + // Testing if number is a probable prime (Miller-Rabin) const number = 27n const isPrime = await bigintCryptoUtils.isProbablyPrime(number) if (isPrime === true) { diff --git a/docs/API.md b/docs/API.md index b0148a3..43fe953 100644 --- a/docs/API.md +++ b/docs/API.md @@ -155,7 +155,7 @@ A promise that resolves to a boolean that is either true (a probably prime numbe #### Defined in -[src/ts/isProbablyPrime.ts:20](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/isProbablyPrime.ts#L20) +[src/ts/isProbablyPrime.ts:20](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/isProbablyPrime.ts#L20) ___ @@ -322,7 +322,7 @@ A promise that resolves to a bigint probable prime of bitLength bits. #### Defined in -[src/ts/prime.ts:28](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/prime.ts#L28) +[src/ts/prime.ts:28](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/prime.ts#L28) ___ @@ -352,7 +352,7 @@ A bigint probable prime of bitLength bits. #### Defined in -[src/ts/prime.ts:109](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/prime.ts#L109) +[src/ts/prime.ts:109](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/prime.ts#L109) ___ @@ -381,7 +381,7 @@ A cryptographically secure random bigint between [min,max] #### Defined in -[src/ts/randBetween.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/randBetween.ts#L14) +[src/ts/randBetween.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBetween.ts#L14) ___ @@ -410,7 +410,7 @@ A Promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cry #### Defined in -[src/ts/randBits.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/randBits.ts#L13) +[src/ts/randBits.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBits.ts#L13) ___ @@ -439,7 +439,7 @@ A Uint8Array/Buffer (Browser/Node.js) filled with cryptographically secure rando #### Defined in -[src/ts/randBits.ts:43](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/randBits.ts#L43) +[src/ts/randBits.ts:43](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBits.ts#L43) ___ @@ -468,7 +468,7 @@ A promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cry #### Defined in -[src/ts/randBytes.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/randBytes.ts#L13) +[src/ts/randBytes.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBytes.ts#L13) ___ @@ -498,7 +498,7 @@ A UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure rando #### Defined in -[src/ts/randBytes.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/3138bfa/src/ts/randBytes.ts#L45) +[src/ts/randBytes.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBytes.ts#L45) ___ diff --git a/src/docs/index.md b/src/docs/index.md index 9ddeb50..93c9d69 100644 --- a/src/docs/index.md +++ b/src/docs/index.md @@ -60,13 +60,13 @@ console.log(bigintCryptoUtils.modInv(2n, 5n)) // prints 3 console.log(bigintCryptoUtils.modInv(BigInt('3'), BigInt('5'))) // prints 2 -console.log(bigintCryptoUtils.randBetween(2n ** 256n)) // Prints a cryptographically secure random number between 1 and 2**256 (both included). +console.log(bigintCryptoUtils.randBetween(2n ** 256n)) // prints a cryptographically secure random number between 1 and 2**256 (both included). async function primeTesting (): void { - // Output of a probable prime of 2048 bits + // Let us print out a probable prime of 2048 bits console.log(await bigintCryptoUtils.prime(2048)) - // Testing if a number is a probable prime (Miller-Rabin) + // Testing if number is a probable prime (Miller-Rabin) const number = 27n const isPrime = await bigintCryptoUtils.isProbablyPrime(number) if (isPrime === true) {