Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/checksum

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/checksum

TypeScript definitions for checksum

  • 0.1.35
  • ts4.5
  • ts4.6
  • ts4.7
  • ts4.8
  • ts4.9
  • ts5.0
  • ts5.1
  • ts5.2
  • ts5.3
  • ts5.4
  • ts5.5
  • ts5.6
  • ts5.7
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Installation

npm install --save @types/checksum

Summary

This package contains type definitions for checksum (https://github.com/dshaw/checksum).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/checksum.

index.d.ts

declare namespace checksum {
    /**
     * Options object for all functions
     */
    interface ChecksumOptions {
        /**
         * Algorithm to use, default 'sha1'
         * Can be 'sha1' or 'md5'  (see module 'crypto').
         */
        algorithm?: string;
        /**
         * Encoding to use, default 'hex'
         * Can be 'base64' (see NodeJS encoding support)
         */
        encoding?: string;
    }

    /**
     * Generate the checksum for a file on disk
     * @param filename    The file name
     * @param callback    Callback which is called with the result or an error
     */
    function file(filename: string, callback: (error: Error, hash: string) => void): void;
    /**
     * Generate the checksum for a file on disk
     * @param filename    The file name
     * @param options    Options object to indicate hash algo
     * @param callback    Callback which is called with the result or an error
     */
    function file(filename: string, options: ChecksumOptions, callback: (error: Error, hash: string) => void): void;
}

/**
 * Generates a checksum for the given value
 * @param value    Any value
 * @param options    Allows to set the algorithm
 * @returns    Checksum
 */
declare function checksum(value: any, options?: checksum.ChecksumOptions): string;

export = checksum;

Additional Details

  • Last updated: Mon, 06 Nov 2023 22:41:05 GMT
  • Dependencies: none

Credits

These definitions were written by Rogier Schouten.

FAQs

Package last updated on 07 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc