@stdlib/time
Version:
Time utilities.
41 lines (35 loc) • 996 B
TypeScript
/**
* @license Apache-2.0
*
* Copyright (c) 2022 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 4.1
/**
* Converts a number of milliseconds to a string duration.
*
* @param ms - number of milliseconds
* @returns duration
*
* @example
* var str = ms2duration( 1030 );
* // returns '1s30ms'
*
* @example
* var str = ms2duration( 3600000 );
* // returns '1h'
*/
declare function ms2duration( ms: number ): string;
// EXPORTS //
export = ms2duration;