InterfaceID

Interface group and component ids, both directions.

Methods
3
Fields
None

Getting one

InterfaceID

Methods

MethodReturnsDescription
name(number)string?The name of an interface group id.
componentName(number)string?The name of a packed component id, as Group.MEMBER.
find(any)number?The id a name holds, for a name read from data: a document, a config value. Index the class for a name written in the code, which raises wh…

Method details

name

name: (number) -> string?

The name of an interface group id.

id
The group id.
Returns
nil when the id has no known name.

componentName

componentName: (number) -> string?

The name of a packed component id, as Group.MEMBER.

packedId
The packed component id.
Returns
nil when the id has no known name.

find

find: (any) -> number?

The id a name holds, for a name read from data: a document, a config value. Index the class for a name written in the code, which raises when it is misspelt.

name
A group's name (ORBS) or a component's, dotted (Orbs.UNIVERSE).
Returns
nil when the name holds no id, or is not a string. Never raises.