mirror of
https://github.com/google/blockly.git
synced 2026-01-10 10:27:08 +01:00
f4dbea0a65
* refactor(interfaces): Use typeof ... === 'function' to test for methods
Testing for
'name' in object
or
obj.name !== undefined
only checks for the existence of the property (and in the latter
case that the property is not set to undefined). That's fine if
the interface specifies a property of indeterminate type, but in
the usual case that the interface member is a method we can do
one better and check to make sure the property's value is
callable.
* refactor(interfaces): Always check obj is not null/undefined
Since most type predicates take an argument of type any but then
check for the existence of certain properties, explicitly check
that the argument is not null or undefined (or check implicitly
by calling another type predicate that does so first, which
necessitates adding a few casts because tsc infers the type of
the argument too narrowly).
* fix(interfaces): Add missing check to hasBubble type predicate
This appears to have inadvertently been omitted in PR #9004.
* fix(interfaces): Fix misplaced typeof
* fix: Fix typos in JSDocs
* fix(tests): Make Mocks conform to corresponding interfaces
Introduce a new MockFocusable, and add methods to MockIcon,
MockBubbleIcon and MockComment, so that they fulfil the
IFocusableNode, IIcon, IHasBubble and ICommentIcon interfaces
respectively.
* chore(tests): Add assertions verifying mocks conform to predicates
Add (test) runtime assertions that:
- isFocusableNode(MockFocusable) returns true
- isIcon(MockIcon) returns true
- hasBubble(MockBubbleIcon) returns true
- isCommentIcon(MockCommentIcon) returns true
(The latter is currently failing because Blockly is undefined when
isCommentIcon calls the MockCommentIcon's getType method.)
* fix(tests): Don't rely on Blockly being set in Mock methods
For some reason the global Blockly binding is not visible at the
time when isCommentIcon calls MockCommentIcon's getType method,
and presumably this problem would apply to getBubbleSize too,
so directly import the required items.
* refactor(tests): Make MockCommentIcon a MockBubbleIcon
This slightly simplifies it and makes it less likely to accidentally
stop conforming to IHasBubble.
* fix(interfaces): Fix incorrect check in isSelectable
Fix an error which caused ISelectable instances to fail
isSelectable() checks, one of the results of which is that
Blockly.common.getSelected() would generally return null.
Whoops!
38 lines
1.1 KiB
TypeScript
38 lines
1.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2023 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import type {IBubble} from './i_bubble';
|
|
|
|
export interface IHasBubble {
|
|
/** @returns True if the bubble is currently open, false otherwise. */
|
|
bubbleIsVisible(): boolean;
|
|
|
|
/** Sets whether the bubble is open or not. */
|
|
setBubbleVisible(visible: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Returns the current IBubble that implementations are managing, or null if
|
|
* there isn't one.
|
|
*
|
|
* Note that this cannot be expected to return null if bubbleIsVisible()
|
|
* returns false, i.e., the nullability of the returned bubble does not
|
|
* necessarily imply visibility.
|
|
*
|
|
* @returns The current IBubble maintained by implementations, or null if
|
|
* there is not one.
|
|
*/
|
|
getBubble(): IBubble | null;
|
|
}
|
|
|
|
/** Type guard that checks whether the given object is a IHasBubble. */
|
|
export function hasBubble(obj: any): obj is IHasBubble {
|
|
return (
|
|
typeof obj.bubbleIsVisible === 'function' &&
|
|
typeof obj.setBubbleVisible === 'function' &&
|
|
typeof obj.getBubble === 'function'
|
|
);
|
|
}
|