From 3b56c5e4a4b3d1bd2fd0677ae58b475498c2a742 Mon Sep 17 00:00:00 2001 From: arpadlomenipg Date: Wed, 27 Mar 2024 14:17:20 +0100 Subject: [PATCH] fixed readme after infofile validator PR (ONLY readme changes) --- README.md | 104 +++++++++++++++++++++++++++--------------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 2ab3638..7204a06 100644 --- a/README.md +++ b/README.md @@ -260,58 +260,6 @@ console.log(status) -### Validate whether a files is indeed an infofile: - -
-isValidInfoFile -Returns a boolean value to show whether the file is a valid infofile or not. - -### Check whether a file is an infofile - -``` -// import the library -const infofile = require("@ipguk/infofile-utils"); - -// get the absolute path to the infofile -const file = "C:\infofiles\infofile"; - -// call the function. The property "type" is an optional property. -// If no type is specified, any valid infofile will be taken as valid. However, files which are not infofiles still be regarded as invalid! -// List of values for type: -// "Vehicle" (for cars, motorcycles and trucks) -// "Car" (for Car infofiles) -// "Motorcycle" (for Motorcycle infofiles) -// "Truck" (for Truck infofiles) -// "TestRun" (for test runs) -// "Road" (for road infofiles) -// "Trailer" (for Trailer infofiles) -// "Tire" (for Tire infofiles) -// "Driver" (for Driver infofiles) -// "TrafficBehavior" (for TrafficBehavior infofiles) -// "TrafficDriver" (for TrafficDriver infofiles) -// "TrafficTemplate" (for TrafficTemplate, e. g. vehicles, pedestrians, buildings, etc. infofiles) -// "SavedSelections" (for SavedSelections infofiles) -// "UserDriver" (for UserDriver infofiles) -// "SuspensionKinematics-skc" (for Suspension Kinematics infofiles with a .skc file extension) -// "SuspensionKinematics-mbs" (for Suspension Kinematics infofiles with a .mbs file extension) -// "ADTF" (for ADTF infofifles) -// "DataDict" (for DataDict infofiles) -// "GPUConfig" (for GPUConfig infofiles) -// "PTBattery-BattECM" (for PTBattery-BattECM infofiles) -// "AirBrake" (for AirBrake infofiles) -// "HydESP" (for HydESP infofiles) -// "HydIPB" (for HydIPB infofiles) -// "Suspension" (for various Suspension infofiles) -// "SuspensionControl" (for various SuspensionControl infofiles) -const validationWithoutType = isValidInfoFile({ file: file }); -const validationWithType = isValidInfoFile({ file: file, type: "Vehicle" }); - -// console.log the status, returns true if valid, false if not -console.log(validationWithType) -``` - -
-
setValue A universal function to set values to an infofile. @@ -480,6 +428,58 @@ console.log(status)
+### Validate whether a file is indeed an infofile: + +
+isValidInfoFile +Returns a boolean value to show whether the file is a valid infofile or not. + +### Check whether a file is an infofile + +``` +// import the library +const infofile = require("@ipguk/infofile-utils"); + +// get the absolute path to the infofile +const file = "C:\infofiles\infofile"; + +// call the function. The property "type" is an optional property. +// If no type is specified, any valid infofile will be taken as valid. However, files which are not infofiles still be regarded as invalid! +// List of values for type: +// "Vehicle" (for cars, motorcycles and trucks) +// "Car" (for Car infofiles) +// "Motorcycle" (for Motorcycle infofiles) +// "Truck" (for Truck infofiles) +// "TestRun" (for test runs) +// "Road" (for road infofiles) +// "Trailer" (for Trailer infofiles) +// "Tire" (for Tire infofiles) +// "Driver" (for Driver infofiles) +// "TrafficBehavior" (for TrafficBehavior infofiles) +// "TrafficDriver" (for TrafficDriver infofiles) +// "TrafficTemplate" (for TrafficTemplate, e. g. vehicles, pedestrians, buildings, etc. infofiles) +// "SavedSelections" (for SavedSelections infofiles) +// "UserDriver" (for UserDriver infofiles) +// "SuspensionKinematics-skc" (for Suspension Kinematics infofiles with a .skc file extension) +// "SuspensionKinematics-mbs" (for Suspension Kinematics infofiles with a .mbs file extension) +// "ADTF" (for ADTF infofifles) +// "DataDict" (for DataDict infofiles) +// "GPUConfig" (for GPUConfig infofiles) +// "PTBattery-BattECM" (for PTBattery-BattECM infofiles) +// "AirBrake" (for AirBrake infofiles) +// "HydESP" (for HydESP infofiles) +// "HydIPB" (for HydIPB infofiles) +// "Suspension" (for various Suspension infofiles) +// "SuspensionControl" (for various SuspensionControl infofiles) +const validationWithoutType = isValidInfoFile({ file: file }); +const validationWithType = isValidInfoFile({ file: file, type: "Vehicle" }); + +// console.log the status, returns true if valid, false if not +console.log(validationWithType) +``` + +
+ ### Other functions