0.2.0 • Published 4 years ago
@timhall/fingerprint v0.2.0
@timhall/fingerprint
Calculate a hash fingerprint for directories and files.
const { fingerprintDir } = require('@timhall/fingerprint');
// Calculate a fingerprint of the current working directory using
// - filter = active .gitignore files
// - algorithm = sha1
// - encoding = base64
const a = await fingerprintDir(process.cwd());
const { fingerprintDir, fingerprintFile } = require('@timhall/fingerprint');
const { join } = require('path');
const b = await fingerprintDir(process.cwd(), {
algorithm: 'sha256',
encoding: 'hex',
filter: absolutePath => /^\./.test(absolutePath)
});
const c = await fingerprintFile(join(__dirname, 'file.txt'));
fingerprintDir(dir: string, options): Promise
Options:
- algorithm = 'sha1' - Hash algorithm,
'sha1'
,'sha256'
, or'sha512'
- encoding = 'base64' - Encoding,
'base64'
or'hex'
- filter = (by gitignore) - Filter function, given absolute path and return
true
to include file orfalse
to exclude
fingerprintFile(file: string, options): Promise
Options:
- algorithm = 'sha1' - Hash algorithm,
'sha1'
,'sha256'
, or'sha512'
- encoding = 'base64' - Encoding,
'base64'
or'hex'