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.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

• Install
• Usage
• Customizing the timestamp
• Release history
  • v2.0.0
• About

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save time-stamp

Usage

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

console.log(timestamp());
//=> 2018-10-26

console.log(timestamp.utc());
//=> 2018-10-26

Customizing the timestamp

You may also pass a string to format the generated timestamp.

console.log(timestamp('YYYYMMDD'));
//=> 20181026

console.log(timestamp.utc('YYYYMMDD'));
//=> 20181026

Supported patterns

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

Usage Examples

console.log(timestamp('YYYYMMDD'));
//=> 20181026
console.log(timestamp.utc('YYYYMMDD'));
//=> 20181026

console.log(timestamp('YYYYMMDD:ss'));
//=> 20181026:24
console.log(timestamp.utc('YYYYMMDD:ss'));
//=> 20181026:24

console.log(timestamp('YYYY/MM/DD:mm:ss'));
//=> 2018/10/26:46:24
console.log(timestamp.utc('YYYY/MM/DD:mm:ss'));
//=> 2018/10/26:46:24

console.log(timestamp('YYYY:MM:DD'));
//=> 2018:10:26
console.log(timestamp.utc('YYYY:MM:DD'));
//=> 2018:10:26

console.log(timestamp('[YYYY:MM:DD]'));
//=> [2018:10:26]
console.log(timestamp.utc('[YYYY:MM:DD]'));
//=> [2018:10:26]

console.log(timestamp('YYYY/MM/DD'));
//=> 2018/10/26
console.log(timestamp.utc('YYYY/MM/DD'));
//=> 2018/10/26

console.log(timestamp('YYYY:MM'));
//=> 2018:10
console.log(timestamp.utc('YYYY:MM'));
//=> 2018:10

console.log(timestamp('YYYY'));
//=> 2018
console.log(timestamp.utc('YYYY'));
//=> 2018

console.log(timestamp('MM'));
//=> 10
console.log(timestamp.utc('MM'));
//=> 10

console.log(timestamp('DD'));
//=> 26
console.log(timestamp.utc('DD'));
//=> 26

console.log(timestamp('HH'));
//=> 00
console.log(timestamp.utc('HH'));
//=> 04

console.log(timestamp('mm'));
//=> 46
console.log(timestamp.utc('mm'));
//=> 46

console.log(timestamp('ss'));
//=> 24
console.log(timestamp.utc('ss'));
//=> 24

console.log(timestamp('ms'));
//=> 186
console.log(timestamp.utc('ms'));
//=> 186

Release history

v2.0.0

Breaking changes

Default pattern was changed from YYYY:MM:DD to YYYY-MM-DD. See issues/3 for more details.

About

Contributing

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

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

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 javascript 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

Contributors

Commits	Contributor
31	jonschlinkert
7	doowb
1	evocateur
1	mendenhallmagic
1	mvanroon
1	leesei
1	sleagon

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on October 26, 2018.