# nunjucks-date-filter

> A 'date' filter for Nunjucks implementing moment.js

Latest version **0.1.1** (published 2015-07-17) · 0 weekly downloads

## Install

```sh
npm install nunjucks-date-filter
pnpm add nunjucks-date-filter
yarn add nunjucks-date-filter
bun add nunjucks-date-filter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-07-17 |
| First published | 2015-03-21 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | piwi |
| Maintainers | piwi |
| Keywords | nunjucks, filter, date, moment |

## Links

- npm: https://www.npmjs.com/package/nunjucks-date-filter
- Repository: https://github.com/piwi/nunjucks-date-filter
- Issues: https://github.com/piwi/nunjucks-date-filter/issues
- npm.io page: https://npm.io/package/nunjucks-date-filter

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.9.0

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2015-07-17
- 0.1.0 — 2015-03-21

## README

nunjucks-date-filter
====================

[![Build Status](https://travis-ci.org/piwi/nunjucks-date-filter.svg?branch=master)](https://travis-ci.org/piwi/nunjucks-date-filter)
[![Code Climate](https://codeclimate.com/github/piwi/nunjucks-date-filter/badges/gpa.svg)](https://codeclimate.com/github/piwi/nunjucks-date-filter)

This defines a `date` filter for [Nunjucks](http://mozilla.github.io/nunjucks/) 
implementing [moment.js](http://momentjs.com/), a rich date manager.


Getting Started
---------------

You may install this plugin with this command:

```shell
npm install nunjucks-date-filter --save-dev
```


Usage
-----

You must first include the filter and then add it to your *nunjucks* environment:

```js
var dateFilter = require('nunjucks-date-filter');

var env = new nunjucks.Environment();

env.addFilter('date', dateFilter);
```

A shortcut is proposed in the package:

```js
var dateFilter = require('nunjucks-date-filter');

dateFilter.install(
    [ env ]                     // by default, current nunjucks environment will be used
    [ , custom_filter_name ]    // by default, the filter will be named "date"
);
```

You can also define a default date format:

```js
var dateFilter = require('nunjucks-date-filter');

dateFilter.setDefaultFormat('YYYY');
```

Once it is installed, you can call the filter in your *nunjucks* templates:

```
// with no format
This blog has been created at {{ creation_date | date }}.

// with a custom format
This blog has been created at {{ creation_date | date("YYYY") }}.

// with an addition first
This blog has been created at {{ creation_date | date("add", 7, "days") | date }}.
```


*Momentjs* usage
----------------

The moment library proposes [a large set of date formats](http://momentjs.com/docs/#/displaying/format/)
you can use to customize the filter output. It also embeds [a huge set of methods](http://momentjs.com/docs/#/get-set/) 
to manipulate dates. Any of these methods can be called using the filter, passing as many 
arguments as needed (see example above).


Contributing
------------

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit 
tests for any new or changed functionality. Lint and test your code using [Mocha](http://mochajs.org/).

---
_Source: https://npm.io/package/nunjucks-date-filter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._