timecord

TimeCord — Timestamps for Discord

TimeCord is a Node.js module that allows you to easily create timestamps!

Installation

npm install timecord

yarn add timecord

Basic usage

const { DiscordTimestamp } = require('timecord');

const timestamp = new DiscordTimestamp();
console.log(timestamp.format()); // -> <t:xxxxxxx:f>

Example

const { Client } = require('discord.js');
const client = new Client(...);

const { DiscordTimestamp } = require('timecord');

client.on('interactionCreate', (interaction) => {
	if (interaction.isChatInputCommand() && interaction.commandName === 'test-timestamp') {
		const createdDate = new DiscordTimestamp(interaction.createdAt).format();
		return interaction.reply({
			content: `Interaction created date: ${createdDate}`
		});
		// -> content: `Interaction created date: <t:xxxxxxxx:f>`
	}
});

Advanced example

const { DiscordTimestamp, StyleType, TimeUnits } = require('timecord');

const timestamp = new DiscordTimestamp(new Date(), StyleType.RelativeTime);

console.log(`You will be able to use this command again ${timestamp.addTime(2, TimeUnits.Hours).format()}.`);
// -> You will be able to use this command again in 2 hours.

Methods

Method	Parameters	Description
addTime	amount: number time?: TimeUnitResolvable	Adds time to the timestamp.
subtractTime	amount: number time?: TimeUnitResolvable	Subtracts time to the timestamp.
resetTimestamp	none	Resets the timestamp.
setTimestamp	timestamp: TimestampResolvable style?: StyleResolvable	Sets the timestamp.
setStyle	style: StyleResolvable	Sets the style.
format	style?: StyleResolvable	Formats the timestamp to a TimestampResult.

Types

Name	Type
TimestampResolvable	Date | number | string
TimestampStyle	"t" | "T" | "d" | "D" | "f" | "F" | "R"
TimestampResult	`<t:${number}:${StyleType[number]}>`
StyleResolvable	StyleType | keyof typeof StyleType
TimeUnitResolvable	TimeUnits | keyof typeof TimeUnits

Enums

Name	Property	Value	Example Output
TimeUnits	Miliseconds Seconds Minutes Hours Days	1 1000 60000 3.6e6 8.64e7	This will be multiplied by the number passed by parameters in a function. <Number> * <Value>
StyleType	ShortTime LongTime ShortDate LongDate ShortDateAndTime LongDateAndTime RelativeTime	't' 'T' 'd' 'D' 'f' 'F' 'R'	16:20 16:20:30 20/04/2021 20 April 2021 20 April 2021 16:20 Tuesday, 20 April 2021 16:20 2 months ago