Options
All
  • Public
  • Public/Protected
  • All
Menu

@objekt/checksum-report

Index

References

Variables

References

default

Renames and re-exports ChecksumReport

Variables

Const ChecksumReport

ChecksumReport: { get: (buildPath: string) => Promise<string>; save: (directoryPath: string, outputPath?: string) => Promise<string> } = ...

NodeJS utility library to generate checksums for files and directories.

example
import { ChecksumReport } from '@objekt/checksum-report';

// Generate and save a checksum for a directory.
const report = await ChecksumReport.get('./dist', './dist/checksum.json');

Type declaration

  • get: (buildPath: string) => Promise<string>
      • (buildPath: string): Promise<string>

      • Generate a checksum file for a given directory path.

        Parameters

        • buildPath: string

        Returns Promise<string>

        A JSON string containing the directory checksum.

  • save: (directoryPath: string, outputPath?: string) => Promise<string>
      • (directoryPath: string, outputPath?: string): Promise<string>

      • Generate a checksum file for a given directory path and saves it to disk.

        Parameters

        • directoryPath: string

          The path to the directory to generate a checksum for.

        • Optional outputPath: string

          The path to save the checksum output to, defaults to checksum.json in the given directory.

        Returns Promise<string>

        A JSON string containing the directory checksum.

Generated using TypeDoc