Journalisation

Ces utilitaires écrivent dans la console (F8 sur un client, la console du serveur ou txAdmin sur le serveur). Pour les logs que le propriétaire du serveur lit dans Discord, Fivemanage ou FiveM Stats, utilisez plutôt aiLog (voir Journaux).

import { createLogger, logSafe, previewJson } from "@aicore-fivem/lib/shared";

createLoggerCopy Anchor Link

Renvoie un logger dont les lignes commencent par [your-resource], pour que la console du serveur montre d’où vient chaque ligne. Les avertissements sont en jaune, les erreurs en rouge.

Côté : client, serveur et NUI · Attend : non

createLogger(resource: string): Logger

Lua : pas d’équivalent ; utilisez print(('[%s] %s'):format(GetCurrentResourceName(), message)).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Logger :

ExempleCopy Anchor Link

import { createLogger } from "@aicore-fivem/lib/shared";

const log = createLogger(GetCurrentResourceName());

log.info("loaded 12 shops");               // [my-shop] loaded 12 shops
log.warn("shop legion has no ped model");  // jaune
try {
  JSON.parse("{");
} catch (error) {
  log.error("could not read shops.json", error); // rouge, avec l’erreur
}

logSafeCopy Anchor Link

Rend un texte envoyé par un client sûr pour la console du serveur : une seule ligne (les retours à la ligne deviennent |), aucun caractère de contrôle, aucun code couleur ^1, coupé à max caractères. Utilisez-le dès qu’une ligne de log contient un texte de joueur (un nom, un message, une note).

Côté : client, serveur et NUI · Attend : non

logSafe(text: string, max: number): string

Lua : pas d’équivalent.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

string : le texte nettoyé.

ExempleCopy Anchor Link

import { logSafe } from "@aicore-fivem/lib/shared";

logSafe("^1fake error\nsecond line", 100); // "fake error | second line"

previewJsonCopy Anchor Link

Un court texte façon JSON de n’importe quelle valeur non fiable, coupé à max caractères, construit sans sérialiser d’abord toute la valeur (une charge hostile peut peser des mégaoctets). Une imbrication de plus de 4 niveaux s’affiche [...] / {...}. Utilisez-le pour afficher ce qu’un client a envoyé quand vous le refusez.

Côté : client, serveur et NUI · Attend : non

previewJson(value: unknown, max: number): string

Lua : pas d’équivalent.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

string : l’aperçu, au plus max caractères. Les clés d’objet sont coupées à 50 caractères.

ExempleCopy Anchor Link

import { onClientEvent } from "@aicore-fivem/lib/server";
import { createLogger, logSafe, previewJson } from "@aicore-fivem/lib/shared";

const log = createLogger(GetCurrentResourceName());

onClientEvent("my-shop:rate", (source) => {
  log.info(`${logSafe(GetPlayerName(String(source)) ?? "?", 32)} opened the rating`);
});

function refuse(source: number, raw: unknown[]): void {
  log.warn(`refused input from ${source}: ${previewJson(raw, 200)}`);
}