How to use the format function from date-fns

Find comprehensive JavaScript date-fns.format code examples handpicked from public code repositorys.

date-fns.format is a function that formats a date object or a timestamp into a string according to a specified format string.

55
56
57
58
59
60
61
62
63
64
  final = datefns.add(final, diff); // date-fns.add() supports negative numbers as well
}

if (format) {
  try {
    return datefns.format(final, format, { locale });
  } catch (error) {
    return '#invalid format#';
  }
}
fork icon28
star icon313
watch icon7

+ 11 other calls in file

94
95
96
97
98
99
100
101
102
103
104
105
}


function getDate(ts) {
  // Returns date fit for file name
  let date = new Date(ts);
  return format(date,"yyyy-MM-dd")
}


function skewDays(days) {
  // days equal to 0 is today
fork icon14
star icon88
watch icon2

+ 134 other calls in file

How does date-fns.format work?

date-fns.format works by taking two inputs: a date object or a timestamp and a format string.

The function uses the format string to build a formatted string representation of the input date, based on the individual components of the date (e.g. year, month, day, hour, minute, second, etc.).

The format string is a string that contains special tokens that represent the various components of the date, such as 'YYYY' for the year, 'MM' for the month, and 'DD' for the day.

When the function encounters one of these tokens in the format string, it replaces it with the corresponding component of the input date.

For example, if the input date is March 14, 2022, and the format string is 'YYYY-MM-DD', the function would replace the 'YYYY' token with '2022', the 'MM' token with '03', and the 'DD' token with '14', resulting in the formatted string '2022-03-14'.

The resulting formatted string can be used for display or further processing.

87
88
89
90
91
92
93
94
95
96
97
  // Negative values are daycount in the past
  // Positive are daycount in the future
  let oneDay = 24 * 60 * 60 * 1000;
  let now = new Date();
  let date = new Date(now.getTime() + oneDay * offset);
  let ret = format(date, 'dd-MM-yyyy');
  return ret;
}


function skewDays(offset) {
fork icon14
star icon88
watch icon2

+ 83 other calls in file

111
112
113
114
115
116
117
118
119
120
  // Negative values are daycount in the past
  // Positive are daycount in the future
  let oneDay = 24 * 60 * 60 * 1000;
  let now = new Date();
  let date = new Date(now.getTime() + oneDay * days);
  return format(date, 'yyyy-MM-dd');
}

function getFileName(priceDate) {
  return savePath + "/prices-" + priceDate + ".json";
fork icon14
star icon88
watch icon2

+ 5 other calls in file

Ai Example

1
2
3
4
5
6
7
8
9
const { format } = require("date-fns");

// Create a date object representing March 14, 2022 at 2:30 PM
const date = new Date("2022-03-14T14:30:00");

// Format the date as a string using the format string 'MMMM d, yyyy h:mm a'
const formattedDate = format(date, "MMMM d, yyyy h:mm a");

console.log(formattedDate); // "March 14, 2022 2:30 PM"

In this example, we first create a date object representing March 14, 2022 at 2:30 PM. We then pass this date object to the date-fns.format function along with a format string that specifies how the date should be formatted. The format string MMMM d, yyyy h:mm a specifies that the date should be formatted as the full month name (MMMM), followed by the day of the month (d), followed by the four-digit year (yyyy), followed by the hour (h) and minute (mm) of the time in 12-hour clock format (a specifies AM/PM). The resulting formatted string, "March 14, 2022 2:30 PM", is then printed to the console.

58
59
60
61
62
63
64
65
66
67

const thisWeek = rows.filter(row => dateFns.isWithinInterval(dateFns.parseISO(row.date), { start: startOfBootWeek, end: endOfBootWeek }));
const thisMonth = rows.filter(row => dateFns.isWithinInterval(dateFns.parseISO(row.date), { start: startOfBootMonth, end: endOfBootMonth }));
const thisYear = rows.filter(row => dateFns.isWithinInterval(dateFns.parseISO(row.date), { start: startOfBootYear, end: endOfBootYear }));

daily = rows.find(row => row.date === dateFns.format(new Date(), 'yyyy-MM-dd')).count;
weekly = thisWeek.reduce((total, date) => total += date.count, 0);
monthly = thisMonth.reduce((total, date) => total += date.count, 0);
yearly = thisYear.reduce((total, date) => total += date.count, 0);
fetchedDaysAmount = thisMonth.length;
fork icon9
star icon40
watch icon0

+ 7 other calls in file

30
31
32
33
34
35
36
37
38
39

    return `${dd}.${mm}.${yyyy}`;
}

function timestampToIsoTzFormat(timestamp) {
    return format(new Date(timestamp * 1000), 'yyyy-MM-dd\'T\'HH:mm:ss.SSXXX');
}

function dateToTimestamp(date) {
    return getTime(date) / 1000;
fork icon9
star icon13
watch icon4

87
88
89
90
91
92
93
94
95
  { name: 'düzce', variants: [], chunk: false },
];

const filter = name => getAll().filter(c => c.name === name || c.variants.includes(name));

const formatDate = date => format(date, 'yyyy-MM-dd');

const dateIntervalToRange = interval => {
  const dates = [];
fork icon4
star icon12
watch icon3

66
67
68
69
70
71
72
73
74
75
  slug,
  title,
  author,
  excerpt,
  series,
  date: format(createdOn, 'yyyy-MM-dd', {}),
  published: false,
  tags: tagsList,
  cover: '',
});
fork icon3
star icon14
watch icon3

