ngx-date-fns

v11.0.0

[![Build Status](https://travis-ci.org/joanllenas/ngx-date-fns.png?branch=master)](https://travis-ci.org/joanllenas/ngx-date-fns) [![codecov](https://codecov.io/gh/joanllenas/ngx-date-fns/branch/master/graph/badge.svg)](https://codecov.io/gh/joanllenas/ng For more information about how to use this package see README

Latest version published 5 months ago

License: Unknown

NPM

GitHub

Package Health Score

59 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
11.0.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.0.1	\|	11/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.0.0	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.3.0	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.2.0	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unknown

Unable to detect license

We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (4,134)

GitHub Stars: 162
Forks: 14
Contributors: 9

Direct Usage Popularity

The npm package ngx-date-fns receives a total of 4,134 downloads a week. As such, we scored ngx-date-fns popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package ngx-date-fns, we found that it has been starred 162 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like ngx-date-fns is missing a Code of Conduct.

How about a good first contribution to this project? It seems that ngx-date-fns is missing a LICENSE file.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 1
Open PR: 4
Last Release: 5 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of ngx-date-fns based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that ngx-date-fns demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 1 Direct
Versions: 60
Install Size: 1.57 MB
Dist-tags: 2
# of Files: 362
Maintainers: 1
TS Typings: Yes

ngx-date-fns has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

+ = ngx-date-fns

date-fns pipes for Angular applications.

Requirememnts

The latest version of this library requires:

date-fns >= v3.0.0.
Angular >= v17.0.0.

Installation

npm install --save date-fns
npm install --save ngx-date-fns

Installation for date-fns v2

npm install --save date-fns@2.30.0

npm install --save ngx-date-fns@10.0.1

ngx-date-fns@10.0.1 docs

> ⚠️ There's a range of date-fns versions for which tree shaking is broken, so we recommend that you either install v2.16.1 or >= v2.21.1.

Installation for date-fns v1

npm install --save date-fns@1.29.0

npm install --save ngx-date-fns@4.0.3

ngx-date-fns@4.0.3 docs

Basic Usage

> stackblitz example

import { CommonModule } from '@angular/common';
import { Component } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';
import 'zone.js';
import { es } from 'date-fns/locale';
import { DateFnsModule } from 'ngx-date-fns';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [CommonModule, DateFnsModule],
  template: `
    <p>{{ dateOne | dfnsFormat: 'MM/dd/yyyy' }}</p>
    <p>{{ [dateOne, dateTwo] | dfnsMin | dfnsFormat: 'EEE LLLL d yyyy' }}</p>
    <p>
      {{ [dateOne, dateTwo] | dfnsMax | dfnsFormat: 'EEE LLLL d yyyy' }}
    </p>
    <p>
      {{ dateThree | dfnsFormatDistanceToNow: options }} - (Explicit 'es'
      locale)
    </p>
    <p>{{ 0 | dfnsWeekdayName: 'full':options }} - (Explicit 'es' locale)</p>
    <p>
      {{
        '12 de Marzo'
          | dfnsParse: parseFormat:parseDate:parseLocale
          | dfnsFormat: 'MM/dd/yyyy'
      }}
    </p>
  `
})
export class App {
  dateOne = new Date(2016, 0, 1);
  dateTwo = new Date(2017, 0, 1);
  dateThree: Date;
  options = {
    locale: es,
    addSuffix: true
  };
  parseDate = new Date(2010, 0, 1);
  parseFormat = `do 'de' MMMM`;
  parseLocale = { locale: es };

  constructor() {
    this.dateThree = new Date();
    this.dateThree.setDate(this.dateThree.getDate() - 6);
  }
}

bootstrapApplication(App);

The output:

01/01/2016
Fri January 1 2016
Sun January 1 2017
hace 6 días - (Explicit 'es' locale)
lunes - (Explicit 'es' locale)
03/12/2010

Working with locales

> All locale-aware pipes use English by default.

Changing locale globally

Instead of passing the locale to each pipe via options you can set it globally in one single step by overriding the default DateFnsConfiguration implementation:

> stackblitz example

// app.config.ts
import { ApplicationConfig } from '@angular/core';
import { DateFnsConfigurationService } from 'ngx-date-fns';
import { fr } from 'date-fns/locale';

const frenchConfig = new DateFnsConfigurationService();
frenchConfig.setLocale(fr);

export const appConfig: ApplicationConfig = {
  providers: [{ provide: DateFnsConfigurationService, useValue: frenchConfig }]
};

