diff --git a/README.md b/README.md index e9a9e6f8..8c439247 100644 --- a/README.md +++ b/README.md @@ -152,15 +152,15 @@ Through the `zebar` NPM package, Zebar exposes various system information via re | Variable | Description | Return type | | ------------------ | ----------------------------- | ----------------------- | -| `name` | Disk name. | `string` | +| `name` | Disk name. | `string \| null` | | `fileSystem` | File system used on the disk (e.g. `EXT4`, `NTFS`). | `string` | | `mountPoint` | Mount point of the disk (e.g. `/`, `C:\\`). | `string` | -| `totalSpace` | Total disk size. | `DiskSizeMeasure` | -| `availableSpace` | Available disk size. | `DiskSizeMeasure` | +| `totalSpace` | Total disk size. | `DataSizeMeasure` | +| `availableSpace` | Available disk size. | `DataSizeMeasure` | | `isRemovable` | Whether the disk is removable. | `boolean` | -| `diskType` | Type of disk. | `string` | +| `driveType` | Type of disk (e.g. `HDD`, `SSD`). | `string` | -#### `DiskSizeMeasure` +#### `DataSizeMeasure` | Variable | Description | Return type | | ---------- | --------------------------------------------------------------------------- | ----------- | @@ -276,12 +276,12 @@ No config options. | Variable | Description | Return type | | ------------------ | ----------------------------- | ----------------------- | -| `received` | Received bytes per second. | `NetworkTrafficMeasure` | -| `transmitted` | Transmitted bytes per second. | `NetworkTrafficMeasure` | -| `totalReceived` | Total received bytes. | `NetworkTrafficMeasure` | -| `totalTransmitted` | Total transmitted bytes. | `NetworkTrafficMeasure` | +| `received` | Received bytes per second. | `DataSizeMeasure` | +| `transmitted` | Transmitted bytes per second. | `DataSizeMeasure` | +| `totalReceived` | Total received bytes. | `DataSizeMeasure` | +| `totalTransmitted` | Total transmitted bytes. | `DataSizeMeasure` | -#### `NetworkTrafficMeasure` +#### `DataSizeMeasure` | Variable | Description | Return type | | ---------- | --------------------------------------------------------------------------- | ----------- | @@ -333,15 +333,25 @@ No config options. | Variable | Description | Return type | Supported OS | | ------------------- | ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `title` | TODO | `string` | microsoft icon | -| `artist` | TODO | `string` | microsoft icon | -| `albumTitle` | TODO | `string` | microsoft icon | -| `albumArtist` | TODO | `string` | microsoft icon | -| `trackNumber` | TODO | `string` | microsoft icon | -| `startTime` | TODO | `number` | microsoft icon | -| `endTime` | TODO | `number` | microsoft icon | -| `position` | TODO | `number` | microsoft icon | -| `isPlaying` | TODO | `boolean` | microsoft icon | +| `session` | Currently playing media session. | `MediaSession \| null` | microsoft icon | + +#### Return types + +#### `MediaSession` + +| Variable | Description | Return type | +| ------------------ | ----------------------------- | ----------------------- | +| `title` | TODO | `string` | +| `artist` | TODO | `string \| null` | +| `albumTitle` | TODO | `string \| null` | +| `albumArtist` | TODO | `string \| null` | +| `trackNumber` | TODO | `number` | +| `startTime` | TODO | `number` | +| `endTime` | TODO | `number` | +| `position` | TODO | `number` | +| `isPlaying` | TODO | `boolean` | + +#### `DataSizeMeasure` ### Weather