TypeViewProps < Value, Type >

type TypeViewProps<Value, Type> = {
  display: string;
  forceType: boolean;
  key: PropertyKey;
  keyDelim: string;
  keyPrefix: string;
  keyStyle: HTMLAttributes<HTMLDivElement>["style"];
  length: number;
  match: boolean;
  note: {
     description: string;
     title: string;
  };
  path: PropertyKey[];
  showKey: boolean;
  showLength: boolean;
  type: Type;
  value: Value;
};

Type Parameters

Value

Value = unknown

Type

Type = ValueType

Properties

display?

display: string;

Representation of value.

Use to customize how a value is represented while still being able to pass the original value for other purposes

---

forceType?

forceType: boolean;

Force type indicator visibility for this node

---

key?

key: PropertyKey;

---

keyDelim?

keyDelim: string;

Key delimiter

---

keyPrefix?

keyPrefix: string;

Prefix for key e.g. “get” or “static”

---

keyStyle?

keyStyle: HTMLAttributes<HTMLDivElement>["style"];

Style overrides for key

---

length?

length: number;

Number of child entries / items. Also determines if expandables can be expanded (needs to be not undefined/null/zero).

---

match?

match: boolean;

The node is a search match

---

note?

note: {
  description: string;
  title: string;
};

Title / description for node note, e.g. “parsed” for parsed JSON strings

description?

description: string;

title?

title: string;

---

path?

path: PropertyKey[];

Path of the node

---

showKey?

showKey: boolean;

Should key be shown

---

showLength?

showLength: boolean;

Should the node show it’s given length / count

---

type?

type: Type;

Type of the value

---

value

value: Value;