fileHashSync

Type:Function

Status:stable

Since:1.0.0

Platform:node

@blackbyte.sugar.node.fs

This function allows you to get back an integrity hash for the passed file. This mean that if a file returns the same integrity hash twice, the folder or files in it has not been updated…

Params

filePath*-String
The folder path you want to get the hash back
settings{}TFileHashSettings
Some settings to configure your hash generation process

Return

-String
The calculated folder hash

Example

import { fileHashSync } from '@blackbyte/sugar/fs';
fileHashSync('my/cool/folder'); // => YZOrKDx9LCLd8X39PoFTflXGpRU=,

Settings

algo’sha356’String
The algorithm to use
digest’base64’BinaryToTextEncoding
How to digest the hash

Todo

testsnormal

Author

Olivier Bosselolivier.bossel@gmail.com https://blackbyte.space