README.md

elUtils

elUtils is a library that contains convenient, easy-to-use, and lightweight utility functions that solve many problems we face daily when building applications for Greek businesses.

Description

elUtils is a zero-dependency modern package, written in TypeScript, strongly-typed, that solves various geolocation, validation, and date-related issues by providing a broad collection of easy to use functions.

Check all the available functions here (by module category).

Installation

# npm
npm install @tsevdos/el-utils
# or yarn
yarn add @tsevdos/el-utils
# or pnpm
pnpm add @tsevdos/el-utils

Usage

To use one of the available utility functions, you just need to import it (example below):

// esm
import { getAdministrativeRegions, getDays, ... } from "@tsevdos/el-utils";
// cjs
const { getAdministrativeRegions, getDays, ... } = require("@tsevdos/el-utils");

console.log(getAdministrativeRegions());

Demo

Check all the available functions on this code sandbox.

API

The library is currently split into the following modules:

• geoUtils

  • getAdministrativeRegions()
  • getAdministrativeRegionById()
  • getAdministrativeRegionByIsoCode()
  • getAdministrativeUnits()
  • getAdministrativeUnitById()
  • getMunicipalities()
  • getCities()
  • searchCityByName()
  • getCityById()
  • getCityAdministrativeDivision()
  • getGeographicRegions()
  • getGeographicRegionById()
  • getPrefectures()
  • getPrefectureById()
  • getAllPostalCodes()
  • findByPostalCode()
  • getAllTaxOffices()
  • getTaxOfficeById()
  • getTaxOfficesByRegionId()
  • getTaxOfficesByUnitId()
  • getTaxOfficesByMunicipalityId()
  • getTaxOfficesByPostalCode()
  • searchTaxOffice()

• validationUtils

  • validatePostalCode()
  • validateAMKA()

• dateUtils

  • getDays()
  • getMonths()
  • getQuarters()
  • getEras()
  • getHolidays()

• formatUtils

  • formatWeight()

Contribute

See the Contributing guide.

If you like the project but just don't have time to contribute, that's fine. There are other easy ways to support it and show your appreciation, which we would also be very happy about:

• Star the project
• Tweet about it
• Refer this project in your project's readme
• Mention the project at local meetups and tell your friends/colleagues

License

MIT© John Tsevdos