3.1.7
This commit is contained in:
parent
40daed128e
commit
b967f954b3
|
@ -1,7 +1,7 @@
|
||||||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
||||||
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
|
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
|
||||||
[![Node.js CI](https://github.com/juanelas/bigint-crypto-utils/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/juanelas/bigint-crypto-utils/actions/workflows/build-and-test.yml)
|
[![Node.js CI](https://github.com/juanelas/bigint-crypto-utils/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/juanelas/bigint-crypto-utils/actions/workflows/build-and-test.yml)
|
||||||
[![Coverage Status](https://coveralls.io/repos/github/juanelas/bigint-crypto-utils/badge.svg?branch=master)](https://coveralls.io/github/juanelas/bigint-crypto-utils?branch=master)
|
[![Coverage Status](https://coveralls.io/repos/github/juanelas/bigint-crypto-utils/badge.svg?branch=main)](https://coveralls.io/github/juanelas/bigint-crypto-utils?branch=main)
|
||||||
|
|
||||||
# bigint-crypto-utils
|
# bigint-crypto-utils
|
||||||
|
|
||||||
|
@ -40,7 +40,7 @@ The appropriate version for browser or node is automatically exported.
|
||||||
> 1. If you experience issues using webpack/babel to create your production bundles, you may edit the supported browsers list and leave only [supported browsers and versions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility). The browsers list is usually located in your project's `package.json` or the `.browserslistrc` file.
|
> 1. If you experience issues using webpack/babel to create your production bundles, you may edit the supported browsers list and leave only [supported browsers and versions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility). The browsers list is usually located in your project's `package.json` or the `.browserslistrc` file.
|
||||||
> 2. In order to use `bigint-crypto-utils` with TypeScript you need to set `target`, and `lib` and `module` if in use, to `ES2020` in your project's `tsconfig.json`.
|
> 2. In order to use `bigint-crypto-utils` with TypeScript you need to set `target`, and `lib` and `module` if in use, to `ES2020` in your project's `tsconfig.json`.
|
||||||
|
|
||||||
You can also download the [IIFE bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/dist/bundles/iife.js), the [ESM bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/dist/bundles/esm.min.js) or the [UMD bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/dist/bundles/umd.js) and manually add it to your project, or, if you have already installed `bigint-crypto-utils` in your project, just get the bundles from `node_modules/bigint-crypto-utils/dist/bundles/`.
|
You can also download the [IIFE bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/main/dist/bundles/iife.js), the [ESM bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/main/dist/bundles/esm.min.js) or the [UMD bundle](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/main/dist/bundles/umd.js) and manually add it to your project, or, if you have already installed `bigint-crypto-utils` in your project, just get the bundles from `node_modules/bigint-crypto-utils/dist/bundles/`.
|
||||||
|
|
||||||
An example of usage could be (complete examples can be found in the [examples](https://github.com/juanelas/bigint-crypto-utils/tree/master/examples) directory):
|
An example of usage could be (complete examples can be found in the [examples](https://github.com/juanelas/bigint-crypto-utils/tree/master/examples) directory):
|
||||||
|
|
||||||
|
|
18
docs/API.md
18
docs/API.md
|
@ -1,4 +1,4 @@
|
||||||
# bigint-crypto-utils - v3.1.6
|
# bigint-crypto-utils - v3.1.7
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
|
@ -155,7 +155,7 @@ A promise that resolves to a boolean that is either true (a probably prime numbe
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/isProbablyPrime.ts:20](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/isProbablyPrime.ts#L20)
|
[src/ts/isProbablyPrime.ts:20](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/isProbablyPrime.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
@ -322,7 +322,7 @@ A promise that resolves to a bigint probable prime of bitLength bits.
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/prime.ts:28](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/prime.ts#L28)
|
[src/ts/prime.ts:28](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/prime.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
@ -352,7 +352,7 @@ A bigint probable prime of bitLength bits.
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/prime.ts:109](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/prime.ts#L109)
|
[src/ts/prime.ts:109](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/prime.ts#L109)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
@ -381,7 +381,7 @@ A cryptographically secure random bigint between [min,max]
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/randBetween.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBetween.ts#L14)
|
[src/ts/randBetween.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/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
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/randBits.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBits.ts#L13)
|
[src/ts/randBits.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/randBits.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
@ -439,7 +439,7 @@ A Uint8Array/Buffer (Browser/Node.js) filled with cryptographically secure rando
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/randBits.ts:43](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBits.ts#L43)
|
[src/ts/randBits.ts:43](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/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
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/randBytes.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBytes.ts#L13)
|
[src/ts/randBytes.ts:13](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/randBytes.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
@ -498,7 +498,7 @@ A UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure rando
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/ts/randBytes.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/2192825/src/ts/randBytes.ts#L45)
|
[src/ts/randBytes.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/40daed1/src/ts/randBytes.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
{
|
{
|
||||||
"name": "bigint-crypto-utils",
|
"name": "bigint-crypto-utils",
|
||||||
"version": "3.1.6",
|
"version": "3.1.7",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "bigint-crypto-utils",
|
"name": "bigint-crypto-utils",
|
||||||
"version": "3.1.6",
|
"version": "3.1.7",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"bigint-mod-arith": "^3.1.0"
|
"bigint-mod-arith": "^3.1.0"
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "bigint-crypto-utils",
|
"name": "bigint-crypto-utils",
|
||||||
"version": "3.1.6",
|
"version": "3.1.7",
|
||||||
"description": "Arbitrary precision modular arithmetic, cryptographically secure random numbers and strong probable prime generation/testing. It works in modern browsers, Angular, React, Node.js, etc. since it uses the native JS implementation of BigInt",
|
"description": "Arbitrary precision modular arithmetic, cryptographically secure random numbers and strong probable prime generation/testing. It works in modern browsers, Angular, React, Node.js, etc. since it uses the native JS implementation of BigInt",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"modular arithmetics",
|
"modular arithmetics",
|
||||||
|
|
Loading…
Reference in New Issue