pear-apps-utils-date

A collection of date utility functions for formatting and comparing dates.

Table of Contents

• Features
• Installation
• Usage
• Examples
  • Format Dates
  • Compare Dates
• Dependencies
• Related Projects

Features

• Format dates with customizable patterns using formatDate
• Compare dates with isAfter to check if one date is later than another
• Compare dates with isBefore to check if one date is earlier than another
• Support for both Date objects and string date inputs
• Customizable date separators
• Month and weekday abbreviations

Installation

npm install pear-apps-utils-date

Usage

Import the functions you need:

import { formatDate, isAfter, isBefore } from 'pear-apps-utils-date';

Examples

Format Dates

// Basic formatting (default: yyyy-mm-dd)
formatDate(new Date('2023-05-15'));
// Output: '2023-05-15'

// Custom format
formatDate(new Date('2023-05-15'), 'dd-mm-yyyy');
// Output: '15-05-2023'

// Custom separator
formatDate(new Date('2023-05-15'), 'yyyy-mm-dd', '/');
// Output: '2023/05/15'

// With month abbreviation
formatDate(new Date('2023-05-15'), 'dd-mmm-yyyy');
// Output: '15-May-2023'

// With weekday abbreviation
formatDate(new Date('2023-05-15'), 'ddd-mm-dd');
// Output: 'Mon-05-15'

Compare Dates

// Check if a date is after another
isAfter('2023-01-02', '2023-01-01');
// Output: true

// Check if a date is before another
isBefore('2023-01-01', '2023-01-02');
// Output: true

Dependencies

This package has no runtime dependencies.

Related Projects

• pearpass-app-mobile - A mobile app for PearPass, a password manager
• pearpass-app-desktop - A desktop app for PearPass, a password
• tether-dev-docs - Documentations and guides for developers

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.