From a95999c88a3aad31b90d440bb05ea5a63413ad9f Mon Sep 17 00:00:00 2001 From: "daws.eth" Date: Sun, 1 May 2022 22:27:28 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=93=20Fix=20markdown=20utils=20links?= =?UTF-8?q?=20for=20camelcased=20fns?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 46 ++++++++++++------------- scripts/markdown-magic/parse-typedoc.js | 2 +- 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/readme.md b/readme.md index d6e1ffa2..a7da8bf3 100644 --- a/readme.md +++ b/readme.md @@ -37,8 +37,6 @@
-
- ## Table of Contents @@ -174,7 +172,7 @@ concat([0, 1]);
-#### [`etherToGwei`](https://essential-eth.vercel.app/docs/api/modules#etherToGwei) +#### [`etherToGwei`](https://essential-eth.vercel.app/docs/api/modules#ethertogwei) ```typescript etherToGwei(etherQuantity: string | number | TinyBig | Big): TinyBig @@ -208,7 +206,7 @@ etherToGwei(1000).toNumber();
-#### [`etherToWei`](https://essential-eth.vercel.app/docs/api/modules#etherToWei) +#### [`etherToWei`](https://essential-eth.vercel.app/docs/api/modules#ethertowei) ```typescript etherToWei(etherQuantity: string | number | TinyBig | Big): TinyBig @@ -242,7 +240,7 @@ etherToWei(1000).toNumber();
-#### [`gweiToEther`](https://essential-eth.vercel.app/docs/api/modules#gweiToEther) +#### [`gweiToEther`](https://essential-eth.vercel.app/docs/api/modules#gweitoether) ```typescript gweiToEther(gweiQuantity: string | number | TinyBig | Big): TinyBig @@ -276,7 +274,7 @@ gweiToEther(1000000000000).toNumber();
-#### [`hashMessage`](https://essential-eth.vercel.app/docs/api/modules#hashMessage) +#### [`hashMessage`](https://essential-eth.vercel.app/docs/api/modules#hashmessage) ```typescript hashMessage(message: string | Bytes): string @@ -301,7 +299,7 @@ hashMessage('Hello World');
-#### [`hexConcat`](https://essential-eth.vercel.app/docs/api/modules#hexConcat) +#### [`hexConcat`](https://essential-eth.vercel.app/docs/api/modules#hexconcat) ```typescript hexConcat(items: Array): string @@ -309,7 +307,7 @@ hexConcat(items: Array): string
-#### [`hexDataLength`](https://essential-eth.vercel.app/docs/api/modules#hexDataLength) +#### [`hexDataLength`](https://essential-eth.vercel.app/docs/api/modules#hexdatalength) ```typescript hexDataLength(data: BytesLike): null | number @@ -317,7 +315,7 @@ hexDataLength(data: BytesLike): null | number
-#### [`hexDataSlice`](https://essential-eth.vercel.app/docs/api/modules#hexDataSlice) +#### [`hexDataSlice`](https://essential-eth.vercel.app/docs/api/modules#hexdataslice) ```typescript hexDataSlice(data: BytesLikeWithNumber, offset: number, endOffset: number): string @@ -325,7 +323,7 @@ hexDataSlice(data: BytesLikeWithNumber, offset: number, endOffset: number): stri
-#### [`hexStripZeros`](https://essential-eth.vercel.app/docs/api/modules#hexStripZeros) +#### [`hexStripZeros`](https://essential-eth.vercel.app/docs/api/modules#hexstripzeros) ```typescript hexStripZeros(value: BytesLike): string @@ -333,7 +331,7 @@ hexStripZeros(value: BytesLike): string
-#### [`hexValue`](https://essential-eth.vercel.app/docs/api/modules#hexValue) +#### [`hexValue`](https://essential-eth.vercel.app/docs/api/modules#hexvalue) ```typescript hexValue(value: number | bigint | BytesLike | Hexable): string @@ -341,7 +339,7 @@ hexValue(value: number | bigint | BytesLike | Hexable): string
-#### [`hexZeroPad`](https://essential-eth.vercel.app/docs/api/modules#hexZeroPad) +#### [`hexZeroPad`](https://essential-eth.vercel.app/docs/api/modules#hexzeropad) ```typescript hexZeroPad(value: BytesLikeWithNumber, length: number): string @@ -404,7 +402,7 @@ hexlify(14);
-#### [`isAddress`](https://essential-eth.vercel.app/docs/api/modules#isAddress) +#### [`isAddress`](https://essential-eth.vercel.app/docs/api/modules#isaddress) ```typescript isAddress(address: string): boolean @@ -440,7 +438,7 @@ isAddress('vitalik.eth');
-#### [`isBytes`](https://essential-eth.vercel.app/docs/api/modules#isBytes) +#### [`isBytes`](https://essential-eth.vercel.app/docs/api/modules#isbytes) ```typescript isBytes(value: any): value @@ -475,7 +473,7 @@ isBytes(new Uint8Array(1));
-#### [`isBytesLike`](https://essential-eth.vercel.app/docs/api/modules#isBytesLike) +#### [`isBytesLike`](https://essential-eth.vercel.app/docs/api/modules#isbyteslike) ```typescript isBytesLike(value: any): value @@ -510,7 +508,7 @@ isBytesLike(new Uint8Array(1));
-#### [`isHexString`](https://essential-eth.vercel.app/docs/api/modules#isHexString) +#### [`isHexString`](https://essential-eth.vercel.app/docs/api/modules#ishexstring) ```typescript isHexString(value: any, length: number): boolean @@ -518,7 +516,7 @@ isHexString(value: any, length: number): boolean
-#### [`jsonRpcProvider`](https://essential-eth.vercel.app/docs/api/modules#jsonRpcProvider) +#### [`jsonRpcProvider`](https://essential-eth.vercel.app/docs/api/modules#jsonrpcprovider) ```typescript jsonRpcProvider(rpcUrl: string): JsonRpcProvider @@ -563,7 +561,7 @@ pack(types: Array, values: Array): string
-#### [`solidityKeccak256`](https://essential-eth.vercel.app/docs/api/modules#solidityKeccak256) +#### [`solidityKeccak256`](https://essential-eth.vercel.app/docs/api/modules#soliditykeccak256) ```typescript solidityKeccak256(types: Array, values: Array): string @@ -600,7 +598,7 @@ solidityKeccak256(types, values);
-#### [`stripZeros`](https://essential-eth.vercel.app/docs/api/modules#stripZeros) +#### [`stripZeros`](https://essential-eth.vercel.app/docs/api/modules#stripzeros) ```typescript stripZeros(value: BytesLike): Uint8Array @@ -608,7 +606,7 @@ stripZeros(value: BytesLike): Uint8Array
-#### [`tinyBig`](https://essential-eth.vercel.app/docs/api/modules#tinyBig) +#### [`tinyBig`](https://essential-eth.vercel.app/docs/api/modules#tinybig) ```typescript tinyBig(value: string | number | TinyBig | Big): TinyBig @@ -633,7 +631,7 @@ tinyBig(10).times(3).toNumber();
-#### [`toChecksumAddress`](https://essential-eth.vercel.app/docs/api/modules#toChecksumAddress) +#### [`toChecksumAddress`](https://essential-eth.vercel.app/docs/api/modules#tochecksumaddress) ```typescript toChecksumAddress(address: string): string @@ -662,7 +660,7 @@ Similar to ["toChecksumAddress" in web3.js](https://web3js.readthedocs.io/en/v1.
-#### [`toUtf8Bytes`](https://essential-eth.vercel.app/docs/api/modules#toUtf8Bytes) +#### [`toUtf8Bytes`](https://essential-eth.vercel.app/docs/api/modules#toutf8bytes) ```typescript toUtf8Bytes(data: string): Uint8Array @@ -670,7 +668,7 @@ toUtf8Bytes(data: string): Uint8Array
-#### [`weiToEther`](https://essential-eth.vercel.app/docs/api/modules#weiToEther) +#### [`weiToEther`](https://essential-eth.vercel.app/docs/api/modules#weitoether) ```typescript weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig @@ -704,7 +702,7 @@ weiToEther(1000000000000000000000).toNumber();
-#### [`zeroPad`](https://essential-eth.vercel.app/docs/api/modules#zeroPad) +#### [`zeroPad`](https://essential-eth.vercel.app/docs/api/modules#zeropad) ```typescript zeroPad(value: BytesLike, length: number): Uint8Array diff --git a/scripts/markdown-magic/parse-typedoc.js b/scripts/markdown-magic/parse-typedoc.js index e9b9eef7..c52d7bdb 100644 --- a/scripts/markdown-magic/parse-typedoc.js +++ b/scripts/markdown-magic/parse-typedoc.js @@ -65,7 +65,7 @@ functions.map((functionNumber) => { \n` : ''; - functionsMarkdown += `#### [\`${name}\`](https://essential-eth.vercel.app/docs/api/modules#${name}) + functionsMarkdown += `#### [\`${name}\`](https://essential-eth.vercel.app/docs/api/modules#${name.toLowerCase()}) \`\`\`typescript ${name}(${paramsString}): ${returnType} \`\`\`