@types/strftime
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.4 • Public • Published

    Installation

    npm install --save @types/strftime

    Summary

    This package contains type definitions for strftime (https://github.com/samsonjs/strftime).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/strftime.

    index.d.ts

    // Type definitions for strftime 0.9.2
    // Project: https://github.com/samsonjs/strftime
    // Definitions by: Cyril Schumacher <https://github.com/cyrilschumacher>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    
    declare module "strftime" {
        type strftimeFunction = (format: string, date?: Date) => string;
    
        namespace strftime {
            /**
             * Sets locale.
             * @param {Locale} locale A locale.
             * @return {strftimeFunction} A strftime function.
             */
            export function localize(locale: Locale): strftimeFunction;
    
            /**
             * Sets timezone.
             * @param {number|string} offset A offset.
             * @return {strftimeFunction} A strftime function.
             */
            export function timezone(offset: number | string): strftimeFunction;
    
            /**
             * Sets the timezone to UTC.
             * @return {strftimeFunction} A strftime function.
             */
            export function utc(): strftimeFunction;
    
            /**
             * Locale formats.
             * @interface
             */
            export interface LocaleFormats {
                D?: string | undefined;
                F?: string | undefined;
                R?: string | undefined;
                T?: string | undefined;
                X?: string | undefined;
                c?: string | undefined;
                r?: string | undefined;
                v?: string | undefined;
                x?: string | undefined;
            }
    
            /**
             * Locale.
             * @interface
             */
            export interface Locale {
                days?: Array<string> | undefined;
                shortDays?: Array<string> | undefined;
                months?: Array<string> | undefined;
                shortMonths?: Array<string> | undefined;
                AM?: string | undefined;
                PM?: string | undefined;
                am?: string | undefined;
                pm?: string | undefined;
                formats: LocaleFormats
            }
        }
    
        /**
         * Format a local time/date according to locale settings
         * @param {string} format A format.
         * @return {string} Returns a string formatted.
         */
        function strftime(format: string): string;
    
        /**
         * Format a local time/date according to locale settings
         * @param {string} format A format.
         * @param {Date}   date   A date.
         * @return {string} Returns a string formatted according format using the given date or the current local time.
         */
        function strftime(format: string, date: Date): string;
        export = strftime;
    }

    Additional Details

    • Last updated: Sat, 25 Sep 2021 22:31:21 GMT
    • Dependencies: none
    • Global values: none

    Credits

    These definitions were written by Cyril Schumacher.

    Keywords

    none

    Install

    npm i @types/strftime

    DownloadsWeekly Downloads

    19,922

    Version

    0.9.4

    License

    MIT

    Unpacked Size

    7.57 kB

    Total Files

    4

    Last publish

    Collaborators

    • types