{"id":15724089,"url":"https://github.com/sidneys/quicklook-thumbnail","last_synced_at":"2025-03-13T00:31:24.835Z","repository":{"id":76816543,"uuid":"43796266","full_name":"sidneys/quicklook-thumbnail","owner":"sidneys","description":"Use NodeJS to generate thumbnail images for all QuickLook-enabled filetypes (e.g. .mp4 videos, iMessage transcripts, text files) on Apple OSX.","archived":false,"fork":false,"pushed_at":"2016-07-06T19:03:00.000Z","size":1347,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-25T04:05:40.628Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sidneys.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-07T05:09:01.000Z","updated_at":"2023-04-17T09:59:18.000Z","dependencies_parsed_at":"2023-06-25T22:20:32.035Z","dependency_job_id":null,"html_url":"https://github.com/sidneys/quicklook-thumbnail","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"0ddab80573031156ce3580c68f388083d36031e0"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fquicklook-thumbnail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fquicklook-thumbnail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fquicklook-thumbnail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fquicklook-thumbnail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sidneys","download_url":"https://codeload.github.com/sidneys/quicklook-thumbnail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243318767,"owners_count":20272136,"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":[],"created_at":"2024-10-03T22:14:40.044Z","updated_at":"2025-03-13T00:31:24.825Z","avatar_url":"https://github.com/sidneys.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"quicklook-thumbnail\n====================================\n\n**Use NodeJS to generate thumbnail images for all QuickLook-enabled filetypes (e.g. .mp4 videos, iMessage transcripts, text files) on Apple OSX.**\n\n\nContents\n----\n\n1. [Supported Platforms](#supported-platforms)\n1. [Requirements](#requirements)\n1. [Installation](#installation)\n1. [Usage](#usage)\n1. [API](#api)\n1. [Limitations](#limitations)\n1. [Roadmap](#roadmap)\n1. [Author](#author)\n1. [License](#license)\n\n\n\u003ca name=\"supported-platforms\"\u003e\u003c/a\u003eSupported Platforms\n----\n \nTested on OSX 10.10 and 10.11\n\n\n\u003ca name=\"requirements\"\u003e\u003c/a\u003eRequirements\n----\n\nNode 4.0.0+\n\n \n## \u003ca name=\"installation\"\u003e\u003c/a\u003eInstallation\n\n```sh\nnpm install quicklook-thumbnail --save\n```\n\n\n## \u003ca name=\"usage\"\u003e\u003c/a\u003eUsage\n\nRequire the module, then call the asynchronous *create()* method:\n\n```javascript\nthumbnail = require('quicklook-thumbnail');\n\nvar options = {\n      size: 256,\n      folder: '/Users/johnqpublic/Documents'\n};\n\nthumbnail.create('/Users/johnqpublic/Desktop/video.mp4', options, function(err, result){\n  if (err) throw (err);\n  console.log(\"Created thumbnail at: \" + result);\n})\n```\n\n\n\u003ca name=\"api\"\u003e\u003c/a\u003eAPI\n----\n\n### #create()\n\n```javascript\ncreate: function (file, options, callback)\n```\n\nCreates a .png image thumbnail of the provided file.\n\n- Parameters\n   - **file** (String) - Absolute path to the video file\n   - **options** (Object)\n      - *folder* (String) - Directory to place the thumbnails (*Default: Directory of file*)\n      - *size* (Number) - Maximum width of the generated images in pixels (*Default: 512*)\n   - **callback** (Function) - Called with result when process terminates\n      - *error* (Error)\n      - *path* (String) - Absolute path to generated image\n\n\n\u003ca name=\"limitations\"\u003e\u003c/a\u003eLimitations\n----\n\nThis module can only generate thumbnails for files supported by the [Apple OS X Quick Look framework](https://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/Quicklook_Programming_Guide/Introduction/Introduction.html). Only PNG is supported as output image format.\n\nApart from h264 video files in mp4 containers (and many other media files) a multitude of document formats is supported out of the box.\n\nFor a list of all supported filetypes, please feel free to refer to [Wikipedia](https://en.wikipedia.org/wiki/Quick_Look#Supported_file_types_by_default).\n\n\n\u003ca name=\"roadmap\"\u003e\u003c/a\u003eRoadmap\n----\n - Tests\n\n\n\u003ca name=\"author\"\u003e\u003c/a\u003eAuthor\n----\nSidney Bofah  \n\n\n\u003ca name=\"license\"\u003e\u003c/a\u003eLicense\n----\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidneys%2Fquicklook-thumbnail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidneys%2Fquicklook-thumbnail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidneys%2Fquicklook-thumbnail/lists"}