Utility functions to validate bus names, interface names, and object paths.
- Source:
Methods
(static) assertBusNameValid(name)
Throws an error if the given string is not a valid bus name.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The name to validate as a bus name. |
- Source:
- See:
(static) assertInterfaceNameValid(name) → {boolean}
Throws an error if the given string is not a valid interface name.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The string to validate as an interface name. |
- Source:
- See:
Returns:
- Whether the string is a valid interface name.
- Type
- boolean
(static) assertMemberNameValid(name)
Throws an error if the string is not a valid member name.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The string to validate as a member name. |
- Source:
- See:
(static) assertObjectPathValid(path) → {boolean}
Throws an error if the given string is not a valid object path.
Parameters:
Name | Type | Description |
---|---|---|
path |
string | The string to validate as an object path. |
- Source:
- See:
Returns:
- Whether the string is a valid object path.
- Type
- boolean
(static) isBusNameValid(name) → {boolean}
Validate the string as a valid bus name.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The name to validate as a valid bus name. |
- Source:
- See:
Returns:
- Whether the string is a valid bus name.
- Type
- boolean
(static) isInterfaceNameValid(name) → {boolean}
Validate the string as a valid interface name. see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The string to validate as an interface name. |
- Source:
Returns:
- Whether the string is a valid interface name.
- Type
- boolean
(static) isMemberNameValid(name) → {boolean}
Validate the string is a valid member name
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The string to validate as a member name. |
- Source:
- See:
Returns:
- Whether the string is a valid member name.
- Type
- boolean
(static) isObjectPathValid(path) → {boolean}
Validate the string as a valid object path.
Parameters:
Name | Type | Description |
---|---|---|
path |
string | The string to validate as an object path. |
- Source:
- See:
Returns:
- Whether the string is a valid object path.
- Type
- boolean