Logo for jsDocs.io

@types/object-hash

  • Version 3.0.6
  • Published
  • 6.67 kB
  • No dependencies
  • MIT license

Install

npm i @types/object-hash
yarn add @types/object-hash
pnpm add @types/object-hash

Overview

TypeScript definitions for object-hash

Index

Functions

Interfaces

Type Aliases

Functions

function keys

keys: (object: NotUndefined) => string;

  • See Also

    • https://github.com/puleos/object-hash#hashkeysvalue

function keysMD5

keysMD5: (object: NotUndefined) => string;

  • See Also

    • https://github.com/puleos/object-hash#hashkeysmd5value

function MD5

MD5: (object: NotUndefined) => string;

  • See Also

    • https://github.com/puleos/object-hash#hashmd5value

function objectHash

objectHash: typeof objectHash;

  • See Also

    • https://github.com/puleos/object-hash#hashvalue-options

function sha1

sha1: (object: NotUndefined) => string;

  • See Also

    • https://github.com/puleos/object-hash#hashsha1value

function writeToStream

writeToStream: {
    (value: any, stream: Stream): void;
    (value: any, options: Options, stream: Stream): void;
};

  • See Also

    • https://github.com/puleos/object-hash#hashwritetostreamvalue-options-stream

Interfaces

interface BaseOptions

interface BaseOptions {}

    property algorithm

    algorithm?: HashName | 'passthrough' | undefined;

    • 'sha1'

    property excludeKeys

    excludeKeys?: ((key: string) => boolean) | undefined;

      property excludeValues

      excludeValues?: boolean | undefined;

      • false

      property ignoreUnknown

      ignoreUnknown?: boolean | undefined;

      • false

      property replacer

      replacer?: ((value: any) => any) | undefined;

        property respectFunctionNames

        respectFunctionNames?: boolean | undefined;

        • true

        property respectFunctionProperties

        respectFunctionProperties?: boolean | undefined;

        • true

        property respectType

        respectType?: boolean | undefined;

        • true

        property unorderedArrays

        unorderedArrays?: boolean | undefined;

        • false

        property unorderedObjects

        unorderedObjects?: boolean | undefined;

        • true

        property unorderedSets

        unorderedSets?: boolean | undefined;

        • true

        interface NormalOption

        interface NormalOption extends BaseOptions {}

          property encoding

          encoding?: 'hex' | 'binary' | 'base64' | undefined;

          • 'hex'

          interface Stream

          interface Stream {}

            method update

            update: (
                chunk: any,
                encoding: BufferEncoding,
                callback: (error?: Error | null) => void
            ) => void;

              method write

              write: (
                  chunk: any,
                  encoding: BufferEncoding,
                  callback: (error?: Error | null) => void
              ) => void;

                interface WithBufferOption

                interface WithBufferOption extends BaseOptions {}

                  property encoding

                  encoding: 'buffer';

                    Type Aliases

                    type BufferEncoding

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

                      type HashName

                      type HashName =
                          | 'md4'
                          | 'md4WithRSAEncryption'
                          | 'md5'
                          | 'md5WithRSAEncryption'
                          | 'ripemd'
                          | 'ripemd160'
                          | 'ripemd160WithRSA'
                          | 'rmd160'
                          | 'rsa-md4'
                          | 'rsa-md5'
                          | 'rsa-ripemd160'
                          | 'rsa-sha1'
                          | 'rsa-sha1-2'
                          | 'rsa-sha224'
                          | 'rsa-sha256'
                          | 'rsa-sha3-224'
                          | 'rsa-sha3-256'
                          | 'rsa-sha3-384'
                          | 'rsa-sha3-512'
                          | 'rsa-sha384'
                          | 'rsa-sha512'
                          | 'sha1'
                          | 'sha1WithRSAEncryption'
                          | 'sha224'
                          | 'sha224WithRSAEncryption'
                          | 'sha256'
                          | 'sha256WithRSAEncryption'
                          | 'sha3-224'
                          | 'sha3-256'
                          | 'sha3-384'
                          | 'sha3-512'
                          | 'sha384'
                          | 'sha384WithRSAEncryption'
                          | 'sha512'
                          | 'sha512WithRSAEncryption';

                        type NotUndefined

                        type NotUndefined = object | string | number | boolean | null | NotUndefined[];

                          type Options

                          type Options = NormalOption | WithBufferOption;

                            Package Files (1)

                            Dependencies (0)

                            No dependencies.

                            Dev Dependencies (0)

                            No dev dependencies.

                            Peer Dependencies (0)

                            No peer dependencies.

                            Badge

                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/object-hash.

                            • Markdown
                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/object-hash)
                            • HTML
                              <a href="https://www.jsdocs.io/package/@types/object-hash"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>