refactor: rename ISOTimeToRippleTime to isoTimeToRippleTime (#1754)

* rename `ISOTimeToRippleTime` to avoid triggering linters

* add tests for time conversion
This commit is contained in:
Mayukha Vadari
2021-10-19 11:53:10 -04:00
committed by GitHub
parent 6bbd593ed7
commit d502d4aac7
3 changed files with 55 additions and 6 deletions

View File

@@ -48,7 +48,7 @@ import {
import signPaymentChannelClaim from './signPaymentChannelClaim'
import {
rippleTimeToISOTime,
ISOTimeToRippleTime,
isoTimeToRippleTime,
rippleTimeToUnixTime,
unixTimeToRippleTime,
} from './timeConversion'
@@ -186,7 +186,7 @@ export {
xrpToDrops,
hasNextPage,
rippleTimeToISOTime,
ISOTimeToRippleTime,
isoTimeToRippleTime,
rippleTimeToUnixTime,
unixTimeToRippleTime,
percentToQuality,

View File

@@ -34,19 +34,20 @@ function rippleTimeToISOTime(rippleTime: number): string {
}
/**
* Convert an Iso8601 timestmap to a ripple timestamp.
* Convert an ISO8601 timestmap to a ripple timestamp.
*
* @param iso8601 - International standard date format.
* @returns Seconds since ripple epoch (1/1/2000 GMT).
* @category Utilities
*/
function ISOTimeToRippleTime(iso8601: string): number {
return unixTimeToRippleTime(Date.parse(iso8601))
function isoTimeToRippleTime(iso8601: string | Date): number {
const isoDate = typeof iso8601 === 'string' ? new Date(iso8601) : iso8601
return unixTimeToRippleTime(isoDate.getTime())
}
export {
rippleTimeToUnixTime,
unixTimeToRippleTime,
rippleTimeToISOTime,
ISOTimeToRippleTime,
isoTimeToRippleTime,
}

View File

@@ -0,0 +1,48 @@
import { assert } from 'chai'
import {
rippleTimeToISOTime,
isoTimeToRippleTime,
unixTimeToRippleTime,
rippleTimeToUnixTime,
} from '../../src'
describe('time conversion', function () {
describe('rippleTimeToISOTime', function () {
it('converts ripple time to ISO time', function () {
const rippleTime = 0
const isoTime = '2000-01-01T00:00:00.000Z'
assert.equal(rippleTimeToISOTime(rippleTime), isoTime)
})
})
describe('isoTimeToRippleTime', function () {
it('converts ISO time to ripple time', function () {
const rippleTime = 0
const isoTime = '2000-01-01T00:00:00.000Z'
assert.equal(isoTimeToRippleTime(isoTime), rippleTime)
})
it('converts from Date', function () {
const rippleTime = 0
const isoTime = '2000-01-01T00:00:00.000Z'
assert.equal(isoTimeToRippleTime(new Date(isoTime)), rippleTime)
})
})
describe('unixTimeToRippleTime', function () {
it('converts unix time to ripple time', function () {
const unixTime = 946684801000
const rippleTime = 1
assert.equal(unixTimeToRippleTime(unixTime), rippleTime)
})
})
describe('rippleTimeToUnixTime', function () {
it('converts ripple time to unix time', function () {
const unixTime = 946684801000
const rippleTime = 1
assert.equal(rippleTimeToUnixTime(rippleTime), unixTime)
})
})
})