// main.ts
import { CommonModule } from '@angular/common';
import { Component } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';
import 'zone.js';
import { es } from 'date-fns/locale';
import { DateFnsModule } from 'ngx-date-fns';
import { appConfig } from './app.config';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [CommonModule, DateFnsModule],
  template: `
    (...)
  `
})
export class App {
  // (...)
}

bootstrapApplication(App, appConfig).catch(err =&gt; console.error(err));

Changing locale at runtime

It is also possible to change the default locale at runtime:

> stackblitz example

import { CommonModule } from '@angular/common';
import { Component } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';
import 'zone.js';
import { es, de } from 'date-fns/locale';
import { DateFnsConfigurationService, DateFnsModule } from 'ngx-date-fns';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [CommonModule, DateFnsModule],
  template: `
    <p>{{ dateOne | dfnsFormat: 'EEE LLLL d yyyy' }}</p>
    <hr>
    Set default locale to: </a><a href="#">German</a>,
    <a href="#">Spanish</a>.
  `
})
export class App {
  dateOne = new Date(2016, 0, 1);
  constructor(public config: DateFnsConfigurationService) {}
  changeToGerman() {
    this.config.setLocale(de);
  }
  changeToSpanish() {
    this.config.setLocale(es);
  }
}

bootstrapApplication(App);

Pure or impure?

Should I use the pure or impure version of the locale-aware pipes?

The answer is quite simple:

Do you set the locale only once when the application starts?
- Use only pure pipes.
Do you need to change the locale at runtime?
- Use impure pipes.

The main difference is that pure pipes do not get notified when the locale is changed via DateFnsConfiguration.setLocale(locale: Locale), because the instance is not kept in memory. Impure pipes, on the other hand, are kept in memory and listen for Locale change notifications, which adds some memory and performance overhead.

Available pipes

> All pipes are pure unless stated otherwise.

Misc

Format

> Since v7.0.0 invalid Dates will return an empty string instead of throwing an exception.

Get

Difference

Add

Subtract

End

Start

Last Day Of

Is...?

Utils

A collection of utilities built around date-fns functions.

dfnsFormatRelativeToNow

> This pipe is (impure), but there's the pure version dfnsFormatRelativeToNowPure too.

Same as dfnsFormatRelative but the date to comapre against is always Date.now().

dfnsWeekdayName

> This pipe is (impure)

Given a weekday number, returns its name.

@param `WeekdayNameFormat`

Optional weekday format. Allowed values are:

x1: One char. 'M' for Monday.
x2: Two chars. 'Mo' for Monday.
x3: Three chars. 'Mon' for Monday.
full: Full weekday name. 'Monday' for Monday.

Defaults to full.

@param `Locale`

Optional date-fns Locale object.

Optional locale object.

Basic example

<div>
  
  {{ 0 | dfnsWeekdayName }}
</div>
<div>
  
  {{ 0 | dfnsWeekdayName : 'x3' }}
</div>
```</a>

ngx-date-fns dependencies

tslib

FAQs

What is ngx-date-fns?

[![Build Status](https://travis-ci.org/joanllenas/ngx-date-fns.png?branch=master)](https://travis-ci.org/joanllenas/ngx... Visit Snyk Advisor to see a full health score report for ngx-date-fns, including popularity, security, maintenance & community analysis.

Is ngx-date-fns popular?

The npm package ngx-date-fns receives a total of 4,134 weekly downloads. As such, ngx-date-fns popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ngx-date-fns well maintained?

We found indications that ngx-date-fns maintenance is sustainable demonstrating some project activity. We saw a total of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is ngx-date-fns safe to use?

While scanning the latest version of ngx-date-fns, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 8 May-2024, at 02:23 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,134)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

+ = ngx-date-fns

Table Of Contents

Requirememnts

Installation

Installation for date-fns v2

Installation for date-fns v1

Basic Usage

Working with locales

Changing locale globally

Changing locale at runtime

Pure or impure?

Available pipes

Misc

Format

Get

Difference

Add

Subtract

End

Start

Last Day Of

Is...?

Utils

dfnsFormatRelativeToNow

dfnsWeekdayName

@param WeekdayNameFormat

@param Locale

Basic example

ngx-date-fns dependencies

FAQs

What is ngx-date-fns?

Is ngx-date-fns popular?

Is ngx-date-fns well maintained?

Is ngx-date-fns safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

@param `WeekdayNameFormat`

@param `Locale`