PHP's md5_file in JavaScript

How to use

You you can install via yarn add locutus and require this function via const md5_file = require('locutus/php/strings/md5_file').

It is important to use a bundler that supports tree-shaking so that you only ship the functions that you actually use to your browser, instead of all of Locutus, which is massive. Examples are: Parcel, webpack, or rollup.js. For server-side use this is typically less of a concern.

Examples

Please note that these examples are distilled from test cases that automatically verify our functions still work correctly. This could explain some quirky ones.

#	code	expected result
1	md5_file('test/never-change.txt')	'bc3aa724b0ec7dce4c26e7f4d0d9b064'

Notes

• Relies on file_get_contents which does not work in the browser, so Node only.

• Keep in mind that in accordance with PHP, the whole file is buffered and then hashed. We’d recommend Node’s native crypto modules for faster and more efficient hashing

Here’s what our current JavaScript equivalent to PHP's md5_file looks like.

module.exports = function md5_file(str_filename) {
  //  discuss at: https://locutus.io/php/md5_file/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //    input by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: Kevin van Zonneveld (https://kvz.io)
  //      note 1: Relies on file_get_contents which does not work in the browser, so Node only.
  //      note 2: Keep in mind that in accordance with PHP, the whole file is buffered and then
  //      note 2: hashed. We'd recommend Node's native crypto modules for faster and more
  //      note 2: efficient hashing
  //   example 1: md5_file('test/never-change.txt')
  //   returns 1: 'bc3aa724b0ec7dce4c26e7f4d0d9b064'

  const fileGetContents = require('../filesystem/file_get_contents')
  const md5 = require('../strings/md5')
  const buf = fileGetContents(str_filename)

  if (buf === false) {
    return false
  }

  return md5(buf)
}

A community effort

Not unlike Wikipedia, Locutus is an ongoing community effort. Our philosophy follows The McDonald’s Theory. This means that we assimilate first iterations with imperfections, hoping for others to take issue with-and improve them. This unorthodox approach has worked very well to foster fun and fruitful collaboration, but please be reminded to use our creations at your own risk. THE SOFTWARE IS PROVIDED "AS IS" has never been more true than for Locutus.

Now go and: [ View on GitHub | Edit on GitHub | View Raw ]

---

« More PHP strings functions

Star