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

// Type definitions for object-hash 3.0
// Project: https://github.com/puleos/object-hash
// Definitions by: Michael Zabka <https://github.com/misak113>
//                 Artur Diniz <https://github.com/artdiniz>
//                 Martin Badin <https://github.com/martin-badin>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// Minimum TypeScript Version: 3.9

declare namespace objectHash {
    type NotUndefined = object | string | number | boolean | null | NotUndefined[];

    /**
     * @see https://github.com/puleos/object-hash#hashsha1value
     */
    function sha1(object: NotUndefined): string;
    /**
     * @see https://github.com/puleos/object-hash#hashkeysvalue
     */
    function keys(object: NotUndefined): string;
    /**
     * @see https://github.com/puleos/object-hash#hashmd5value
     */
    function MD5(object: NotUndefined): string;
    /**
     * @see https://github.com/puleos/object-hash#hashkeysmd5value
     */
    function keysMD5(object: NotUndefined): string;
    /**
     * @see https://github.com/puleos/object-hash#hashwritetostreamvalue-options-stream
     */
    function writeToStream(value: any, stream: Stream): void;
    function writeToStream(value: any, options: Options, stream: Stream): void;

    type BufferEncoding =
        | 'ascii'
        | 'base64'
        | 'binary'
        | 'hex'
        | 'latin1'
        | 'ucs-2'
        | 'ucs2'
        | 'utf-8'
        | 'utf16le'
        | 'utf8';

    interface Stream {
        update?(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
        write?(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
    }

    interface BaseOptions {
        /**
         * @default 'sha1'
         */
        algorithm?: 'sha1' | 'md5' | 'passthrough' | undefined;

        excludeKeys?: ((key: string) => boolean) | undefined;
        /**
         * @default false
         */
        excludeValues?: boolean | undefined;
        /**
         * @default false
         */
        ignoreUnknown?: boolean | undefined;

        replacer?: ((value: any) => any) | undefined;
        /**
         * @default true
         */
        respectFunctionNames?: boolean | undefined;
        /**
         * @default true
         */
        respectFunctionProperties?: boolean | undefined;
        /**
         * @default true
         */
        respectType?: boolean | undefined;
        /**
         * @default false
         */
        unorderedArrays?: boolean | undefined;
        /**
         * @default true
         */
        unorderedObjects?: boolean | undefined;
        /**
         * @default true
         */
        unorderedSets?: boolean | undefined;
    }

    interface NormalOption extends BaseOptions {
        /**
         * @default 'hex'
         */
        encoding?: 'hex' | 'binary' | 'base64' | undefined;
    }

    interface WithBufferOption extends BaseOptions {
        encoding: 'buffer';
    }

    type Options = NormalOption | WithBufferOption;
}

/**
 * @see https://github.com/puleos/object-hash#hashvalue-options
 */
declare function objectHash(object: objectHash.NotUndefined, options?: objectHash.NormalOption): string;
declare function objectHash(object: objectHash.NotUndefined, options?: objectHash.WithBufferOption): Buffer;

export = objectHash;