Class
Defined in: src/drivers/base/class.ts:24
A device class, i.e. /sys/class/<name>.
Devices with a class are linked into it, and live in /sys/devices/virtual/<name>
unless they have a parent.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Class(
name,init?):Class
Defined in: src/drivers/base/class.ts:30
Parameters
Section titled “Parameters”string
ClassInit = {}
Returns
Section titled “Returns”Class
Overrides
Section titled “Overrides”Properties
Section titled “Properties”attributes
Section titled “attributes”attributes:
Map<string,Attribute>
Defined in: src/kobject.ts:21
These attributes use the kobject’s show and store.
Inherited from
Section titled “Inherited from”children
Section titled “children”children:
Map<string,KEntry>
Defined in: src/kobject.ts:16
Inherited from
Section titled “Inherited from”class_attrs
Section titled “class_attrs”
readonlyclass_attrs:Record<string,ClassAttribute>
Defined in: src/drivers/base/class.ts:25
dev_attrs
Section titled “dev_attrs”
readonlydev_attrs:Record<string,DeviceAttribute>
Defined in: src/drivers/base/class.ts:26
dev_node?
Section titled “dev_node?”
optionaldev_node?: (device) =>DevNode|undefined
Defined in: src/drivers/base/class.ts:28
Parameters
Section titled “Parameters”device
Section titled “device”Returns
Section titled “Returns”DevNode | undefined
name:
string
Defined in: src/kobject.ts:24
Inherited from
Section titled “Inherited from”parent?
Section titled “parent?”
optionalparent?:KObject|null
Defined in: src/kobject.ts:25
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get path():
string
Defined in: src/kobject.ts:34
The path of this kobject, relative to the root of sysfs.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: src/kobject.ts:72
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”add_uevent_attr()
Section titled “add_uevent_attr()”add_uevent_attr():
void
Defined in: src/kobject.ts:115
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”create_attribute()
Section titled “create_attribute()”create_attribute(
name,show?,store?,mode?):Attribute
Defined in: src/kobject.ts:132
Parameters
Section titled “Parameters”string
((kobj) => string) | null
store?
Section titled “store?”((kobj, value) => void) | null
number = ...
Defaults based on which of show and store were passed.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”dispose()
Section titled “dispose()”dispose():
void
Defined in: src/kobject.ts:64
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”keys()
Section titled “keys()”keys():
Iterable<string>
Defined in: src/kobject.ts:60
The names of everything in this kobject.
Returns
Section titled “Returns”Iterable<string>
Inherited from
Section titled “Inherited from”lookup()
Section titled “lookup()”lookup(
name):KEntry|undefined
Defined in: src/kobject.ts:44
Resolve a single entry by name.
Attributes that use this kobject’s show and store are bound before being returned.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”KEntry | undefined
Inherited from
Section titled “Inherited from”notify_uevent()
Section titled “notify_uevent()”notify_uevent(
action,env?):void
Defined in: src/kobject.ts:82
Notify listeners that something happened to kobj.
Parameters
Section titled “Parameters”action
Section titled “action”"add" | "remove" | "change" | "move" | "online" | "offline" | "bind" | "unbind"
UEventEnv = {}
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”send_uevent()
Section titled “send_uevent()”send_uevent(
text):void
Defined in: src/kobject.ts:100
Send a uevent described by text, an action optionally followed by KEY=VALUE pairs.
This is what writing to a uevent attribute does.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”show()?
Section titled “show()?”
optionalshow(attr):string
Defined in: src/kobject.ts:76
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”store()?
Section titled “store()?”
optionalstore(attr,value):void
Defined in: src/kobject.ts:77
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”uevent()?
Section titled “uevent()?”
optionaluevent(env):void
Defined in: src/kobject.ts:127
Add variables to the environment of uevents sent for this kobject and its descendants.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
notify_uevent