Utils

Payloads

Payloads is an interface, and is not accessible at runtime. It defines all the potential codes of messages, and the type their payloads must adhere to. The types are all objects, and never contain the key "code", as it is overwritten in the passing of the message.

Here are all the payload codes with their descriptions.

payloadCodeUnion

payloadCodeUnion is a type, and is not accessible at runtime. It is simply the union of all the codes defined in payloadCodes.

const code: payloadCodeUnion = "0000"; // No errors
const notACode: payloadCodeUnion = 3; // ERROR: number is not assignable to payloadCodeUnion

UnknownObject

UnknownObject is a type, and is not accessible at runtime. Anything assignable to this type is a vanilla JS object.

const obj: UnknownObject = { foo: "bar" }; // No errors
const notAnObj: UnknownObject = [1, 2, 3]; // ERROR: Type 'number[]' is not assignable to type 'UnknownObject'.

EmptyObject

EmptyObject is a type, and is not accessible at runtime. Anything assignable to this type is an empty object.

const obj: EmptyObject = {}; // No errors
const obj: EmptyObject = { foo: "bar" }; // ERROR: type string is not assignable to never

payloadCodes

payloadCodes is an array of all the codes defined in Payloads.

isObject(obj)

• obj <unknown> The object to check.
• Returns: <boolean> Whether the obj parameter is only an object of the Object class.

isObject() checks if an object is assignable to UnknownObject. It takes one parameter, which may be of any type, and returns a boolean value that asserts whether the input is a plain JS object.

// all of these will evaluate to false
isObject([]);
isObject(3);
isObject(new SomeClass());
isObject("foo");

// all of these will evaluate to true
isObject({});
isObject({
  foo: "bar",
});