{"id":16773854,"url":"https://github.com/dutiyesh/reading-time-emoji","last_synced_at":"2026-05-20T06:06:21.079Z","repository":{"id":57348692,"uuid":"185027562","full_name":"dutiyesh/reading-time-emoji","owner":"dutiyesh","description":"☕Format article reading time into emoji","archived":false,"fork":false,"pushed_at":"2019-05-05T13:45:17.000Z","size":56,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-23T18:38:43.861Z","etag":null,"topics":["article","blog","emoji","javascript","nodejs","reading-time"],"latest_commit_sha":null,"homepage":"","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/dutiyesh.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}},"created_at":"2019-05-05T12:20:52.000Z","updated_at":"2023-03-05T11:39:16.000Z","dependencies_parsed_at":"2022-09-16T20:51:00.028Z","dependency_job_id":null,"html_url":"https://github.com/dutiyesh/reading-time-emoji","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/dutiyesh%2Freading-time-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutiyesh%2Freading-time-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutiyesh%2Freading-time-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutiyesh%2Freading-time-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dutiyesh","download_url":"https://codeload.github.com/dutiyesh/reading-time-emoji/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243903167,"owners_count":20366434,"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":["article","blog","emoji","javascript","nodejs","reading-time"],"created_at":"2024-10-13T06:47:13.074Z","updated_at":"2026-05-20T06:06:21.054Z","avatar_url":"https://github.com/dutiyesh.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# reading-time-emoji [![Build Status](https://travis-ci.org/dutiyesh/reading-time-emoji.svg?branch=master)](https://travis-ci.org/dutiyesh/reading-time-emoji) [![gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/reading-time-emoji/index.js?compression=gzip)](https://cdn.jsdelivr.net/npm/reading-time-emoji/index.js)\n\n\u003e Format article reading time into emoji\n\n\n## Install\n\n```\nnpm install reading-time-emoji\n```\n\n\n## Usage\n\n```js\nconst formatReadingTime = require('reading-time-emoji');\n\nformatReadingTime(10);\n//=\u003e ☕☕ 10 min read\n\nformatReadingTime(50);\n//=\u003e 🍱🍱🍱🍱🍱 50 min read\n\nformatReadingTime(10, { short: '🍰', long: '🎂' });\n//=\u003e 🍰🍰 10 min read\n\nformatReadingTime(50, { short: '🍰', long: '🎂' });\n//=\u003e 🎂🎂🎂🎂🎂 50 min read\n\n```\n\n\n## API\n\n### formatReadingTime(minutes, [options])\n\nFormat article reading time into emoji.\n\n#### minutes\n\nType: `number`\n\nAccepts an article's reading time in minutes.\n\n#### options\n\nType: `object`\n\nDefault: `{ short: '☕', long: '🍱', base: 5 }`\n\n##### short\n\nType: `string`\n\nDefault: `'☕'`\n\nRepresents a unit of emoji equivalent to 5 minutes of reading time.\n\n```js\n'☕' emoji = 5 minutes\n```\n\n##### long\n\nType: `string`\n\nDefault: `'🍱'`\n\nFor long articles with reading time greater than `base`(Default: `5`) units of emoji, `long` unit of emoji is equivalent to 10 minutes of reading time.\n\n```js\n'🍱' emoji = 10 minutes\n```\n\n##### base\n\nType: `number`\n\nDefault: `5`\n\nA default base value for a unit of emoji.\n\n\n## Inspiration\n\nHeavily inspired by Dan Abramov's Overreacted blog articles reading time format.\n\n\n## License\n\nMIT © Dutiyesh Salunkhe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutiyesh%2Freading-time-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdutiyesh%2Freading-time-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutiyesh%2Freading-time-emoji/lists"}