@types/folder-hash/index.d.ts

TypeScript definitions for folder-hash

export type PathGlobFunction = () => string[];

export interface FolderAndFileOptions {
    exclude?: string[] | PathGlobFunction | undefined;
    include?: string[] | PathGlobFunction | undefined;
    matchBasename?: boolean | undefined;
    matchPath?: boolean | undefined;
    ignoreBasename?: boolean | undefined;
    ignoreRootName?: boolean | undefined;
}

export type SymbolicLinkOptions = Omit<FolderAndFileOptions, "exclude" | "include"> & {
    include?: boolean | undefined;
    ignoreTargetPath?: boolean | undefined;
    ignoreTargetContent?: boolean | undefined;
    ignoreTargetContentAfterError?: boolean | undefined;
};
export interface HashElementOptions {
    // See crypto.getHashes() for options.
    // Defaults to 'sha1'.
    algo?: string | undefined;
    // Defaults to 'base64'
    encoding?: "base64" | "base64url" | "hex" | "binary" | undefined;
    files?: FolderAndFileOptions | undefined;
    folders?: FolderAndFileOptions | undefined;
    symbolicLinks?: SymbolicLinkOptions | undefined;
}

export interface HashElementNode {
    name: string;
    hash: string;
    children: HashElementNode[];
}

/**
 * @param name element name or an element's path
 * @param options Options object
 */
export function hashElement(name: string, options?: HashElementOptions): Promise<HashElementNode>;
/**
 * @param name element name or an element's path
 * @param dir directory that contains the element (generated from name if omitted)
 * @param options Options object
 */
export function hashElement(name: string, dir?: string, options?: HashElementOptions): Promise<HashElementNode>;
/**
 * @param name element name or an element's path
 * @param dir directory that contains the element (generated from name if omitted)
 * @param options Options object
 * @param callback Error-first callback function
 */
export function hashElement(
    name: string,
    dir?: string,
    options?: HashElementOptions,
    callback?: (error?: Error, result?: HashElementNode) => any,
): void;

export const defaults: HashElementOptions;