@koalarx/utils/KlTime.d.ts

Biblioteca com validadores, conversores e abstrações de algumas problemáticas

import { KlTimeTimeType } from './types/KlTimeTimeType';
import { KlDateTimeZone } from './types/KlDateTimeZone';
export declare class KlTime extends Date {
    constructor();
    constructor(value: Date);
    constructor(hours?: number, minutes?: number, seconds?: number, ms?: number);
    /**
     * Formata o horário atual em uma string com base no padrão fornecido.
     * @param mask Máscara de formatação (ex.: 'HH:mm:ss').
     * @returns Uma string representando a data formatada.
     */
    format(mask?: string): string;
    /**
     * Altera o fuso horário (GMT) da data atual.
     * @param GMT String representando o GMT (ex.: '+3', '-2').
     * @returns Uma nova instância de `KlDate` com o GMT ajustado.
     */
    changeTimeZone(timeZone: KlDateTimeZone): KlTime;
    /**
     * Converte a data atual para o formato UTC.
     * @returns Uma nova instância de `KlDate` no formato UTC.
     */
    toUTC(): KlTime;
    /**
     * Adiciona uma quantidade de tempo à data atual.
     * @param qty Quantidade de tempo a ser adicionada.
     * @param type Tipo de unidade de tempo (ex.: 'seconds', 'minutes', 'hours').
     * @returns A própria instância de `KlDate` com a data ajustada.
     */
    add(qty: number, type: KlTimeTimeType): this;
    /**
     * Subtrai uma quantidade de tempo da data atual.
     * @param qty Quantidade de tempo a ser subtraída.
     * @param type Tipo de unidade de tempo (ex.: 'seconds', 'minutes', 'hours').
     * @returns A própria instância de `KlDate` com a data ajustada.
     */
    sub(qty: number, type: KlTimeTimeType): this;
    /**
     * Calcula a diferença entre a data atual e outra data fornecida.
     * @param date A data para calcular a diferença.
     * @param type Tipo de unidade de tempo para o cálculo (ex.: 'seconds', 'minutes').
     * @returns A diferença entre as datas na unidade especificada.
     */
    diff(date: Date, type: KlTimeTimeType): number;
}