handige-tools
v4.0.0
Published
Een paar handige functies die helpen met loggen, validatie en diverse utilities
Downloads
4
Readme
Handige-tools
Een verzameling nuttige hulpmiddelen voor Node.js-projecten, inclusief een logger, data validator, en algemene utility-functies (Met gebruik van ES6).
Installatie
Installeer de package met npm:
npm install Handige-tools
Voorbeeld van gebruik
Hieronder per js funcite een voorbeeld hoe het te gebruiken is (+import):
Logger = import { Logger } from 'Handige-tools';
Logger.log('Dit is een logbericht'); Logger.info('Dit is een informatief bericht'); Logger.error('Dit is een foutmelding'); Logger.debug('Dit is een debugbericht');
Data validator = import { Validator } from 'Handige-tools';
const emailIsValid = Validator.validateEmail('[email protected]'); const passwordIsValid = Validator.validatePassword('wachtwoord123');
Utility functies = import { Utilities } from 'Handige-tools';
const formattedDate = Utilities.formatDate(new Date()); const capitalizedString = Utilities.capitalize('een string');
Bijdragen
Bijdragen aan dit project zijn welkom. Maak een issue of pull request op de GitHub-repository.
Licentie
Dit project is gelicenseerd onder de MIT-licentie - zie het {LICENTIE} bestand voor details.
Deze README geeft een duidelijk overzicht van wat de package doet, hoe deze te installeren en te gebruiken is, en biedt basisinformatie over bijdragen en de licentie. Pas de inhoud aan op basis van de exacte functionaliteiten van je package en eventuele extra instructies die je wilt toevoegen.
MAJOR PATCH: Overgang van .js naar .mjs Bestanden
Achtergrond
Dit project is gemigreerd van het gebruik van CommonJS-modules naar ES6-modules. Als onderdeel van deze overgang zijn alle JavaScript-bestanden (.js
) hernoemd naar ECMAScript-modules (.mjs
). Dit helpt bij het onderscheiden van de verschillende moduleformaten en zorgt voor compatibiliteit met de nieuwste versies van Node.js (ES6).
Waarom .mjs?
Alhoewel de package al gebruik maakte van ES6 notatie heb ik besloten om de javasciript bestaden te hernoemen naar .mjs bestanden, waarom? Nou de .mjs
extensie wordt gebruikt om expliciet aan te geven dat het bestand een ECMAScript-module bevat. Dit maakt het voor Node.js duidelijk om de juiste moduleverwerking toe te passen. Het helpt ook bij het vermijden van eventuele ambiguïteit in projecten die zowel CommonJS als ES6-modules gebruiken.
Test
Voor testing heb ik een extra 'test.mjs' bestand aangemaakt waarin alle funcitons die komen met de package worden getest.
Zelf testen
Linux / Mac: export DEBUG=true Windows: set DEBUG=true Powershell: $env:DEBUG = "true" (LET OP DAT JE IN DE PACKAGE DE FOLDER MOET ZITTEN, RECHTER MUIS KNOP OP 'handige-tools' EN DAN OPEN WITH INTERGRATED TERMINAL) daarna: node test.mjs In de terminal zie je dan het resultaat, je kan de test.mjs bestand aan passen naar voorkeur voor het testen van de functies.
server.mjs file aangemaakt voor testen van app.get (API) funcites
Nu kan je door middel (na het openen van je server met node server.mjs in de console) testen door in je browser te gaan naar de volgende links:
Voor het testen van de Utilities module: http://127.0.0.1:3000/api/test-utilities Voor het testen van de Validator module: http://127.0.0.1:3000/api/test-validator Voor het testen van de Logger module: http://127.0.0.1:3000/api/test-logger
Door middel van JSON word het resultaat getoont of voor de logger in de console gezet.