Skip to content

Commit d31a952

Browse files
committed
doc: str -> string
1 parent 4f4aad1 commit d31a952

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

base58check.d.ts

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ export interface Base58CheckAsync {
4141
/**
4242
* Decode a base58check string to bytes asynchronously
4343
*
44-
* @param str - The base58check encoded string
44+
* @param string - The base58check encoded string
4545
* @param format - Output format (default: 'uint8')
4646
* @returns A Promise that resolves to the decoded bytes
4747
*/
48-
decode(str: string, format?: 'uint8'): Promise<Uint8ArrayBuffer>;
49-
decode(str: string, format: 'buffer'): Promise<Buffer>;
50-
decode(str: string, format?: OutputFormat): Promise<Uint8ArrayBuffer | Buffer>;
48+
decode(string: string, format?: 'uint8'): Promise<Uint8ArrayBuffer>;
49+
decode(string: string, format: 'buffer'): Promise<Buffer>;
50+
decode(string: string, format?: OutputFormat): Promise<Uint8ArrayBuffer | Buffer>;
5151
}
5252

5353
/**
@@ -65,13 +65,13 @@ export interface Base58CheckSync extends Base58CheckAsync {
6565
/**
6666
* Decode a base58check string to bytes synchronously
6767
*
68-
* @param str - The base58check encoded string
68+
* @param string - The base58check encoded string
6969
* @param format - Output format (default: 'uint8')
7070
* @returns The decoded bytes
7171
*/
72-
decodeSync(str: string, format?: 'uint8'): Uint8ArrayBuffer;
73-
decodeSync(str: string, format: 'buffer'): Buffer;
74-
decodeSync(str: string, format?: OutputFormat): Uint8ArrayBuffer | Buffer;
72+
decodeSync(string: string, format?: 'uint8'): Uint8ArrayBuffer;
73+
decodeSync(string: string, format: 'buffer'): Buffer;
74+
decodeSync(string: string, format?: OutputFormat): Uint8ArrayBuffer | Buffer;
7575
}
7676

7777
/**
@@ -99,13 +99,13 @@ export function toBase58check(arr: Uint8ArrayBuffer): Promise<string>;
9999
*
100100
* Validates the checksum using double SHA-256
101101
*
102-
* @param str - The base58check encoded string
102+
* @param string - The base58check encoded string
103103
* @param format - Output format (default: 'uint8')
104104
* @returns A Promise that resolves to the decoded bytes
105105
*/
106-
export function fromBase58check(str: string, format?: 'uint8'): Promise<Uint8ArrayBuffer>;
107-
export function fromBase58check(str: string, format: 'buffer'): Promise<Buffer>;
108-
export function fromBase58check(str: string, format?: OutputFormat): Promise<Uint8ArrayBuffer | Buffer>;
106+
export function fromBase58check(string: string, format?: 'uint8'): Promise<Uint8ArrayBuffer>;
107+
export function fromBase58check(string: string, format: 'buffer'): Promise<Buffer>;
108+
export function fromBase58check(string: string, format?: OutputFormat): Promise<Uint8ArrayBuffer | Buffer>;
109109

110110
/**
111111
* Encode bytes to base58check string synchronously
@@ -122,10 +122,10 @@ export function toBase58checkSync(arr: Uint8ArrayBuffer): string;
122122
*
123123
* Validates the checksum using double SHA-256
124124
*
125-
* @param str - The base58check encoded string
125+
* @param string - The base58check encoded string
126126
* @param format - Output format (default: 'uint8')
127127
* @returns The decoded bytes
128128
*/
129-
export function fromBase58checkSync(str: string, format?: 'uint8'): Uint8ArrayBuffer;
130-
export function fromBase58checkSync(str: string, format: 'buffer'): Buffer;
131-
export function fromBase58checkSync(str: string, format?: OutputFormat): Uint8ArrayBuffer | Buffer;
129+
export function fromBase58checkSync(string: string, format?: 'uint8'): Uint8ArrayBuffer;
130+
export function fromBase58checkSync(string: string, format: 'buffer'): Buffer;
131+
export function fromBase58checkSync(string: string, format?: OutputFormat): Uint8ArrayBuffer | Buffer;

bech32.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ export function toBech32(prefix: string, bytes: Uint8ArrayBuffer, limit?: number
3939
/**
4040
* Decode a bech32 string to bytes
4141
*
42-
* @param str - The bech32 encoded string
42+
* @param string - The bech32 encoded string
4343
* @param limit - Maximum length of the input string (default: 90)
4444
* @returns The decoded prefix and bytes
4545
*/
46-
export function fromBech32(str: string, limit?: number): Bech32DecodeResult;
46+
export function fromBech32(string: string, limit?: number): Bech32DecodeResult;
4747

4848
/**
4949
* Encode bytes to a bech32m string
@@ -58,19 +58,19 @@ export function toBech32m(prefix: string, bytes: Uint8ArrayBuffer, limit?: numbe
5858
/**
5959
* Decode a bech32m string to bytes
6060
*
61-
* @param str - The bech32m encoded string
61+
* @param string - The bech32m encoded string
6262
* @param limit - Maximum length of the input string (default: 90)
6363
* @returns The decoded prefix and bytes
6464
*/
65-
export function fromBech32m(str: string, limit?: number): Bech32DecodeResult;
65+
export function fromBech32m(string: string, limit?: number): Bech32DecodeResult;
6666

6767
/**
6868
* Extract the prefix from a bech32 or bech32m string without full validation
6969
*
7070
* This is a quick check that skips most validation.
7171
*
72-
* @param str - The bech32/bech32m encoded string
72+
* @param string - The bech32/bech32m encoded string
7373
* @param limit - Maximum length of the input string (default: 90)
7474
* @returns The lowercase prefix
7575
*/
76-
export function getPrefix(str: string, limit?: number): string;
76+
export function getPrefix(string: string, limit?: number): string;

0 commit comments

Comments
 (0)