iPearServer

An iPearServer object is basically your FiveM server. You provide its SECRET KEY and ENDPOINT. This object is the core of the system to communicate with our services.

Example

const app = new iPearServer(options)

Available options (object)

Key	Type	Default	Description
`secretKey`	string required	/	Secret key retrieved from your iPear client area.
`endpoint`	string required	/	Endpoint URL to iPear's services.
`endpoint_version`	string	'v1'	Endpoint version to use.
`wakeList`	object	`{ ... }`	Wake list options
`wakeList.filename`	string	`wakelist.db`	Database name of the wakelist
`wakeList.printLogs`	boolean	`false`	Print in console the logs related to the wakelist management (load, save, errors...)
`logger`	object	`{ ... }`	Logger options
`logger.connectionsLogs`	boolean	`true`	Print in console the logs related to the websocket connections between your server and iPear
`logger.incomingEventsLogs`	boolean	`false`	Print in console the logs related to the incoming events sent by iPear
`logger.outgoingEventsLogs`	boolean	`false`	Print in console the logs related to the outgoing events your server sent
`logger.wakeListLogs`	boolean	`false`	Print in console the logs related to the wakelist movements (add player, remove player)
`logger.playersManagementLogs`	boolean	`false`	Print in console the logs related to the players management (create, delete, retrieve qrcode/secret code)

@ipear/server v1

iPearServer

Example

Available options (object)