Skip to content

Commit 0ead76d

Browse files
SgtPookiSgtPooki
committed
chore: add typescript pr types
1 parent 4a8470d commit 0ead76d

27 files changed

+329
-611
lines changed

‎diff-types1/base-x.d.ts

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
2-
export interface BaseConverter {
3-
encode(buffer: Uint8Array | number[]): string;
4-
decodeUnsafe(string: string): Uint8Array | undefined;
5-
decode(string: string): Uint8Array;
6-
}
7-
8-
export default function base(ALPHABET: string, name: string): BaseConverter
1+
export default _brrp__multiformats_scope_baseX;
2+
/**
3+
* @param {string} ALPHABET
4+
* @param {any} name
5+
*/
6+
declare function _brrp__multiformats_scope_baseX(ALPHABET: string, name: any): {
7+
encode: (source: any[] | Iterable<number>) => string;
8+
decodeUnsafe: (source: string | string[]) => Uint8Array | undefined;
9+
decode: (string: string | string[]) => Uint8Array;
10+
};
11+
//# sourceMappingURL=base-x.d.ts.map

‎diff-types1/base.d.ts

+57-131
Original file line numberDiff line numberDiff line change
@@ -1,148 +1,74 @@
1-
export function or<L extends string, R extends string>(left: API.UnibaseDecoder<L> | API.CombobaseDecoder<L>, right: API.UnibaseDecoder<R> | API.CombobaseDecoder<R>): ComposedDecoder<L | R>;
2-
/**
3-
* @class
4-
* @template {string} Base
5-
* @template {string} Prefix
6-
* @implements {API.MultibaseCodec<Prefix>}
7-
* @implements {API.MultibaseEncoder<Prefix>}
8-
* @implements {API.MultibaseDecoder<Prefix>}
9-
* @implements {API.BaseCodec}
10-
* @implements {API.BaseEncoder}
11-
* @implements {API.BaseDecoder}
12-
*/
13-
export class Codec<Base extends string, Prefix extends string> implements API.MultibaseCodec<Prefix>, API.MultibaseEncoder<Prefix>, API.MultibaseDecoder<Prefix>, API.BaseCodec, API.BaseEncoder, API.BaseDecoder {
14-
/**
15-
* @param {Base} name
16-
* @param {Prefix} prefix
17-
* @param {(bytes:Uint8Array) => string} baseEncode
18-
* @param {(text:string) => Uint8Array} baseDecode
19-
*/
20-
constructor(name: Base, prefix: Prefix, baseEncode: (bytes: Uint8Array) => string, baseDecode: (text: string) => Uint8Array);
21-
name: Base;
22-
prefix: Prefix;
23-
baseEncode: (bytes: Uint8Array) => string;
24-
baseDecode: (text: string) => Uint8Array;
25-
encoder: Encoder<Base, Prefix>;
26-
decoder: Decoder<Base, Prefix>;
27-
/**
28-
* @param {Uint8Array} input
29-
*/
30-
encode(input: Uint8Array): API.Multibase<Prefix>;
31-
/**
32-
* @param {string} input
33-
*/
34-
decode(input: string): Uint8Array;
1+
import type { BaseCodec, BaseDecoder, BaseEncoder, CombobaseDecoder, Multibase, MultibaseCodec, MultibaseDecoder, MultibaseEncoder, UnibaseDecoder } from './interface.js';
2+
interface EncodeFn {
3+
(bytes: Uint8Array): string;
354
}
36-
export function from<Base extends string, Prefix extends string>({ name, prefix, encode, decode }: {
37-
name: Base;
38-
prefix: Prefix;
39-
encode: (bytes: Uint8Array) => string;
40-
decode: (input: string) => Uint8Array;
41-
}): Codec<Base, Prefix>;
42-
export function baseX<Base extends string, Prefix extends string>({ prefix, name, alphabet }: {
43-
name: Base;
44-
prefix: Prefix;
45-
alphabet: string;
46-
}): Codec<Base, Prefix>;
47-
export function rfc4648<Base extends string, Prefix extends string>({ name, prefix, bitsPerChar, alphabet }: {
48-
name: Base;
49-
prefix: Prefix;
50-
alphabet: string;
51-
bitsPerChar: number;
52-
}): Codec<Base, Prefix>;
53-
export type Decoders<Prefix extends string> = Record<Prefix, API.UnibaseDecoder<Prefix>>;
54-
import * as API from "./interface.js";
55-
/**
56-
* @template {string} Prefix
57-
* @typedef {Record<Prefix, API.UnibaseDecoder<Prefix>>} Decoders
58-
*/
59-
/**
60-
* @template {string} Prefix
61-
* @implements {API.MultibaseDecoder<Prefix>}
62-
* @implements {API.CombobaseDecoder<Prefix>}
63-
*/
64-
declare class ComposedDecoder<Prefix extends string> implements API.MultibaseDecoder<Prefix>, API.CombobaseDecoder<Prefix> {
65-
/**
66-
* @param {Decoders<Prefix>} decoders
67-
*/
68-
constructor(decoders: Decoders<Prefix>);
69-
decoders: Decoders<Prefix>;
70-
/**
71-
* @template {string} OtherPrefix
72-
* @param {API.UnibaseDecoder<OtherPrefix>|ComposedDecoder<OtherPrefix>} decoder
73-
* @returns {ComposedDecoder<Prefix|OtherPrefix>}
74-
*/
75-
or<OtherPrefix extends string>(decoder: API.UnibaseDecoder<OtherPrefix> | ComposedDecoder<OtherPrefix>): ComposedDecoder<Prefix | OtherPrefix>;
76-
/**
77-
* @param {string} input
78-
* @returns {Uint8Array}
79-
*/
80-
decode(input: string): Uint8Array;
5+
interface DecodeFn {
6+
(text: string): Uint8Array;
817
}
828
/**
839
* Class represents both BaseEncoder and MultibaseEncoder meaning it
8410
* can be used to encode to multibase or base encode without multibase
8511
* prefix.
86-
*
87-
* @class
88-
* @template {string} Base
89-
* @template {string} Prefix
90-
* @implements {API.MultibaseEncoder<Prefix>}
91-
* @implements {API.BaseEncoder}
9212
*/
93-
declare class Encoder<Base extends string, Prefix extends string> implements API.MultibaseEncoder<Prefix>, API.BaseEncoder {
94-
/**
95-
* @param {Base} name
96-
* @param {Prefix} prefix
97-
* @param {(bytes:Uint8Array) => string} baseEncode
98-
*/
99-
constructor(name: Base, prefix: Prefix, baseEncode: (bytes: Uint8Array) => string);
100-
name: Base;
101-
prefix: Prefix;
102-
baseEncode: (bytes: Uint8Array) => string;
103-
/**
104-
* @param {Uint8Array} bytes
105-
* @returns {API.Multibase<Prefix>}
106-
*/
107-
encode(bytes: Uint8Array): API.Multibase<Prefix>;
13+
declare class Encoder<Base extends string, Prefix extends string> implements MultibaseEncoder<Prefix>, BaseEncoder {
14+
readonly name: Base;
15+
readonly prefix: Prefix;
16+
readonly baseEncode: EncodeFn;
17+
constructor(name: Base, prefix: Prefix, baseEncode: EncodeFn);
18+
encode(bytes: Uint8Array): Multibase<Prefix>;
10819
}
109-
/**
110-
* @template {string} Prefix
111-
*/
11220
/**
11321
* Class represents both BaseDecoder and MultibaseDecoder so it could be used
11422
* to decode multibases (with matching prefix) or just base decode strings
11523
* with corresponding base encoding.
116-
*
117-
* @class
118-
* @template {string} Base
119-
* @template {string} Prefix
120-
* @implements {API.MultibaseDecoder<Prefix>}
121-
* @implements {API.UnibaseDecoder<Prefix>}
122-
* @implements {API.BaseDecoder}
12324
*/
124-
declare class Decoder<Base extends string, Prefix extends string> implements API.MultibaseDecoder<Prefix>, API.UnibaseDecoder<Prefix>, API.BaseDecoder {
125-
/**
126-
* @param {Base} name
127-
* @param {Prefix} prefix
128-
* @param {(text:string) => Uint8Array} baseDecode
129-
*/
130-
constructor(name: Base, prefix: Prefix, baseDecode: (text: string) => Uint8Array);
131-
name: Base;
132-
prefix: Prefix;
133-
/** @private */
134-
private prefixCodePoint;
135-
baseDecode: (text: string) => Uint8Array;
136-
/**
137-
* @param {string} text
138-
*/
25+
declare class Decoder<Base extends string, Prefix extends string> implements MultibaseDecoder<Prefix>, UnibaseDecoder<Prefix>, BaseDecoder {
26+
readonly name: Base;
27+
readonly prefix: Prefix;
28+
readonly baseDecode: DecodeFn;
29+
private readonly prefixCodePoint;
30+
constructor(name: Base, prefix: Prefix, baseDecode: DecodeFn);
13931
decode(text: string): Uint8Array;
140-
/**
141-
* @template {string} OtherPrefix
142-
* @param {API.UnibaseDecoder<OtherPrefix>|ComposedDecoder<OtherPrefix>} decoder
143-
* @returns {ComposedDecoder<Prefix|OtherPrefix>}
144-
*/
145-
or<OtherPrefix extends string>(decoder: API.UnibaseDecoder<OtherPrefix> | ComposedDecoder<OtherPrefix>): ComposedDecoder<Prefix | OtherPrefix>;
32+
or<OtherPrefix extends string>(decoder: UnibaseDecoder<OtherPrefix> | ComposedDecoder<OtherPrefix>): ComposedDecoder<Prefix | OtherPrefix>;
33+
}
34+
type Decoders<Prefix extends string> = Record<Prefix, UnibaseDecoder<Prefix>>;
35+
declare class ComposedDecoder<Prefix extends string> implements MultibaseDecoder<Prefix>, CombobaseDecoder<Prefix> {
36+
readonly decoders: Decoders<Prefix>;
37+
constructor(decoders: Decoders<Prefix>);
38+
or<OtherPrefix extends string>(decoder: UnibaseDecoder<OtherPrefix> | ComposedDecoder<OtherPrefix>): ComposedDecoder<Prefix | OtherPrefix>;
39+
decode(input: string): Uint8Array;
40+
}
41+
export declare function or<L extends string, R extends string>(left: UnibaseDecoder<L> | CombobaseDecoder<L>, right: UnibaseDecoder<R> | CombobaseDecoder<R>): ComposedDecoder<L | R>;
42+
export declare class Codec<Base extends string, Prefix extends string> implements MultibaseCodec<Prefix>, MultibaseEncoder<Prefix>, MultibaseDecoder<Prefix>, BaseCodec, BaseEncoder, BaseDecoder {
43+
readonly name: Base;
44+
readonly prefix: Prefix;
45+
readonly baseEncode: EncodeFn;
46+
readonly baseDecode: DecodeFn;
47+
readonly encoder: Encoder<Base, Prefix>;
48+
readonly decoder: Decoder<Base, Prefix>;
49+
constructor(name: Base, prefix: Prefix, baseEncode: EncodeFn, baseDecode: DecodeFn);
50+
encode(input: Uint8Array): string;
51+
decode(input: string): Uint8Array;
14652
}
53+
export declare function from<Base extends string, Prefix extends string>({ name, prefix, encode, decode }: {
54+
name: Base;
55+
prefix: Prefix;
56+
encode: EncodeFn;
57+
decode: DecodeFn;
58+
}): Codec<Base, Prefix>;
59+
export declare function baseX<Base extends string, Prefix extends string>({ name, prefix, alphabet }: {
60+
name: Base;
61+
prefix: Prefix;
62+
alphabet: string;
63+
}): Codec<Base, Prefix>;
64+
/**
65+
* RFC4648 Factory
66+
*/
67+
export declare function rfc4648<Base extends string, Prefix extends string>({ name, prefix, bitsPerChar, alphabet }: {
68+
name: Base;
69+
prefix: Prefix;
70+
bitsPerChar: number;
71+
alphabet: string;
72+
}): Codec<Base, Prefix>;
14773
export {};
14874
//# sourceMappingURL=base.d.ts.map

‎diff-types1/base10.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
export const base10: import("./base.js").Codec<"base10", "9">;
1+
export declare const base10: import("./base.js").Codec<"base10", "9">;
22
//# sourceMappingURL=base10.d.ts.map

‎diff-types1/base16.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export const base16: import("./base.js").Codec<"base16", "f">;
2-
export const base16upper: import("./base.js").Codec<"base16upper", "F">;
1+
export declare const base16: import("./base.js").Codec<"base16", "f">;
2+
export declare const base16upper: import("./base.js").Codec<"base16upper", "F">;
33
//# sourceMappingURL=base16.d.ts.map

‎diff-types1/base2.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
export const base2: import("./base.js").Codec<"base2", "0">;
1+
export declare const base2: import("./base.js").Codec<"base2", "0">;
22
//# sourceMappingURL=base2.d.ts.map

‎diff-types1/base256emoji.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
export const base256emoji: import("./base.js").Codec<"base256emoji", "🚀">;
1+
export declare const base256emoji: import("./base.js").Codec<"base256emoji", "🚀">;
22
//# sourceMappingURL=base256emoji.d.ts.map

‎diff-types1/base32.d.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
export const base32: import("./base.js").Codec<"base32", "b">;
2-
export const base32upper: import("./base.js").Codec<"base32upper", "B">;
3-
export const base32pad: import("./base.js").Codec<"base32pad", "c">;
4-
export const base32padupper: import("./base.js").Codec<"base32padupper", "C">;
5-
export const base32hex: import("./base.js").Codec<"base32hex", "v">;
6-
export const base32hexupper: import("./base.js").Codec<"base32hexupper", "V">;
7-
export const base32hexpad: import("./base.js").Codec<"base32hexpad", "t">;
8-
export const base32hexpadupper: import("./base.js").Codec<"base32hexpadupper", "T">;
9-
export const base32z: import("./base.js").Codec<"base32z", "h">;
1+
export declare const base32: import("./base.js").Codec<"base32", "b">;
2+
export declare const base32upper: import("./base.js").Codec<"base32upper", "B">;
3+
export declare const base32pad: import("./base.js").Codec<"base32pad", "c">;
4+
export declare const base32padupper: import("./base.js").Codec<"base32padupper", "C">;
5+
export declare const base32hex: import("./base.js").Codec<"base32hex", "v">;
6+
export declare const base32hexupper: import("./base.js").Codec<"base32hexupper", "V">;
7+
export declare const base32hexpad: import("./base.js").Codec<"base32hexpad", "t">;
8+
export declare const base32hexpadupper: import("./base.js").Codec<"base32hexpadupper", "T">;
9+
export declare const base32z: import("./base.js").Codec<"base32z", "h">;
1010
//# sourceMappingURL=base32.d.ts.map

‎diff-types1/base36.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export const base36: import("./base.js").Codec<"base36", "k">;
2-
export const base36upper: import("./base.js").Codec<"base36upper", "K">;
1+
export declare const base36: import("./base.js").Codec<"base36", "k">;
2+
export declare const base36upper: import("./base.js").Codec<"base36upper", "K">;
33
//# sourceMappingURL=base36.d.ts.map

‎diff-types1/base58.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export const base58btc: import("./base.js").Codec<"base58btc", "z">;
2-
export const base58flickr: import("./base.js").Codec<"base58flickr", "Z">;
1+
export declare const base58btc: import("./base.js").Codec<"base58btc", "z">;
2+
export declare const base58flickr: import("./base.js").Codec<"base58flickr", "Z">;
33
//# sourceMappingURL=base58.d.ts.map

‎diff-types1/base64.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
export const base64: import("./base.js").Codec<"base64", "m">;
2-
export const base64pad: import("./base.js").Codec<"base64pad", "M">;
3-
export const base64url: import("./base.js").Codec<"base64url", "u">;
4-
export const base64urlpad: import("./base.js").Codec<"base64urlpad", "U">;
1+
export declare const base64: import("./base.js").Codec<"base64", "m">;
2+
export declare const base64pad: import("./base.js").Codec<"base64pad", "M">;
3+
export declare const base64url: import("./base.js").Codec<"base64url", "u">;
4+
export declare const base64urlpad: import("./base.js").Codec<"base64urlpad", "U">;
55
//# sourceMappingURL=base64.d.ts.map

‎diff-types1/base8.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
export const base8: import("./base.js").Codec<"base8", "7">;
1+
export declare const base8: import("./base.js").Codec<"base8", "7">;
22
//# sourceMappingURL=base8.d.ts.map

‎diff-types1/basics.d.ts

+19-23
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
import { CID } from "./index.js";
2-
import { hasher } from "./index.js";
3-
import { digest } from "./index.js";
4-
import { varint } from "./index.js";
5-
import { bytes } from "./index.js";
6-
export const hashes: {
7-
identity: {
8-
code: number;
9-
name: string;
10-
encode: (input: Uint8Array) => Uint8Array;
11-
digest: (input: Uint8Array) => digest.Digest<0, number>;
12-
};
13-
sha256: hasher.Hasher<"sha2-256", 18>;
14-
sha512: hasher.Hasher<"sha2-512", 19>;
15-
};
16-
export const bases: {
1+
import * as raw from './codecs/raw.js';
2+
import * as json from './codecs/json.js';
3+
import { CID, hasher, digest, varint, bytes } from './index.js';
4+
declare const bases: {
175
base256emoji: import("./bases/base.js").Codec<"base256emoji", "🚀">;
186
base64: import("./bases/base.js").Codec<"base64", "m">;
197
base64pad: import("./bases/base.js").Codec<"base64pad", "M">;
@@ -39,11 +27,19 @@ export const bases: {
3927
base2: import("./bases/base.js").Codec<"base2", "0">;
4028
identity: import("./bases/base.js").Codec<"identity", "\0">;
4129
};
42-
export namespace codecs {
43-
export { raw };
44-
export { json };
45-
}
46-
import * as raw from "./codecs/raw.js";
47-
import * as json from "./codecs/json.js";
48-
export { CID, hasher, digest, varint, bytes };
30+
declare const hashes: {
31+
identity: {
32+
code: number;
33+
name: string;
34+
encode: (input: Uint8Array) => Uint8Array;
35+
digest: (input: Uint8Array) => digest.Digest<0, number>;
36+
};
37+
sha256: hasher.Hasher<"sha2-256", 18>;
38+
sha512: hasher.Hasher<"sha2-512", 19>;
39+
};
40+
declare const codecs: {
41+
raw: typeof raw;
42+
json: typeof json;
43+
};
44+
export { CID, hasher, digest, varint, bytes, hashes, bases, codecs };
4945
//# sourceMappingURL=basics.d.ts.map

0 commit comments

Comments
 (0)