Programmatically usage options

[scaljeri]

I'm trying to use this tool programatically, but I'm getting errors

const file = fs.createReadStream(fileName);
hashmark(file, {length: 8, digest: 'md5', pattern: '{hash}'})
    .on('file', (oldN, newN) => console.log(newN))
    .on('end', (jsonMap) => console.log(jsonMap));

I get the following error:

path.js:39
    throw new ERR_INVALID_ARG_TYPE('path', 'string', path);
    ^

TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type 
    at assertPath (path.js:39:11)

I can however fix this by adding the cwd option

hashmark(file, {length: 8, digest: 'md5', pattern: '{hash}', cwd: './'})

but I cannot find any documentation about this, so I'm wondering if there is an other problem here?

Furthermore, the jsonMap contains the following

{ '<anonymous>': '76f7816d' }

It is always <anonymouse>, and the reason behind this is file.fileName === '<anonymouse>' and is used here. Is this a bug?

[keithamus]

Thanks for the issue @scaljeri!

I'm afraid the programmatic usage docs haven't got much attention. PRs welcome 😉.

As you discovered, cwd is required. It should probably default to './' - I think this could be considered a bug.

With the fileName thing - I think what you might want to do is this:

const file = fs.createReadStream(fileName);
file.fileName = fileName // set fileName so hashmark knows what file this is
hashmark(file, {length: 8, digest: 'md5', pattern: '{hash}', cwd: './'})
    .on('file', (oldN, newN) => console.log(newN))
    .on('end', (jsonMap) => console.log(jsonMap));

Alternatively you can pass a file name and hashmark will do the createReadStream step for you:

hashmark(fileName, {length: 8, digest: 'md5', pattern: '{hash}', cwd: './'})
    .on('file', (oldN, newN) => console.log(newN))
    .on('end', (jsonMap) => console.log(jsonMap));

[scaljeri]

nice, thanks. If I have time I'll create a PR for the documentation!!