Use @typedef to document mode param

packages/block-editor/src/components/block-editing-mode/index.js

@@ -11,6 +11,10 @@ import { store as blockEditorStore } from '../../store';
 import { unlock } from '../../lock-unlock';
 import { BlockListBlockContext } from '../block-list/block';
 
+/**
+ * @typedef {'disabled'|'contentOnly'|'default'} BlockEditingMode
+ */
+
 /**
  * Allows a block to restrict the user interface that is displayed for editing
  * that block and its inner blocks.
@@ -36,11 +40,10 @@ import { BlockListBlockContext } from '../block-list/block';
  *
  * If called outside of a block context, the mode is applied to all blocks.
  *
- * @param {?string} mode The editing mode to apply. If undefined, the current
- *                       editing mode is not changed. One of `'disabled'`,
- *                       `'contentOnly'`, or `'default'`.
+ * @param {?BlockEditingMode} mode The editing mode to apply. If undefined, the
+ *                                 current editing mode is not changed.
  *
- * @return {string} The current editing mode.
+ * @return {BlockEditingMode} The current editing mode.
  */
 export function useBlockEditingMode( mode ) {
 	const { clientId = '' } = useContext( BlockListBlockContext ) ?? {};

packages/block-editor/src/store/private-actions.js

@@ -67,14 +67,18 @@ export function showBlockInterface() {
 	};
 }
 
+/**
+ * @typedef {import('../components/block-editing-mode').BlockEditingMode} BlockEditingMode
+ */
+
 /**
  * Sets the block editing mode for a given block.
  *
  * @see useBlockEditingMode
  *
- * @param {string} clientId The block client ID, or `''` for the root container.
- * @param {string} mode     The block editing mode. One of `'disabled'`,
- *                          `'contentOnly'`, or `'default'`.
+ * @param {string}           clientId The block client ID, or `''` for the root container.
+ * @param {BlockEditingMode} mode     The block editing mode. One of `'disabled'`,
+ *                                    `'contentOnly'`, or `'default'`.
  *
  * @return {Object} Action object.
  */

packages/block-editor/src/store/private-selectors.js

@@ -39,6 +39,10 @@ export function getLastInsertedBlocksClientIds( state ) {
 	return state?.lastBlockInserted?.clientIds;
 }
 
+/**
+ * @typedef {import('../components/block-editing-mode').BlockEditingMode} BlockEditingMode
+ */
+
 /**
  * Returns the block editing mode for a given block.
  *
@@ -64,8 +68,8 @@ export function getLastInsertedBlocksClientIds( state ) {
  * @param {Object} state    Global application state.
  * @param {string} clientId The block client ID, or `''` for the root container.
  *
- * @return {string} The block editing mode. One of `'disabled'`,
- *                  `'contentOnly'`, or `'default'`.
+ * @return {BlockEditingMode} The block editing mode. One of `'disabled'`,
+ *                            `'contentOnly'`, or `'default'`.
  */
 export const getBlockEditingMode = createRegistrySelector(
 	( select ) =>