@elloha-npm/elloha-utils

Le module fournit une collection de fonctions d'aide pour travailler sur les projets web ts elloha.

Installation

npm install @elloha-npm/elloha-utils

Fonctions

Voici une liste des fonctions disponibles dans ce module :

dateFormat

dateFormat(date: Date): string

Cette fonction prend une date JavaScript et la retourne formatée en dd-mm-yyyy.

isDateSqlMaxValue

isDateSqlMaxValue(date: Date | string): boolean

Cette fonction vérifie si une date donnée est égale à la valeur de date maximale en SQL (9999-12-31T23:59:59).

getDateFormatByLanguageCode

getDateFormatByLanguageCode(
  code: string,
  dateFormats: { [key: string]: string }
): string

Cette fonction renvoie le format de date correspondant à un code de langue donné. Si aucun format n'est trouvé pour le code de langue, le format par défaut en est utilisé.

getDateFormatWithNameByLanguageCode

getDateFormatWithNameByLanguageCode(
  code: string,
  dateNameFormats: { [key: string]: string },
  dateFormats: { [key: string]: string }
): string

Cette fonction fonctionne de manière similaire à getDateFormatByLanguageCode, mais utilise également un objet dateNameFormats.

getRelativeDate

getRelativeDate(
  date: string,
  i18n: 'en-GB' | 'fr-FR',
  dateNameFormats: { [key: string]: string },
  dateFormats: { [key: string]: string }
): string

Cette fonction renvoie une chaîne décrivant si la date donnée est "Aujourd'hui", "Hier", "Avant-hier" ou la date elle-même si elle n'est ni d'hier, ni avant-hier.

getHourAndMinutes

getHourAndMinutes(date: Date): string

Cette fonction prend une date JavaScript et la retourne formatée en HH:mm.

getDateRangeResume

getDateRangeResume (
  dateFrom: string | Date | null | undefined,
  dateTo: string | Date | null | undefined,
  i18n: string,
  tr: (key: string) => string,
  dateFormats: { [key: string]: string },
  permanentPrefixText?: string,
  permanentText?: string,
  textFrom?: string,
  textTo?: string,
  textUntil?: string
): string

Cette fonction prend une plage de dates et renvoie une chaîne qui décrit cette plage de dates dans une langue spécifique. Elle est également capable de gérer les plages de dates permanentes (date de fin >= 2100).

Utilisation

Voici comment vous pouvez utiliser ces fonctions dans votre code:

import {
  dateFormat,
  isDateSqlMaxValue,
  getDateFormatByLanguageCode,
  getRelativeDate,
  getHourAndMinutes,
  getDateRangeResume,
  getDateFormatWithNameByLanguageCode,
} from 'your-package-name';

const date = new Date();
console.log(dateFormat(date)); // "01-01-2020"
console.log(isDateSqlMaxValue(date)); // false

const dateFormats = { en: 'MM/DD/YYYY', fr: 'DD/MM/YYYY' };
console.log(getDateFormatByLanguageCode('fr', dateFormats)); // "DD/MM/YYYY"

const i18n = 'fr-FR';
console.log(getRelativeDate(dateFormat(date), i18n, dateFormats, dateFormats)); // "Aujourd'hui"

console.log(getHourAndMinutes(date)); // "12:00"