56 lines
1.5 KiB
TypeScript
56 lines
1.5 KiB
TypeScript
interface MultiHashData {
|
|
"cid_sha2-256"?: string;
|
|
cid_sha1?: string;
|
|
cid_md5?: string;
|
|
"cid_sha3-256"?: string;
|
|
cid_crc32?: string;
|
|
}
|
|
interface ComputeInterface {
|
|
computeMissingHash(filePath: string, metadata: MultiHashData): Promise<void>;
|
|
}
|
|
/**
|
|
* according to
|
|
* https://ipfs.io/ipfs/QmXec1jjwzxWJoNbxQF5KffL8q6hFXm9QwUGaa3wKGk6dT/#title=Multicodecs&src=https://raw.githubusercontent.com/multiformats/multicodec/master/table.csv
|
|
*/
|
|
declare enum CID_ALGORITHM_CODES {
|
|
crc32 = 306,
|
|
md5 = 213,
|
|
sha1 = 17,
|
|
sha256 = 18,
|
|
sha3_256 = 22,
|
|
sha3_384 = 21
|
|
}
|
|
declare enum CID_ALGORITHM_NAMES {
|
|
crc32 = "cid_crc32",
|
|
md5 = "cid_md5",
|
|
sha1 = "cid_sha1",
|
|
sha256 = "cid_sha2-256",
|
|
sha3_256 = "cid_sha3-256",
|
|
sha3_384 = "cid_sha3-384"
|
|
}
|
|
declare enum CID_ALGORITHM {
|
|
crc32 = "crc32",
|
|
md5 = "md5",
|
|
sha1 = "sha1",
|
|
sha256 = "sha2-256",
|
|
sha3_256 = "sha3-256",
|
|
sha3_384 = "sha3-384"
|
|
}
|
|
|
|
interface SimpleHash {
|
|
update(data: Buffer): any;
|
|
digest(): Buffer;
|
|
}
|
|
/**
|
|
* Compute the CIDs of a file using specific algorithms
|
|
* @param filePath The path to the file
|
|
* @param algorithms Array of algorithms ('sha256', 'sha1')
|
|
* @returns Array of CIDs (in the order of the algorithms)
|
|
*/
|
|
declare function computeCIDs({ filePath, algorithms }: {
|
|
filePath: string;
|
|
algorithms: CID_ALGORITHM_NAMES[];
|
|
}): Promise<string[]>;
|
|
|
|
export { CID_ALGORITHM_NAMES as C, type MultiHashData as M, type SimpleHash as S, type ComputeInterface as a, CID_ALGORITHM_CODES as b, CID_ALGORITHM as c, computeCIDs as d };
|