f1-23-udp - npm Package Compare versions

Comparing version 1.0.4 to 1.1.0

dist/index.d.ts

 /// <reference types="node" />
 import { EventEmitter } from 'node:stream';
-interface ParticipantData {
+export interface ParticipantData {
     m_aiControlled: number;
@@ -16,3 +16,3 @@ m_driverId: number;
 }
-interface PacketParticipantsData {
+export interface PacketParticipantsData {
     m_header: PacketHeader;
@@ -22,3 +22,3 @@ m_numActiveCars: number;
 }
-interface CarSetupData {
+export interface CarSetupData {
     m_frontWing: number;
@@ -47,7 +47,7 @@ m_rearWing: number;
 }
-interface PacketCarSetupData {
+export interface PacketCarSetupData {
     m_header: PacketHeader;
     m_carSetups: CarSetupData[];
 }
-interface CarTelemetryData {
+export interface CarTelemetryData {
     m_speed: number;
@@ -70,3 +70,3 @@ m_throttle: number;
 }
-interface PacketCarTelemetryData {
+export interface PacketCarTelemetryData {
     m_header: PacketHeader;
@@ -78,3 +78,3 @@ m_carTelemetryData: CarTelemetryData[];
 }
-interface CarStatusData {
+export interface CarStatusData {
     m_traction_control: number;
@@ -106,7 +106,7 @@ m_anti_lock_brakes: number;
 }
-interface PacketCarStatusData {
+export interface PacketCarStatusData {
     m_header: PacketHeader;
     m_car_status_data: CarStatusData[];
 }
-interface FinalClassificationData {
+export interface FinalClassificationData {
     m_position: number;
@@ -127,3 +127,3 @@ m_numLaps: number;
 }
-interface PacketFinalClassificationData {
+export interface PacketFinalClassificationData {
     m_header: PacketHeader;
@@ -133,3 +133,3 @@ m_numCars: number;
 }
-interface LobbyInfoData {
+export interface LobbyInfoData {
     m_aiControlled: number;
@@ -143,3 +143,3 @@ m_teamId: number;
 }
-interface PacketLobbyInfoData {
+export interface PacketLobbyInfoData {
     m_header: PacketHeader;
@@ -149,3 +149,3 @@ m_numPlayers: number;
 }
-interface CarDamageData {
+export interface CarDamageData {
     m_tyres_wear: number[];
@@ -173,7 +173,7 @@ m_tyres_damage: number[];
 }
-interface PacketCarDamageData {
+export interface PacketCarDamageData {
     m_header: PacketHeader;
     m_car_damage_data: CarDamageData[];
 }
-interface LapHistoryData {
+export interface LapHistoryData {
     m_lapTimeInMS: number;
@@ -188,3 +188,3 @@ m_sector1TimeInMS: number;
 }
-interface TyreStintHistoryData {
+export interface TyreStintHistoryData {
     m_endLap: number;
@@ -194,3 +194,3 @@ m_tyreActualCompound: number;
 }
-interface PacketSessionHistoryData {
+export interface PacketSessionHistoryData {
     m_header: PacketHeader;
@@ -207,3 +207,3 @@ m_carIdx: number;
 }
-interface TyreSetData {
+export interface TyreSetData {
     m_actualTyreCompound: number;
@@ -219,3 +219,3 @@ m_visualTyreCompound: number;
 }
-interface PacketTyreSetsData {
+export interface PacketTyreSetsData {
     m_header: PacketHeader;
@@ -226,3 +226,3 @@ m_carIdx: number;
 }
-interface PacketMotionExData {
+export interface PacketMotionExData {
     m_header: PacketHeader;
@@ -250,20 +250,20 @@ m_suspensionPosition: number[];
 }
-interface Options {
+export interface Options {
     port?: number;
     address?: string;
 }
-interface FastestLapData {
+export interface FastestLapData {
     vehicleIdx: number;
     lapTime: number;
 }
-interface RetirementData {
+export interface RetirementData {
     vehicleIdx: number;
 }
-interface TeamMateInPitsData {
+export interface TeamMateInPitsData {
     vehicleIdx: number;
 }
-interface RaceWinnerData {
+export interface RaceWinnerData {
     vehicleIdx: number;
 }
-interface PenaltyData {
+export interface PenaltyData {
     penaltyType: number;
@@ -277,3 +277,3 @@ infringementType: number;
 }
-interface SpeedTrapData {
+export interface SpeedTrapData {
     vehicleIdx: number;
@@ -286,23 +286,23 @@ speed: number;
 }
-interface StartLightsData {
+export interface StartLightsData {
     numLights: number;
 }
-interface DriveThroughPenaltyServedData {
+export interface DriveThroughPenaltyServedData {
     vehicleIdx: number;
 }
-interface StopGoPenaltyServedData {
+export interface StopGoPenaltyServedData {
     vehicleIdx: number;
 }
-interface FlashbackData {
+export interface FlashbackData {
     flashbackFrameIdentifier: number;
     flashbackSessionTime: number;
 }
-interface ButtonsData {
+export interface ButtonsData {
     buttonStatus: number;
 }
-interface OvertakeData {
+export interface OvertakeData {
     overtakingVehicleIdx: number;
     beingOvertakenVehicleIdx: number;
 }
-interface PacketEventData {
+export interface PacketEventData {
     m_header: PacketHeader;
@@ -312,3 +312,3 @@ m_eventStringCode: string;
 }
-interface PacketHeader {
+export interface PacketHeader {
     packet_format: number;
@@ -327,3 +327,3 @@ game_year: number;
 }
-interface CarMotionData {
+export interface CarMotionData {
     m_worldPositionX: number;
@@ -348,11 +348,11 @@ m_worldPositionY: number;
 }
-interface PacketMotionData {
+export interface PacketMotionData {
     m_header: PacketHeader;
     m_carMotionData: CarMotionData[];
 }
-interface MarshalZone {
+export interface MarshalZone {
     m_zoneStart: number;
     m_zoneFlag: number;
 }
-interface WeatherForecastSample {
+export interface WeatherForecastSample {
     m_sessionType: number;
@@ -367,3 +367,3 @@ m_timeOffset: number;
 }
-interface PacketSessionData {
+export interface PacketSessionData {
     m_header: PacketHeader;
@@ -420,3 +420,3 @@ m_weather: number;
 }
-interface LapData {
+export interface LapData {
     m_lastLapTimeInMS: number;
@@ -452,3 +452,3 @@ m_currentLapTimeInMS: number;
 }
-interface PacketLapData {
+export interface PacketLapData {
     m_header: PacketHeader;
@@ -483,2 +483,1 @@ m_lapData: LapData[];
 }
-export {};

package.json

 {
   "name": "f1-23-udp",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "F1 2021 UDP Telemetry parser for Node.js and TypeScript with type definitions",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -8,2 +8,23 @@ # F1 23 UDP
 
+## how to use?
+
+```js
+
+import { F123UDP } from "f1-23-udp";
+/*
+*   'port' is optional, defaults to 20777
+*   'address' is optional, defaults to localhost, in certain cases you may need to set address explicitly
+*/
+
+const f123: F123UDP = new F123UDP();
+f123.start();
+// motion 0
+f123.on('motion',function(data) {
+    console.log(data);
+})
+
+
+```
+
+
 ![](cover.jpg)	
@@ -10,0 +31,0 @@

tsconfig.json

@@ -0,0 +0,0 @@ {

No alert changes

Improved metrics

Number of lines in readme file

1575

increased by1.35%

Worsened metrics

Total package byte prevSize

322468

decreased by-0.8%

Lines of code

3506

decreased by-0.03%

No dependency changes