LumeWeb
/
bigint-crypto-utils
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

better integration of docs generation

This commit is contained in:
Juanra Dikal 2021-04-21 20:30:13 +02:00
parent d6064148a8
commit 91b290be23
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build/build.docs.js
View File

@ -25,7 +25,7 @@ async function typedoc () {
// typedoc options here // typedoc options here
entryPoints: ['src/index.ts'], entryPoints: ['src/index.ts'],
plugin: ['typedoc-plugin-markdown'], plugin: ['typedoc-plugin-markdown'],
includeVersion: false, includeVersion: true,
entryDocument: 'API.md', entryDocument: 'API.md',
readme: 'none', readme: 'none',
hideBreadcrumbs: true hideBreadcrumbs: true

18
docs/API.md
View File

@ -1,4 +1,4 @@
# bigint-crypto-utils # bigint-crypto-utils - v3.0.13
## Table of contents ## Table of contents
@ -133,7 +133,7 @@ w MUST be >= 0
A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite) A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite)
Defined in: [src/ts/isProbablyPrime.ts:21](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/isProbablyPrime.ts#L21) Defined in: [src/ts/isProbablyPrime.ts:21](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/isProbablyPrime.ts#L21)
___ ___
@ -273,7 +273,7 @@ bitLength MUST be > 0
A promise that resolves to a bigint probable prime of bitLength bits. A promise that resolves to a bigint probable prime of bitLength bits.
Defined in: [src/ts/prime.ts:21](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/prime.ts#L21) Defined in: [src/ts/prime.ts:21](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/prime.ts#L21)
___ ___
@ -298,7 +298,7 @@ bitLength MUST be > 0
A bigint probable prime of bitLength bits. A bigint probable prime of bitLength bits.
Defined in: [src/ts/prime.ts:100](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/prime.ts#L100) Defined in: [src/ts/prime.ts:100](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/prime.ts#L100)
___ ___
@ -322,7 +322,7 @@ Arguments MUST be: max > 0 && min >=0 && max > min
A cryptographically secure random bigint between [min,max] A cryptographically secure random bigint between [min,max]
Defined in: [src/ts/randBetween.ts:15](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/randBetween.ts#L15) Defined in: [src/ts/randBetween.ts:15](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/randBetween.ts#L15)
___ ___
@ -346,7 +346,7 @@ bitLength MUST be > 0
A Promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bits A Promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bits
Defined in: [src/ts/randBits.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/randBits.ts#L14) Defined in: [src/ts/randBits.ts:14](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/randBits.ts#L14)
___ ___
@ -370,7 +370,7 @@ bitLength MUST be > 0
A Uint8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bits A Uint8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bits
Defined in: [src/ts/randBits.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/randBits.ts#L45) Defined in: [src/ts/randBits.ts:45](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/randBits.ts#L45)
___ ___
@ -394,7 +394,7 @@ byteLength MUST be > 0
A promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bytes A promise that resolves to a UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bytes
Defined in: [src/ts/randBytes.ts:12](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/randBytes.ts#L12) Defined in: [src/ts/randBytes.ts:12](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/randBytes.ts#L12)
___ ___
@ -418,7 +418,7 @@ byteLength MUST be > 0
A UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bytes A UInt8Array/Buffer (Browser/Node.js) filled with cryptographically secure random bytes
Defined in: [src/ts/randBytes.ts:46](https://github.com/juanelas/bigint-crypto-utils/blob/5bba6de/src/ts/randBytes.ts#L46) Defined in: [src/ts/randBytes.ts:46](https://github.com/juanelas/bigint-crypto-utils/blob/d606414/src/ts/randBytes.ts#L46)
___ ___

2
package.json
View File

@ -52,11 +52,13 @@
"build": "run-s lint build:js docs test:browser coverage", "build": "run-s lint build:js docs test:browser coverage",
"build:js": "rollup -c build/rollup.config.js", "build:js": "rollup -c build/rollup.config.js",
"clean": "rimraf .nyc_output .mocha-ts coverage dist docs", "clean": "rimraf .nyc_output .mocha-ts coverage dist docs",
"commitversion": "git commit -a -m \"v$npm_package_version\"",
"coverage": "nyc --check-coverage --exclude build --exclude '{src/**/*.spec.ts,test/**/*.ts}' --reporter=text --reporter=lcov node ./build/bin/mocha-ts.js --require build/testing/mocha/mocha-init.js '{src/**/*.spec.ts,test/**/*.ts}'", "coverage": "nyc --check-coverage --exclude build --exclude '{src/**/*.spec.ts,test/**/*.ts}' --reporter=text --reporter=lcov node ./build/bin/mocha-ts.js --require build/testing/mocha/mocha-init.js '{src/**/*.spec.ts,test/**/*.ts}'",
"docs": "node build/build.docs.js", "docs": "node build/build.docs.js",
"lint": "ts-standard --fix", "lint": "ts-standard --fix",
"mocha": "node ./build/bin/mocha-ts.js --require build/testing/mocha/mocha-init.js ", "mocha": "node ./build/bin/mocha-ts.js --require build/testing/mocha/mocha-init.js ",
"preversion": "npm run build", "preversion": "npm run build",
"postversion": "run-s docs commitversion",
"test": "run-s test:browser test:node", "test": "run-s test:browser test:node",
"test:browser": "node build/testing/browser/index.js", "test:browser": "node build/testing/browser/index.js",
"test:node": "npm run mocha -- '{src/**/*.spec.ts,test/**/*.ts}'", "test:node": "npm run mocha -- '{src/**/*.spec.ts,test/**/*.ts}'",