time-stamp

What is time-stamp?

The time-stamp npm package is designed to create formatted timestamps. It allows users to generate timestamps based on the current date and time in a customizable format. This can be particularly useful for logging, file naming, or any other scenario where time-based identifiers are needed.

What are time-stamp's main functionalities?

Generating current date in default format

By default, time-stamp can generate the current date in the 'YYYY/MM/DD' format. This is useful for quickly obtaining a standardized date format without any configuration.

"YYYY/MM/DD"

Custom formatting of date and time

time-stamp allows for custom formatting of the date and time, enabling users to specify the exact format they need. This feature supports a wide range of tokens for years, months, days, hours, minutes, seconds, and milliseconds.

"YYYY:MM:DD HH:mm:ss.ms"

Other packages similar to time-stamp

moment

Moment.js is a comprehensive date handling library that allows for parsing, validating, manipulating, and formatting dates. Compared to time-stamp, Moment.js offers a broader set of functionalities for dealing with dates and times, including support for time zones and localization.

date-fns

date-fns provides a collection of simple, pure functions for performing various operations on dates. It's modular, allowing users to pick and choose which functions they need. While time-stamp focuses on generating timestamps, date-fns offers more general-purpose date manipulation and formatting capabilities.

dayjs

Day.js is a lightweight date library that offers a similar API to Moment.js. It's designed to be immutable and chainable, making it easy to parse, validate, manipulate, and display dates and times. Compared to time-stamp, Day.js provides a more comprehensive solution for date handling while maintaining a small footprint.

README

time-stamp

Get a formatted timestamp.

Install

Install with npm:

$ npm install time-stamp --save

Usage

var timestamp = require('time-stamp');

timestamp();
//=> '2015:04:01'

timestamp('YYYY:MM:DD');
//=> '2015:04:01'

timestamp('[YYYY:MM:DD]');
//=> '[2015:04:01]'

timestamp('YYYY/MM/DD');
//=> '2015/04/01'

timestamp('YYYY:MM');
//=> '2015:04'

timestamp('YYYY');
//=> '2015'

timestamp('MM');
//=> '04'

timestamp('DD');
//=> '01'

timestamp('HH');
//=> '01'

timestamp('mm');
//=> '59'

timestamp('ss');
//=> '09'

timestamp('ms');
//=> '783'

Valid patterns

• YYYY: full year (ex: 2015)
• MM: month (ex: 04)
• DD: day (ex: 01)
• HH: hours (ex: 12)
• mm: minutes (ex: 59)
• ss: seconds (ex: 09)
• ms: milliseconds (ex: 532)

Related projects

You might also be interested in these projects:

• days: Days of the week. | homepage
• iso-week: Get the ISO week of the year. | homepage
• month: Get the name or number of the current month or any month of the year. | homepage
• months: Months of the year. | homepage
• o-clock: Simple utility for displaying the time in 12-hour clock format. | homepage
• seconds: Get the number of seconds for a minute, hour, day and week. | homepage
• week: Get the current week number. | homepage
• weekday: Get the name and number of the current weekday. Or get the name of the… more | homepage
• year: Simple utility to get the current year with 2 or 4 digits. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

Follow me on GitHub or Twitter for updates about time-stamp and my other libraries:

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v, on April 07, 2016.