@ragempcommunity/types-server

Remember to 🌟 this GitHub if you 💖 it.

This package contains types definitions for RAGE:MP server-side module.

📥 Installation

SERVER-SIDE

:fire: Use github:ragempcommunity/ragemp-types#types-server to latest build

# With npm
npm i --save-dev @ragempcommunity/types-server

# With yarn
yarn add -D @ragempcommunity/types-server

# With pnpm
pnpm add -D @ragempcommunity/types-server

🤓 Usage

To make these types detectable, you need to add the types property below to tsconfig.json on each side of your project.

// e.g server-side
{
	"compilerOptions": {
		"types": ["{RELATIVE_PATH_TO_NODE_MODULES}/@ragempcommunity/types-server"]
	}
}

Full type-safe and auto-complete

To extend a Mp object, there are 2 ways:

• By extending the prototype of the object:

mp.Player.prototype.myMethod = function myMethod() {
	// my method logic
};

// Usage
mp.events.add('playerReady', (player) => {
	player.myProperty = 1;

	player.myMethod();
});

// @types/index.d.ts
declare global {
	interface PlayerMp {
		myProperty: number;

		myMethod(): void;
	}
}

export {};

• By extending the object itself:

mp.events.add('playerReady', (player) => {
	player.myProperty = 1;

	player.myMethod = function myMethod() {
		// my method logic
	};
});

// @types/index.d.ts
declare global {
	interface PlayerMp {
		myProperty: number;

		myMethod(): void;
	}
}

export {};

See: RAGEMP Typescript Boilerplate

👨‍💻 Contributing

To contribute to this repository, feel free to create a new fork of the repository and submit a pull request.

• Fork / Clone and select the main branch.
• Create a new branch in your fork.
• Make your changes.
• Commit your changes and push them.
• Submit a Pull Request here!

🎉 Thanks

• CocaColaBear - Creator of types-ragemp-s & types-ragemp-c

📋 License

This project is licensed under the MIT License — see the LICENSE file for details.