Class SystemModuleCpuExtension

Hierarchy

SystemModuleExtensionBase
- SystemModuleCpuExtension
  - SystemModule

Index

Constructors

constructor

Properties

instance

Methods

Constructors

constructor

new SystemModuleCpuExtension(instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>): SystemModuleCpuExtension

Inherited from SystemModuleExtensionBase.constructor
- Defined in modules/system/system-module-extension-base.ts:6
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
Returns SystemModuleCpuExtension

Properties

Readonly instance

instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>

Methods

on_cpuUsage

on_cpuUsage(listener: (newLoad: CPUUsage) => void, options?: ICpuUsageStreamOption): [() => void]

- Defined in modules/system/extensions/cpu.ts:139
Parameters
- listener: (newLoad: CPUUsage) => void
  - - (newLoad: CPUUsage): void
    - Parameters
      - newLoad: CPUUsage
      Returns void
- Optional options: ICpuUsageStreamOption
Returns [() => void]

usage

usage(): Promise<CPUUsage>

- Defined in modules/system/extensions/cpu.ts:59
Returns Promise<CPUUsage>

Generated using TypeDoc