Class ColorJSON

Constructors

constructor

new ColorJSON(): ColorJSON
Returns ColorJSON

Properties

BooleanColor

BooleanColor: string | ChatColor

ClassColor

ClassColor: string | ChatColor

ClassStyle

ClassStyle: string | ChatColor

CloseArray

CloseArray: string

CloseObject

CloseObject: string

Comma

Comma: string

CycleColor

CycleColor: string | ChatColor

CycleValue

CycleValue: string

EscapeColor

EscapeColor: string | ChatColor

FalseValue

FalseValue: string

FunctionColor

FunctionColor: string | ChatColor

FunctionValue

FunctionValue: string

IncludeClassNames

IncludeClassNames: boolean

Indent

Indent: string

InlineThreshold

InlineThreshold: number

KeyColor

KeyColor: string | ChatColor

KeyDelimiter

KeyDelimiter: string

KeyValueSeparator

KeyValueSeparator: string

MaxDepth

MaxDepth: number

NewLine

NewLine: string

NullColor

NullColor: string | ChatColor

NullValue

NullValue: string

NumberColor

NumberColor: string | ChatColor

OpenArray

OpenArray: string

OpenCloseArrayColor

OpenCloseArrayColor: string | ChatColor

OpenCloseObjectColor

OpenCloseObjectColor: string | ChatColor

OpenObject

OpenObject: string

Space

Space: string

StringColor

StringColor: string | ChatColor

StringDelimiter

StringDelimiter: string

TrueValue

TrueValue: string

TruncatedObjectValue

TruncatedObjectValue: string

UndefinedValue

UndefinedValue: string

`Static` `Readonly`DEFAULT

DEFAULT: ColorJSON

The default ColorJSON instance

`Static` `Readonly`PLAIN

PLAIN: ColorJSON

A ColorJSON instance that does not colorize anything.

Methods

`Protected`escapeString

escapeString(str: string): string
Escapes a string for JSON.
Parameters
- str: string
  The string to escape.
Returns string
- Defined in index.d.ts:1232

`Protected`shouldTruncateObject

shouldTruncateObject(value: object, className: string, ctx: Context): boolean
Parameters
- value: object
- className: string
- ctx: Context
Returns boolean
- Defined in index.d.ts:1221

stringify

stringify(value: unknown): string
Transforms a value into a chat-friendly, colored JSON representation.
Parameters
- value: unknown
  The value to transform.
Returns string
- Defined in index.d.ts:1167

`Protected`stringifyArray

stringifyArray(value: unknown[], ctx: Context): string
Transforms an array into a JSON representation.
Parameters
- value: unknown[]
  The array to transform.
- ctx: Context
Returns string
- Defined in index.d.ts:1205

`Protected`stringifyBoolean

stringifyBoolean(value: boolean): string
Transforms a boolean into a JSON representation.
Parameters
- value: boolean
  The boolean to transform.
Returns string
- Defined in index.d.ts:1182

`Protected`stringifyCycle

stringifyCycle(): string
Returns a cycle JSON representation.

Returns string
- Defined in index.d.ts:1199

`Protected`stringifyFunction

stringifyFunction(value: Function): string
Transforms a function into a JSON representation.
Parameters
- value: Function
  The function to transform.
Returns string
- Defined in index.d.ts:1187

`Protected`stringifyNull

stringifyNull(): string
Returns a null JSON representation.

Returns string
- Defined in index.d.ts:1191

`Protected`stringifyNumber

stringifyNumber(value: number): string
Transforms a number into a JSON representation.
Parameters
- value: number
  The number to transform.
Returns string
- Defined in index.d.ts:1177

`Protected`stringifyObject

stringifyObject(
    value: object,
    className: string,
    entries: any[][],
    ctx: Context,
): string
Transforms an object into a JSON representation.
Parameters
- value: object
  The object to transform.
- className: string
  Class Name of the object.
- entries: any[][]
  Entries of the object to transform.
- ctx: Context
Returns string
- Defined in index.d.ts:1220

`Protected`stringifyString

stringifyString(value: string): string
Transforms a string into a JSON representation.
Parameters
- value: string
  The string to transform.
Returns string
- Defined in index.d.ts:1172

`Protected`stringifyTruncatedObject

stringifyTruncatedObject(value: object, className: string, ctx: Context): string
Transforms an object into a truncated JSON representation.
Parameters
- value: object
  The object to transform.
- className: string
  Class Name of the object.
- ctx: Context
Returns string
- Defined in index.d.ts:1212

`Protected`stringifyUndefined

stringifyUndefined(): string
Returns an undefined JSON representation.

Returns string
- Defined in index.d.ts:1195

`Protected`stringifyValue

stringifyValue(value: unknown, ctx: Context): string
Transforms a value of any type into a JSON representation. This function is not meant to be overridden.
Parameters
- value: unknown
  The value to transform.
- ctx: Context
Returns string
- Defined in index.d.ts:1227

Class ColorJSON

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ColorJSON

Properties

BooleanColor

ClassColor

ClassStyle

CloseArray

CloseObject

Comma

CycleColor

CycleValue

EscapeColor

FalseValue

FunctionColor

FunctionValue

IncludeClassNames

Indent

InlineThreshold

KeyColor

KeyDelimiter

KeyValueSeparator

MaxDepth

NewLine

NullColor

NullValue

NumberColor

OpenArray

OpenCloseArrayColor

OpenCloseObjectColor

OpenObject

Space

StringColor

StringDelimiter

TrueValue

TruncatedObjectValue

UndefinedValue

Static ReadonlyDEFAULT

Static ReadonlyPLAIN

Methods

ProtectedescapeString

Parameters

Returns string

ProtectedshouldTruncateObject

Parameters

Returns boolean

stringify

Parameters

Returns string

ProtectedstringifyArray

Parameters

Returns string

ProtectedstringifyBoolean

Parameters

Returns string

ProtectedstringifyCycle

Returns string

ProtectedstringifyFunction

Parameters

Returns string

ProtectedstringifyNull

Returns string

ProtectedstringifyNumber

Parameters

Returns string

ProtectedstringifyObject

Parameters

Returns string

ProtectedstringifyString

Parameters

Returns string

ProtectedstringifyTruncatedObject

Parameters

Returns string

ProtectedstringifyUndefined

`Static` `Readonly`DEFAULT

`Static` `Readonly`PLAIN

`Protected`escapeString

`Protected`shouldTruncateObject

`Protected`stringifyArray

`Protected`stringifyBoolean

`Protected`stringifyCycle

`Protected`stringifyFunction

`Protected`stringifyNull

`Protected`stringifyNumber

`Protected`stringifyObject

`Protected`stringifyString

`Protected`stringifyTruncatedObject

`Protected`stringifyUndefined

`Protected`stringifyValue