multiformats/dist/src/link.d.ts

Interface for multihash, multicodec, multibase and CID

import { CID, format, toJSON, fromJSON } from './cid.ts';
import type * as API from './link/interface.ts';
export * from './link/interface.ts';
declare const SHA_256_CODE = 18;
/**
 * Simplified version of `create` for CIDv0.
 */
export declare function createLegacy(digest: API.MultihashDigest<typeof SHA_256_CODE>): API.LegacyLink;
/**
 * Simplified version of `create` for CIDv1.
 *
 * @param code - Content encoding format code.
 * @param digest - Miltihash of the content.
 */
export declare function create<Data, Code extends number, Alg extends number>(code: Code, digest: API.MultihashDigest<Alg>): API.Link<Data, Code, Alg>;
/**
 * Type predicate returns true if value is the link.
 */
export declare function isLink<L extends API.Link<unknown, number, number, 0 | 1>>(value: unknown | L): value is L & CID;
/**
 * Takes cid in a string representation and creates an instance. If `base`
 * decoder is not provided will use a default from the configuration. It will
 * throw an error if encoding of the CID is not compatible with supplied (or
 * a default decoder).
 */
export declare function parse<Prefix extends string, Data, Code extends number, Alg extends number, Ver extends API.Version>(source: API.ToString<API.Link<Data, Code, Alg, Ver>, Prefix>, base?: API.MultibaseDecoder<Prefix>): API.Link<Data, Code, Alg, Ver>;
export { format, toJSON, fromJSON };
/**
 * Decoded a CID from its binary representation. The byte array must contain
 * only the CID with no additional bytes.
 *
 * An error will be thrown if the bytes provided do not contain a valid
 * binary representation of a CID.
 */
export declare function decode<Data, Code extends number, Alg extends number, Ver extends API.Version>(bytes: API.ByteView<API.Link<Data, Code, Alg, Ver>>): API.Link<Data, Code, Alg, Ver>;
//# sourceMappingURL=link.d.ts.map