Skip to content

Zertz/superspeed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

superspeed Build Status NPM version

Calculate speed for a given time and distance

Install

$ npm install --save superspeed

Usage

const superspeed = require('superspeed');

superspeed({
  time: 3600000,
  distance: 10000
});
//=> 5 (km/h)

superspeed({
  time: 3600000,
  distance: 5000,
  metric: false
});
//=> 3.1068559611866697 (mi/h)

superspeed({
  time: 3600000,
  distance: 5000,
  timeDivider: 1000,
  distanceDivider: 1
});
//=> 1.38 (m/s)

API

superspeed(options)

options

time

Type: number

Time in milliseconds

distance

Type: number

Distance in meters

timeDivider

Type: number

Default: 3600000 (1 hour)

Calculate speed in distance per this unit of time

distanceDivider

Type: number

Default: 1000 (1 km)

Calculate speed in this unit of distance per time

metric

Type: boolean

Default: true

License

MIT © Pier-Luc Gendreau

About

Calculate speed for a given time and distance

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published