@fnet/checksum

@fnet/checksum is a utility designed for generating checksums or hashes for different types of data, whether they are strings, buffers, objects, files, or entire directories. Its main purpose is to ensure data integrity by producing a unique hash value that summarizes the contents of the input data. This can be particularly useful for verifying that data has not been altered, corrupted, or tampered with.

Main Features and Functionalities

1. Generate Checksums for Strings and Buffers:

• The utility can take a string or buffer as input and generate a corresponding hash using a specified algorithm (default is SHA-256). The output is a unique checksum that represents the content of the input string or buffer.
• Example Use Case: Ensuring data integrity when transferring files over a network or storing data in a database.

2. Generate Checksums for Objects:

• It supports nested objects and can generate checksums based on the contents of these objects.
• This involves calculating a unique hash for each property value and combining these to produce a final checksum.
• Example Use Case: Validating the integrity of complex configuration objects or data structures.

3. Generate Checksums for Files:

• It can compute the checksum of a specific file. This involves reading the file's contents and generating a hash.
• Example Use Case: Ensuring the integrity of a downloaded file by comparing its checksum with a known value.

4. Generate Checksums for Directories:

• The utility can recursively navigate through directories, compute checksums for all files within the directory (in alphabetical order), and then combine these to produce a final checksum for the entire directory.
• Example Use Case: Verifying the integrity of a collection of files such as software packages or backups.

5. Versatile Input Handling:

• The function can handle various types of inputs — from individual content strings or objects to file paths and directory paths. It intelligently distinguishes between these input types and processes them accordingly.
• Example Use Case: Flexibly integrating checksum generation in different parts of an application where data might come in varied forms and structures.

How It Works

1. Input Validation: Determines if the input is content (string, buffer, or object) or a path (file or directory).
2. Content Hashing: For strings and buffers, it directly computes the hash. For objects,