Add Switch.operationMode()

TooTallNate · Mar 23, 2024 · 696580c · 696580c
1 parent ed21758
commit 696580c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/thin-penguins-tie.md b/.changeset/thin-penguins-tie.md
@@ -0,0 +1,5 @@
+---
+"nxjs-runtime": patch
+---
+
+Add `Switch.operationMode()`
diff --git a/packages/runtime/src/switch.ts b/packages/runtime/src/switch.ts
@@ -259,6 +259,27 @@ export function appletType(): number {
 	return $.appletGetAppletType();
 }
 
+/**
+ * Returns the current "operation mode" of the device.
+ *
+ * This can be used to identify if the device is handheld or docked.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { OperationMode } from '@nx.js/constants';
+ *
+ * if (Switch.operationMode() === OperationMode.Handheld) {
+ *   console.log('Device is currently handheld');
+ * } else {
+ *   console.log('Device is currently docked');
+ * }
+ * ```
+ */
+export function operationMode(): number {
+	return $.appletGetOperationMode();
+}
+
 /**
  * Set media playback state.
  *