Módulo Node.JS para buscar a hora atual dos servidores NTP e retornar informações de deslocamento.
O NTP requer UDP que não está disponível no contexto do navegador!
# using Yarn
$ yarn add ntp-time-sync
# using NPM
$ npm install ntp-time-sync
Considere usar a biblioteca como um singleton, para que nem todas as chamadas para getTime
disparem novos pacotes NTP. A própria biblioteca gerenciará os tempos mínimos/máximos de pesquisa.
Várias solicitações para vários servidores de horário NTP são disparadas e as respostas serão agregadas.
// ES6:
import { NtpTimeSync } from "ntp-time-sync" ;
// pre-ES6:
// const NtpTimeSync = require("ntp-time-sync").NtpTimeSync;
const timeSync = NtpTimeSync . getInstance ( ) ;
// request 1
timeSync . getTime ( ) . then ( function ( result ) {
console . log ( "current system time" , new Date ( ) ) ;
console . log ( "real time" , result . now ) ;
console . log ( "offset in milliseconds" , result . offset ) ;
} )
// request 2, will use cached offset from previous request
timeSync . getTime ( ) . then ( function ( result ) {
console . log ( "current system time" , new Date ( ) ) ;
console . log ( "real time" , result . now ) ;
console . log ( "offset in milliseconds" , result . offset ) ;
} )
// ES2017 style
const result = await timeSync . getTime ( ) ;
console . log ( "real time" , result . now ) ;
<ntpTimeSyncInstance>.getTime()
retorna um objeto Promise
que eventualmente será resolvido com um objeto contendo as seguintes informações:
Propriedade | Descrição |
---|---|
now | Hora NTP atual ("tempo real") |
offset | Deslocamento calculado entre a hora do sistema local e a hora NTP |
<ntpTimeSyncInstance>.now()
retorna um objeto Date
contendo a hora correta do momento em que a função foi chamada. Ao contrário de getTime()
, que retornará a hora correta no momento em que a promessa for resolvida.
Você pode passar opções personalizadas para o construtor de NtpTimeSync
ou NtpTimeSync.getInstance(options)
. Eles serão mesclados com os seguintes padrões:
const defaultOptions = {
// list of NTP time servers, optionally including a port (defaults to 123)
servers : [
"0.pool.ntp.org" ,
"1.pool.ntp.org" ,
"2.pool.ntp.org" ,
"3.pool.ntp.org"
] ,
// required amount of valid samples in order to calculate the time
sampleCount : 8 ,
// amount of time in milliseconds to wait for a single NTP response
replyTimeout : 3000 ,
// defaults as of RFC5905
ntpDefaults : {
port : 123 ,
version : 4 ,
tolerance : 15e-6 ,
minPoll : 4 ,
maxPoll : 17 ,
maxDispersion : 16 ,
minDispersion : 0.005 ,
maxDistance : 1 ,
maxStratum : 16 ,
precision : - 18 ,
referenceDate : new Date ( "Jan 01 1900 GMT" )
}
} ;