@nfriend/amazon.date-normalizer
v1.2.7
Published
A JavaScript module that converts an AMAZON.DATE into a Moment.js object
Downloads
8
Readme
AMAZON.DATE Normalizer
A JavaScript module that converts an AMAZON.DATE into a Moment.js object.
Installation
This module is published to both npmjs.com and this project's GitLab's Package registry.
Installing from npmjs.com
yarn add @nfriend/amazon.date-normalizer
or:
npm install --save @nfriend/amazon.date-normalizer
Installing from the GitLab Package registry
Add the following to your project's .yarnrc
:
"@nfriend:registry" "https://gitlab.com/api/v4/packages/npm/"
Or, if you're using npm
, add this to .npmrc
:
@nfriend:registry=https://gitlab.com/api/v4/packages/npm/
Then, install the package:
yarn add @nfriend/amazon.date-normalizer
or:
npm install --save @nfriend/amazon.date-normalizer
Usage
import { normalize } from '@nfriend/amazon.date-normalizer';
const amazonDateString = '2015-W49-WE';
const eventDate = normalize(amazonDateString);
// prints "2015-01-01"
console.log(eventDate.format('YYYY-MM-DD'));
For a complete list of all cases this module handles, see
tests/index.test.ts
.
Timezone
The returned moment
object is always returned in UTC timezone.
No matter where the user is located, if they say "December 25th", this module will return an object like this:
const amazonDateString = '2015-12-25';
const eventDate = normalize(amazonDateString);
// prints "2015-12-25T00:00:00.000Z"
console.log(eventDate.toISOString());
Translating the date into the user's current timezone
To translate this date into the user's current timezone, use
moment-timezone
:
const upsServiceClient = handlerInput.serviceClientFactory.getUpsServiceClient();
deviceTimeZone = await upsServiceClient.getSystemTimeZone(
handlerInput.requestEnvelope.context.System.device.deviceId,
);
// The second parameter causes the date to be _moved_ into the user's
// timezone, not just translated. So `translatedDate` will not refer
// to the same moment in time as `eventDate`.
const translatedDate = eventDate.clone().tz(deviceTimeZone, true);
const keepOffset = true;
// prints "2015-12-25T00:00:00.000-05:00"
console.log(translatedDate.toISOString(keepOffset));
Publishing
This project uses Semantic Release to manage releases, which happens in this project's GitLab pipeline.
To trigger a new release, add a new commit with a message like this:
fix: Put out all the fires
and git push
on master
.
Environment variables
The GitLab pipeline relies on a few environment variables:
| Variable name | Description |
| -------------- | ---------------------------------------------------------------------- |
| GITLAB_TOKEN
| The token used by Semantic Release to interact with the GitLab project |
| NPM_TOKEN
| The token used by Semantic Release to publish the package to NPM |