utils/signal

Type Aliases

SignalKey

type SignalKey = string;

Defined in: utils/signal.ts:3

---

SignalCounts

type SignalCounts = Record<SignalKey, number>;

Defined in: utils/signal.ts:4

---

SignalID

type SignalID =
  | Color
  | Color;

Defined in: utils/signal.ts:5

Functions

getQualityName()

function getQualityName(quality?: any): string;

Defined in: utils/signal.ts:10

Extracts quality string name from a QualityID, LuaQualityPrototype, or plain string.

Parameters

Parameter	Type
quality?	any

Returns

string

---

isParameterName()

function isParameterName(name?: string): boolean;

Defined in: utils/signal.ts:21

Checks if the signal name is a Factorio 2.0 blueprint parameter (e.g. “parameter-0”).

Parameters

Parameter	Type
name?	string

Returns

boolean

---

getSignalTypeFromName()

function getSignalTypeFromName(name: string): any;

Defined in: utils/signal.ts:36

Resolves the SignalIDType (“item”, “fluid”, “virtual”, “quality”, etc.) from prototype registries.

Parameters

Parameter	Type
name	string

Returns

any

---

encodeSignalKey()

function encodeSignalKey(
   name: string,
   _stype?: SignalIDType,
   quality?: any): string;

Defined in: utils/signal.ts:61

Encodes signal components into a canonical string key (e.g. “iron-plate” or “iron-plate|epic”).

Parameters

Parameter	Type
name	string
_stype?	SignalIDType
quality?	any

Returns

string

---

signalToKey()

function signalToKey(signal: any): string;

Defined in: utils/signal.ts:71

Converts a SignalID into a unique string key.

Parameters

Parameter	Type
signal	any

Returns

string

---

keyToSignal()

function keyToSignal(key?: string): any;

Defined in: utils/signal.ts:90

Parses a canonical string key back into a structured SignalID.

Parameters

Parameter	Type
key?	string

Returns

any