Partager via


InspectContext interface

Extends

Required<InspectOptions>

Propriétés héritées

breakLength

Longueur à laquelle les valeurs d’entrée sont fractionnées sur plusieurs lignes. Défini sur Infinity pour mettre en forme l’entrée en tant que ligne unique (en combinaison avec compact définie sur true ou n’importe quel nombre >= 1).

colors

Si true, la sortie est styleée avec des codes de couleur ANSI. Les couleurs sont personnalisables.

compact

Si vous définissez cette valeur sur false, chaque clé d’objet s’affiche sur une nouvelle ligne. Il ajoute également de nouvelles lignes au texte plus long que breakLength. Si la valeur est définie sur un nombre, les éléments internes les plus n sont unis sur une seule ligne tant que toutes les propriétés s’inscrivent dans breakLength. Les éléments de tableau courts sont également regroupés. Notez qu’aucun texte ne sera réduit en dessous de 16 caractères, quelle que soit la taille breakLength. Pour plus d’informations, consultez l’exemple ci-dessous.

customInspect

Si false, les fonctions [util.inspect.custom](depth, opts, inspect) ne sont pas appelées.

depth

Spécifie le nombre de fois à récurser pendant la mise en forme de l’objet. Cela est utile pour inspecter des objets volumineux. Pour récurser jusqu’à la taille maximale de la pile des appels passe Infinity ou null.

getters

Si la valeur est true, les getters vont également être inspectés. Si la valeur est définie sur 'get' uniquement les getters sans setter seront inspectés. Si la valeur est définie sur 'set' seuls les getter ayant un setter correspondant seront inspectés. Cela peut entraîner des effets secondaires en fonction de la fonction getter.

maxArrayLength

Spécifie le nombre maximal d’éléments Array, TypedArray, WeakMapet WeakSet à inclure lors de la mise en forme. Définissez la valeur null ou Infinity pour afficher tous les éléments. Définissez la valeur 0 ou négative pour afficher aucun élément.

maxStringLength

Spécifie le nombre maximal de caractères à inclure lors de la mise en forme. Définissez la valeur null ou Infinity pour afficher tous les éléments. Définissez la valeur 0 ou négative pour ne pas afficher de caractères.

numericSeparator

Si la valeur est true, un trait de soulignement est utilisé pour séparer tous les trois chiffres de tous les bigints et nombres.

showHidden

Si true, les symboles et propriétés non énumérables de l’objet sont inclus dans le résultat mis en forme. WeakMap et les entrées WeakSet sont également incluses, ainsi que les propriétés de prototype définies par l’utilisateur (à l’exception des propriétés de méthode).

showProxy

Si true, Proxy inspection inclut les objets cible et gestionnaire.

sorted

Si la valeur est true ou une fonction, toutes les propriétés d’un objet et Set et les entrées Map sont triées dans la chaîne résultante. Si la valeur est définie sur true le tri par défaut est utilisé. Si elle est définie sur une fonction, elle est utilisée comme fonction de comparaison.

Méthodes

stylize(string, InspectStyle)

Détails de la propriété héritée

breakLength

Longueur à laquelle les valeurs d’entrée sont fractionnées sur plusieurs lignes. Défini sur Infinity pour mettre en forme l’entrée en tant que ligne unique (en combinaison avec compact définie sur true ou n’importe quel nombre >= 1).

breakLength: number

Valeur de propriété

number

Hérité de Required.breakLength

colors

Si true, la sortie est styleée avec des codes de couleur ANSI. Les couleurs sont personnalisables.

colors: boolean

Valeur de propriété

boolean

Hérité de Required.colors

compact

Si vous définissez cette valeur sur false, chaque clé d’objet s’affiche sur une nouvelle ligne. Il ajoute également de nouvelles lignes au texte plus long que breakLength. Si la valeur est définie sur un nombre, les éléments internes les plus n sont unis sur une seule ligne tant que toutes les propriétés s’inscrivent dans breakLength. Les éléments de tableau courts sont également regroupés. Notez qu’aucun texte ne sera réduit en dessous de 16 caractères, quelle que soit la taille breakLength. Pour plus d’informations, consultez l’exemple ci-dessous.

compact: number | boolean

Valeur de propriété

number | boolean

Hérité de Required.compact

customInspect

Si false, les fonctions [util.inspect.custom](depth, opts, inspect) ne sont pas appelées.

customInspect: boolean

Valeur de propriété

boolean

Hérité de Required.customInspect

depth

Spécifie le nombre de fois à récurser pendant la mise en forme de l’objet. Cela est utile pour inspecter des objets volumineux. Pour récurser jusqu’à la taille maximale de la pile des appels passe Infinity ou null.

depth: null | number

Valeur de propriété

null | number

Hérité de Required.depth

getters

Si la valeur est true, les getters vont également être inspectés. Si la valeur est définie sur 'get' uniquement les getters sans setter seront inspectés. Si la valeur est définie sur 'set' seuls les getter ayant un setter correspondant seront inspectés. Cela peut entraîner des effets secondaires en fonction de la fonction getter.

getters: boolean | "set" | "get"

Valeur de propriété

boolean | "set" | "get"

Hérité de Required.getters

maxArrayLength

Spécifie le nombre maximal d’éléments Array, TypedArray, WeakMapet WeakSet à inclure lors de la mise en forme. Définissez la valeur null ou Infinity pour afficher tous les éléments. Définissez la valeur 0 ou négative pour afficher aucun élément.

maxArrayLength: null | number

Valeur de propriété

null | number

Hérité de Required.maxArrayLength

maxStringLength

Spécifie le nombre maximal de caractères à inclure lors de la mise en forme. Définissez la valeur null ou Infinity pour afficher tous les éléments. Définissez la valeur 0 ou négative pour ne pas afficher de caractères.

maxStringLength: null | number

Valeur de propriété

null | number

Hérité de Required.maxStringLength

numericSeparator

Si la valeur est true, un trait de soulignement est utilisé pour séparer tous les trois chiffres de tous les bigints et nombres.

numericSeparator: boolean

Valeur de propriété

boolean

Hérité de Required.numericSeparator

showHidden

Si true, les symboles et propriétés non énumérables de l’objet sont inclus dans le résultat mis en forme. WeakMap et les entrées WeakSet sont également incluses, ainsi que les propriétés de prototype définies par l’utilisateur (à l’exception des propriétés de méthode).

showHidden: boolean

Valeur de propriété

boolean

Hérité de Required.showHidden

showProxy

Si true, Proxy inspection inclut les objets cible et gestionnaire.

showProxy: boolean

Valeur de propriété

boolean

Hérité de Required.showProxy

sorted

Si la valeur est true ou une fonction, toutes les propriétés d’un objet et Set et les entrées Map sont triées dans la chaîne résultante. Si la valeur est définie sur true le tri par défaut est utilisé. Si elle est définie sur une fonction, elle est utilisée comme fonction de comparaison.

sorted: boolean | (a: string, b: string) => number

Valeur de propriété

boolean | (a: string, b: string) => number

Hérité de Required.trid

Détails de la méthode

stylize(string, InspectStyle)

function stylize(text: string, styleType: InspectStyle): string

Paramètres

text

string

styleType
InspectStyle

Retours

string