Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/numax-cz/napicudateformatter
Package for formatting Date & Time
https://github.com/numax-cz/napicudateformatter
date date-format date-formatter date-formatting formatter napicuweb time typescript
Last synced: 9 days ago
JSON representation
Package for formatting Date & Time
- Host: GitHub
- URL: https://github.com/numax-cz/napicudateformatter
- Owner: Numax-cz
- License: mit
- Created: 2022-04-12T14:02:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-22T15:48:43.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T04:08:22.931Z (29 days ago)
- Topics: date, date-format, date-formatter, date-formatting, formatter, napicuweb, time, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/napicuformatter
- Size: 59.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NapicuDateFormatter
- NapicuDateFormatter is a simple date & time formatter for easy processing of date and time
# Variables for formating
Name
Code
Description
Year
%yyyy
Returns the current year in number
Month
%MM
Returns the current month in number
Month name
%MMN
Returns the current month name - short
Month name - short
%MN
Returns the current month name
Day
%dd
Returns the day of the week, using local time
MaxDays
%DMAX
Returns the maximum number of days in current month
Date
%dt
Returns the day-of-the-month, using local time
Day name
%ddn
Returns the current day name
Day name - short
%dn
Returns the current day name - short
24H
%HH
Returns the current hour in 24H format
12H
%hh
Returns the current hour in 12H format
Minutes
%mm
Returns the current minutes in number
Seconds
%ss
Returns the current seconds
Meridian
%a
Returns the current meridian
Time zone
%z
Returns the time zone
# Example
### Importing
```typescript
import { NapicuDate } from 'napicuformatter';
```
```javascript
const NapicuDate = require('napicuformatter');
```
### Formatting
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate().format('%yyyy-%MM-%dt %HH:%mm:%ss');
console.log(i); // 2022-4-12 16:59:30
```
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate().format('Time: %HH:%mm:%ss');
console.log(i); // Time: 16:59:30
```
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate().format('Date: %MMN');
console.log(i); // Date: April
```
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate().format('Day: %ddn');
console.log(i); // Day: Thursday
```
### Custom Date
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate(2023, 9, 9, 23, 23, 23, 1000).format('%yyyy-%MM-%dt %HH:%mm:%ss');
console.log(i); //2023-9-9 23:23:24
```
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate(1547778643657).format('%yyyy-%MM-%dt %HH:%mm:%ss');
console.log(i); //2019-1-18 3:30:43
```
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate(2016, 6, 6).format('%yyyy-%MM-%dt %HH:%mm:%ss');
console.log(i); //2019-1-18 3:30:43
```
### Getting
```typescript
import { NapicuDate } from 'napicuformatter';
let i = new NapicuDate();
i.getLanguageDays(); // Returns the days of the week in the config language
i.getLanguageShortsDays(); // Returns shortened days of the week in the config language
i.getLanguageMonths(); // Returns he months of the year in the config language
i.getLanguageShortsMonths(); // Returns shortened months of the year in the config language
i.getCurrentDay(); // Returns the day of the week, using local time
i.getCurrentDate(); // Returns the day-of-the-month, using local time
i.getMaxDaysInCurrentMonth(); //Returns the maximum number of days in current month
i.getCurrentMonth(); // Returns the current month
i.getCurrentYear(); // Returns the current year
i.getCurrentSeconds(); // Returns the current seconds
i.getCurrentMinutes(); // Returns the current minutes
i.getCurrentHours(); // Returns the current hours
i.getCurrentDayName(); // Returns the current day name in the config language
i.getCurrentMonthName(); // Returns the current month name in the config language
i.getCurrentMeridian(); // Returns the current meridian (AM/PM)
i.getTimeStamp(); //Returns the time value in milliseconds
```
### Static methods
```typescript
import { NapicuDate } from 'napicuformatter';
NapicuDate.getLanguageDays(); // Returns the days of the week in the config language
NapicuDate.getLanguageMonths(); // Returns he months of the year in the config language
NapicuDate.getLanguageShortsDays(); // Returns shortened days of the week in the config language
NapicuDate.getLanguageShortsMonths(); // Returns shortened months of the year in the config language
```
### Use with config
```typescript
import { NapicuDate } from 'napicuformatter';
NapicuDate.use({
shortNameLength: 2,
});
let i = NapicuDate.getLanguageShortsDays();
console.log(i);
//[
// 'Mo', 'Tu',
// 'We', 'Th',
// 'Fr', 'Sa',
// 'Su'
//]
```
### Configuration
```typescript
import { NapicuDate } from 'napicuformatter';
NapicuDate.use({
days: [
'Monday', // 1
'Tuesday', // 2
'Wednesday', // 3
'Thursday', // 4
'Friday', // 5
'Saturday', // 6
'Sunday', // 7
],
months: [
'January', // 1
'February', // 2
'March', // 3
'April', // 4
'May', // 5
'June', // 6
'July', // 7
'August', // 8
'September', // 9
'October', // 10
'November', // 11
'December', // 12
],
shortNameLength: 3, // Short name length - default 3
});
```