{"_id":"shleemy","_rev":"13-20041520910877597cae638f9c1c9b03","name":"shleemy","dist-tags":{"latest":"1.2.2"},"versions":{"1.0.0":{"name":"shleemy","version":"1.0.0","main":"src/index.ts","devDependencies":{"@types/jest":"^26.0.20","jest":"^26.6.3","prettier":"^2.2.1","ts-jest":"^26.4.4","typescript":"^4.1.3"},"author":{"name":"Ashleigh Simonelli","email":"ashleighsimonelli@gmail.com","url":"http://ashleighsimonelli.co.uk"},"license":"MIT","repository":{"type":"git","url":"https://github.com/bashleigh/carbon"},"description":"

\"sh","keywords":[],"scripts":{"format":"prettier\n \"test\n \n Coverage Status\n

\n\n

Simple human readable intervals for those that don't want to go to time prison.

\n

Handy interval diff object for customisable, rounded, human readable phrases such as \"in 3 days\", \"12 years ago\", \"a minute ago\", \"just now\".

\n\n

\n \n \"shleemypants\"/\n \n\n - Small\n - Mighty \n - No dependencies\n - Easy to use\n - You won't go to time prison for messing with time\n

\n\n> Inspiration take from [Carbon](https://github.com/briannesbitt/carbon)\n\n### Install\n\n```bash\n$ yarn add shleemy\n```\n\nOr \n\n```npm\n$ npm i shleemy\n```\n\n### Usage\n\n##### Basic\n\nGet human readable values with tense information\n\n**Present**\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst interval = shleemy(new Date());\n\nconsole.log(interval.forHumans); // \"just now\"\nconsole.log(interval.tense); // \"present\"\n```\n**Past**\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setMinutes(date.getMinutes() - 3);\n\nconsole.log(shleemy(date).forHumans); // \"3 minutes ago\"\nconsole.log(shleemy(date).tense); // \"past\"\n```\n**Future**\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setMinutes(date.getMinutes() + 70);\n\nconsole.log(shleemy(date).forHumans); // \"in an hour\"\nconsole.log(shleemy(date).tense); // \"future\"\n```\n\n##### interval values\n\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setHours(date.getHours() - 3);\n\nconsole.log(shleemy(date).roundedHours); // 3\n```\n\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setDays(date.getDays() - 12);\n\nconsole.log(shleemy(date).roundedDays); // 12\nconsole.log(shleemy(date).roundedWeeks); // 1\n```\n\n##### Basic Formatting\n\n```ts\nconst date = new Date();\ndate.setDays(date.getDays() - 12);\n\nconst interval = shleemy(date);\n\nconsole.log(interval.time); // 12:34\nconsole.log(interval.date); // 12/03/2021\n```\n> No locale as of now, so you backwards date people will have to do with day/month/year. Soz\n\n### Output manipulation\n\nThe Shleemy object can be used as a string! \n\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setDays(date.getDays() - 12);\n\nconst interval = shleemy(date);\n\nconsole.log(`added ${interval}`); // added 12 days ago;\nconsole.log(`${interval.replace('days', 'yonders')}`); // 12 yonders ago;\n```\n\n**Available properties**\n\n```ts\nimport { shleemy } from \"shleemy\";\n\nconst date = new Date();\ndate.setDays(date.getDays() - 12);\nconst interval = shleemy(date);\n\nconsole.log('seconds', interval.seconds);\nconsole.log('rounded seconds', interval.roundedSeconds);\nconsole.log('minutes', interval.minutes);\nconsole.log('rounded minutes', interval.roundedMinutes);\nconsole.log('hours', interval.hours);\nconsole.log('rounded hours', interval.roundedHours);\nconsole.log('days', interval.days);\nconsole.log('rounded days', interval.roundedDays);\nconsole.log('weeks', interval.weeks);\nconsole.log('rounded weeks', interval.roundedWeeks);\nconsole.log('months', interval.months);\nconsole.log('rounded months', interval.roundedMonths);\nconsole.log('years', interval.years);\nconsole.log('rounded years', interval.roundedYears);\nconsole.log('tense', interval.tense);\n```\n> All properties will be positive values. You cannot have -3 days in the 4th dimension. Use `tense` for past/present/future value\n\n### Options\n\n```ts\nimport { shleemy, ShleemyInterval } from \"shleemy\";\n\nconst date = new Date();\ndate.setDays(date.getDays() - 12);\n\nconst toDate = new Date();\ntoDate.setDays(toDate.getDays() - 20);\n\nconsole.log(\n shleemy(date, {\n toDate: toDate, // default: new Date() (now)\n rounding: 'ceil', // default: floor\n humanReadable: {\n past: (value, interval) => `${value} ${ShleemyInterval.pluralInterval(value, interval)} yonders ago`, // default: ShleemyInterval.toHumanReadablePast\n future: (value, interval) => `in ${value} ${ShleemyInterval.pluralInterval(value, interval)} and you get the idea`, // default: ShleemyInterval.toHumanReadableFuture\n present: () => `seconds ago!`, // default: \"just now\"\n }\n }).days\n); // 8\n```\n","readmeFilename":"README.md"}