{"id":15659841,"url":"https://github.com/imdreamrunner/md5-webworker","last_synced_at":"2025-06-14T02:35:01.636Z","repository":{"id":57293421,"uuid":"85182033","full_name":"imdreamrunner/md5-webworker","owner":"imdreamrunner","description":"Compute MD5 of files in the background using web workers!","archived":false,"fork":false,"pushed_at":"2017-03-20T06:41:03.000Z","size":217,"stargazers_count":21,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-01T10:13:11.030Z","etag":null,"topics":["javascript","md5","web-worker"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/md5-webworker","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imdreamrunner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-16T10:14:32.000Z","updated_at":"2025-04-25T07:46:55.000Z","dependencies_parsed_at":"2022-09-01T06:40:20.923Z","dependency_job_id":null,"html_url":"https://github.com/imdreamrunner/md5-webworker","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdreamrunner%2Fmd5-webworker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdreamrunner%2Fmd5-webworker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdreamrunner%2Fmd5-webworker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdreamrunner%2Fmd5-webworker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imdreamrunner","download_url":"https://codeload.github.com/imdreamrunner/md5-webworker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251857021,"owners_count":21655121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","md5","web-worker"],"created_at":"2024-10-03T13:19:23.326Z","updated_at":"2025-05-01T10:13:19.606Z","avatar_url":"https://github.com/imdreamrunner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"MD5 WebWorker\n=============\n\n![MD5 WebWorker](misc/banner.png)\n\n**Compute MD5 of files in the background using web workers!**\n\nWeb Worker is a browser technology that allow some JavaScript code\nto be executed in the background, and very likely in another thread.\n\nThis library allows you to compute the MD5 hash in the background\nwithout blocking the user interface.\n\nThe MD5 computation in this library uses [spark-md5](https://github.com/satazor/js-spark-md5). \n\n[FileWorker](https://github.com/imdreamrunner/js-file-worker) is used\nto read files and compute MD5 in the background.\n\n[![Build Status](https://travis-ci.org/imdreamrunner/md5-webworker.svg?branch=master)](https://travis-ci.org/imdreamrunner/md5-webworker)\n\n## How to?\n\n**Step 1: Installation**\n\n\nYou can [download the latest release](https://github.com/imdreamrunner/md5-webworker/releases)\nfor browser and import it in HTML.\n\n```html\n\u003cscript src=\"md5-webworker.min.js\"\u003e\u003c/script\u003e\n```\n\nOr using NPM if you use webpack or TypeScript. This package\nis available on NPM called [file-worker](https://www.npmjs.com/package/md5-webworker)\nas well.\n\n```bash\nnpm install md5-webworker --save-dev\n```\n\nTo use this package in JavaScript, you can require it\n\n```javascript\nvar md5 = require(\"md5-webworker\");\n```\n\nor import it.\n\n```javascript\nimport md5 from \"md5-webworker\";\n```\n\nBecause this library is written in TypeScript, if you are using\nan editor like WebStorm, you shall be able to get the handy\nauto-completion.\n\n**Step 2: Use it**\n\nJust pass in the `File` object to the global function \n(`md5_webworker` in the browser)\nand get a promise of the MD5 hashed result in HEX.\n\nIn browser:\n\n```javascript\nmd5_webworker(file).then(function(md5hex) {\n    console.log(md5hex);\n})\n```\n\nIn webpack or TypeScript project:\n\n```javascript\nhex = await md5(file);\n```\n\n## License\n\n**ISC License**\n    \nCopyright (c) 2017, MD5 WebWorker Authors\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE\nOR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdreamrunner%2Fmd5-webworker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimdreamrunner%2Fmd5-webworker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdreamrunner%2Fmd5-webworker/lists"}