13
14
15
16
17
18
19
20
21
22
})
const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout
});
const date = dateFns.format(new Date(), format)
const timeZone = 'America/Toronto'

const etcFormat = 'YYYY-MM-DD HH:mm:ss.SSS [GMT]Z (z)'
const etcDate = formatToTimeZone(new Date(), etcFormat, { timeZone })
fork icon3
star icon18
watch icon3

+ 15 other calls in file

216
217
218
219
220
221
222
223
224
225
The market is closed.
```

But we would also like to know when the exchange is working, so that we know at what point it is time to start trading.
```
const date = dateFns.format(today, format)
alpaca.getCalendar({
    start: date,
    end: date
}).then((calendars) => {
fork icon3
star icon18
watch icon3

+ 13 other calls in file

73
74
75
76
77
78
79
80
81
82
  return backups;
}

export async function updateBackups(backups) {
  const byDay = backups.reduce((groups, backup) => {
    const day = dateFns.format(backup.date, 'yyyy-MM-dd');
    groups[day] = groups[day] || [];
    groups[day].push(backup);
    return groups;
  }, {});
fork icon542
star icon5
watch icon0

+ 3 other calls in file

49
50
51
52
53
54
55
56
57
58
eleventyConfig.addPassthroughCopy('src/css');
eleventyConfig.addPassthroughCopy('src/js');
eleventyConfig.addPassthroughCopy('_redirects');

eleventyConfig.addFilter('asDateOnly', function (date) {
        return format(new Date(date), 'PP');
});

eleventyConfig.addFilter('toISOString', function (date) {
        return new Date(date).toISOString();
fork icon11
star icon14
watch icon0

104
105
106
107
108
109
110
111
112
113
  checkInSteps = [],
  clinicStopCodeName = 'Mental health',
  doctorName = 'Dr. Jones',
  clinicIen = '0001',
} = {}) => {
  const formattedStartTime = dateFns.format(
    startTime,
    isoDateWithoutTimezoneFormat,
  );

fork icon124
star icon219
watch icon0

21
22
23
24
25
26
27
28
29
30
const getFeedbackTargetLink = feedbackTarget => {
  const { noAdUser, possiblyNoAdUser, name, username, userId, id, closesAt } = feedbackTarget
  const language = feedbackTarget.language ? feedbackTarget.language : 'en'

  const closeDate = new Date(closesAt)
  const formattedCloseDate = format(closeDate, 'dd.MM.yyyy')
  const expirationDate = (() => {
    const d = new Date(closeDate)
    d.setDate(d.getDate() + NOAD_LINK_EXPIRATION_DAYS)
    return d
fork icon3
star icon10
watch icon7

+ 3 other calls in file

66
67
68
69
70
71
72
73
74
                user : msgObj.user,
                text : msgObj.text,
                thread : msgObj.thread_ts,

                //date : datefns.format(new Date(), 'dd/MMM/yyy - H:mm:ss'), //for v2 of datefns
                //date : datefns.format(new Date(), 'DD/MMM/YYYY - H:mm:ss'),
                //date : datefns.format(new Date(), 'YYYY-MM-DD H:mm:ss'),
        }
}
fork icon7
star icon6
watch icon3

+ 5 other calls in file

161
162
163
164
165
166
167
168
169
170
const { format } = require('date-fns')

module.exports = {
  helpers: {
    getDateTime: function (formatStr) {
      return format(new Date(), formatStr)
    },
  },
}
```
fork icon1
star icon6
watch icon2

37
38
39
40
41
42
43
44
45
46
return metalsmith(__dirname)
  .metadata({
    site: JSON.parse(fs.readFileSync(path.resolve(__dirname, './about.json'))),
    webpack: JSON.parse(fs.readFileSync(path.resolve(__dirname, './build/static/manifest.json'))),
    build_date: formatISO(date),
    build_date_formatted: format(date, 'PPpp'),
    revno: require('child_process')
      .execSync('git rev-parse --short origin/master')
      .toString().trim()
  })
fork icon1
star icon1
watch icon0

79
80
81
82
83
84
85
86
87
 * getDatetimeTime
 */

function getDatetimeTime(date, timeZone = 'America/New_York') {
  const parsed = utcToZonedTime(date, timeZone);
  return format(parsed, "h:mmaaaaa'm'", {
    timeZone
  });
}
fork icon0
star icon3
watch icon2

+ 3 other calls in file

235
236
237
238
239
240
241
242
243
244

```js
const date = new Date('2019/01/01');
const frenchLocale = require('date-fns/locale/fr');
const format = require('date-fns/format');
const formattedDate = format(date, 'EEEE,MMMM do, yyyy hh:mm a', {
    locale: frenchLocale
});
console.log(formattedDate);
```
fork icon896
star icon2
watch icon1

+ 11 other calls in file

2
3
4
5
6
7
8
9
10
11

const ENDPOINT = 'https://api.npmjs.org/downloads/range/'
const PACKAGE = 'typeset.css'

function formatDate(date) {
    return format(date, 'YYYY-MM-DD')
}

async function fetchDownloads(endpoint) {
    return await fetch(endpoint)
fork icon0
star icon20
watch icon1

Other functions in date-fns

Sorted by popularity

function icon

date-fns.format is the most popular function in date-fns (3838 examples)