README.md

🚨 No longer maintained. Moved to @reallyland/node_mod. 🚨

utc-date

Generate JavaScript's UTC dates with various offsets

---

Returns a JavaScript date object using the UTC timezone with optional offsets to adjust the year, month, or date.

Table of contents

• Pre-requisites
• Setup
• Install
• Usage
  • TypeScript or ES Modules
  • Node.js
  • Browser
    • ES Modules
    • IIFE
• API Reference
  • UTCDateParams
  • utcDate([UTCDateParams])
  • utcDateSync([UTCDateParams])
• Related works
• License

Pre-requisites

• Node.js >= 8.9.0
• NPM >= 5.5.1 (NPM comes with Node.js so there is no need to install separately.)

Setup

Install

# Install via NPM
$ npm install --save @motss/utc-date

Usage

TypeScript or ES Modules

import {
  utcDate,
  // utcDateSync,
} from '@motss/utc-date';

void async function main() {
  /** NOTE: Assuming today's date is '2020-02-02', */
  const defaultUTCDate = await utcDate();
  const defaultUTCDateWithOffsets = await utcDate({
    offset: {
      year: 2,
      month: 1,
      day: 0,
    },
  });
  const specifiedUTCDate = await utcDate({
    startDate: '2030-03-02',
  });
  
  assert(defaultUTCDate, new Date('2020-02-02T00:00:00.000Z')); // OK
  assert(defaultUTCDateWithOffsets, new Date('2022-03-02T00:00:00.000Z')); // OK
  assert(specifiedUTCDate, new Date('2030-03-02T00:00:00.000Z')); // OK
}();

Node.js

const {
  utcDate,
  // utcDateSync,
} = require('@motss/utc-date');

void async function main() {
  /** NOTE: Assuming today's date is '2020-02-02', */
  const defaultUTCDate = await utcDate(); // utcDateSync();
  const defaultUTCDateWithOffsets = await utcDate({
    offset: {
      year: 2,
      month: 1,
      day: 0,
    },
  });
  const specifiedUTCDate = await utcDate({
    startDate: '2030-03-02',
  });

  assert(defaultUTCDate, new Date('2020-02-02T00:00:00.000Z')); // OK
  assert(defaultUTCDateWithOffsets, new Date('2022-03-02T00:00:00.000Z')); // OK
  assert(specifiedUTCDate, new Date('2030-03-02T00:00:00.000Z')); // OK
}();

Browser

ES Modules

<script type="module">
  import { utcDate } from 'https://unpkg.com/@motss/utc-date@latest/dist/utc-date.js';

  utcDate()
    .then(console.log)
    .catch(console.error);
</script>

IIFE

<script src="https://unpkg.com/@motss/utc-date@latest/dist/utc-date.iife.js"></script>
<script>
  const { utcDate } = window.UTCDate;

  utcDate()
    .then(console.log)
    .catch(console.error);
</script>

API Reference

UTCDateParams

• offsets <?Object> Optional offset values when returning a JavaScript Date object using the UTC timezone.
  • year <?number> Optional offset to adjust the year.
  • month <?number> Optional offset to adjust the month.
  • day <?number> Optional offset to adjust the day.
• startDate <?string|?number|?Date> Optional starting date. Defaults to today's date if it is not given.

utcDate([UTCDateParams])

• UTCDateParams <?UTCDateParams> Optional configuration when returning a JavaScript Date object using the UTC timezone.
• returns: <Promise<Date>> Promise which resolves with a JavaScript Date object using the UTC timezone.

utcDateSync([UTCDateParams])

This methods works the same as utcDate([UTCDateParams]) except that this is the synchronous version.

Related works

• utc-time - Manipulate UTC Time with ease in JavaScript

License

MIT License © Rong Sen Ng