Like JSON.stringify, but preserve timezones in date objects and parse dates into Date object
npm install json-stringify-date!Build Status
Like JSON.stringify, but preserve timezones in date objects and parse dates into ``Date` object.
npm install json-stringify-date
Takes the same arguments as JSON.stringify and JSON.parse.
`javascript`
var stringifyDate = require('json-stringify-date');
var obj = {d: new Date(2014, 02, 4)};
console.log(stringifyDate.stringify(obj, null, 2));
var text = '{"d": "2014-03-04T00:00:00.000-03:00"}';
console.log(stringifyDate.parse(text));
Output:
`
{
"d": "2014-03-04T00:00:00.000-03:00"
}
{ d: Tue Mar 04 2014 00:00:00 GMT-0300 (BRT) }
stringifyDate.stringify(value [, replacer [, space]])
Executes exactly the
JSON.stringify`, but can preserve time zones in dates.$3
`
stringifyDate.parse(text [, reviver])
Returns the object containing dates.
$3
stringifyDate.getReviver([reviver])
Gets the function passed to
JSON.parse`, has the ability to pass an inner function through optional parameter `reviver`.$3
`
stringifyDate.getReplacer([replacer])
Gets the function passed to
JSON.stringify`, has the ability to pass an inner function through optional parameter `replacer`.$3
`
stringifyDate.getOptions()
Gets the options current set.
$3
stringifyDate.setOptions({...})
Sets the options that will be used.
#### utc
_type_: boolean _default_: false
Format date in utc format
javascript
var stringifyDate = require('json-stringify-date');
var obj = {d: new Date(2014, 02, 4)};
stringifyDate.setOptions({utc: true});
console.log(stringifyDate.stringify(obj));
stringifyDate.setOptions({utc: false}); //this is the default
console.log(stringifyDate.stringify(obj));
`
Output:
{"d": "2014-03-04T00:00:00.000Z"}
{"d": "2014-03-04T00:00:00.000-03:00"}
#### fnCheck
_type_: function (string, string)
_returns_: boolean
Function to check whenever a string is a valid date
javascript
var stringifyDate = require('json-stringify-date');
var fallbackFnCheck = stringifyDate.getOptions().fnCheck;
stringifyDate.setOptions({ fnCheck: function (key, value) {
if (key == 'not-a-date-key') {
return value;
}
return fallbackFnCheck(key, value);
} });
console.log(stringifyDate.parse({'not-a-date-key': '2020-01-01','d': '20200101'}));
`
Output:
{
'not-a-date-key': '2020-01-01', // string
d : 2020-01-01T00:00:00.000Z // [object Date]
}
#### fnReplacerCheck
_type_: function (string, string)
_returns_: boolean
Function to check whenever a string is a valid date
javascript
var stringifyDate = require('json-stringify-date');
var fallbackFnCheck = stringifyDate.getOptions().fnReplacerCheck;
stringifyDate.setOptions({ fnReplacerCheck: function (key, value) {
if (key == 'not-a-date-key') {
return value;
}
return fallbackFnCheck(key, value);
} });
console.log(stringifyDate.stringify({'not-a-date-key': new Date("2020-01-01T00:00:00"), 'd': new Date("2020-01-01T00:00:00")}));
`
Output:
{
'not-a-date-key': '2020-01-01', // string
d : 2020-01-01T00:00:00.000Z // [object Date]
}
Using with ExpressJS
To use it with ExpressJS, follow this example.
The magic really happens in passing
to body-parser 'reviver option', it makes the json parser to serialize date strings into date objects.
Also, optionally you can pass getReplacer([replacer]) to body-parser 'json replacer setting', it makes the resulting json to preserve timezones.`javascript
var express = require('express');
var bodyParser = require('body-parser');
var jsonStringifyDate = require('json-stringify-date');
var app = express();
app.use(bodyParser.json({reviver: jsonStringifyDate.getReviver()}));
app.set('json replacer', jsonStringifyDate.getReplacer());
app.post('/test', function (req, res) {
req.body.somedate // do something
res.json({date: new Date()});
});
app.listen(3000);
`TypeScript Support
This library includes TypeScript definitions. Here's how to use it with TypeScript:
typescript
import * as stringifyDate from 'json-stringify-date';interface MyData {
timestamp: Date;
message: string;
}
// Stringify with preserved timezone
const data: MyData = {
timestamp: new Date(),
message: "Hello world"
};
const json = stringifyDate.stringify(data);
console.log(json);
// Parse with automatic date conversion
const parsedData = stringifyDate.parse(json) as MyData;
console.log(parsedData.timestamp instanceof Date); // true
`Using with Browser
Add tag
, you can also use webpack or any other packaging system.Than you will have the object
JSONStringifyDate in the global context (window) so you can run things like`javascript
JSONStringifyDate.parse('{"d": "2014-03-04T00:00:00.000-03:00"}');
`Output:
{ d: Tue Mar 04 2014 00:00:00 GMT-0300 (BRT) }
We welcome contributions to improve this library! Please check out our Contributing Guide for guidelines on how to proceed.
This project follows good security practices. If you discover a security vulnerability, please see our Security Policy for the proper reporting procedure.
See LICENSE