Files
blockly/core/internal_constants.ts
Maribeth Bottorff 037eb59b89 chore: Lint TsDoc. (#6353)
* chore: add linting for tsdoc

* chore: don't require types on return

* chore: remove redundant fileoverview from ts

* chore: change return to returns and add some newlines

* chore: remove license tag

* chore: don't require params/return docs

* chore: remove spurious struct tags

* Revert "chore: change return to returns and add some newlines"

This reverts commit d6d8656a45.

* chore: don't auto-add param names

* chore: disable require-param bc it breaks on this

* return to returns and add line breaks

* chore: configure additional jsdoc rules

* chore: run format

* Revert "chore: remove license tag"

This reverts commit 173455588a.

* chore: allow license tag format

* chore: only require jsdoc on exported items

* chore: add missing jsdoc or silence where needed

* chore: run format

* chore: lint fixes
2022-08-23 14:27:22 -07:00

69 lines
2.0 KiB
TypeScript

/**
* @license
* Copyright 2021 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Module that provides constants for use inside Blockly. Do not
* use these constants outside of the core library.
*
* @namespace Blockly.internalConstants
*/
import * as goog from '../closure/goog/goog.js';
goog.declareModuleId('Blockly.internalConstants');
import {ConnectionType} from './connection_type.js';
/**
* Number of characters to truncate a collapsed block to.
*
* @alias Blockly.internalConstants.COLLAPSE_CHARS
* @internal
*/
export const COLLAPSE_CHARS = 30;
/**
* When dragging a block out of a stack, split the stack in two (true), or drag
* out the block healing the stack (false).
*
* @alias Blockly.internalConstants.DRAG_STACK
* @internal
*/
export const DRAG_STACK = true;
/**
* Lookup table for determining the opposite type of a connection.
*
* @alias Blockly.internalConstants.OPPOSITE_TYPE
* @internal
*/
export const OPPOSITE_TYPE: number[] = [];
OPPOSITE_TYPE[ConnectionType.INPUT_VALUE] = ConnectionType.OUTPUT_VALUE;
OPPOSITE_TYPE[ConnectionType.OUTPUT_VALUE] = ConnectionType.INPUT_VALUE;
OPPOSITE_TYPE[ConnectionType.NEXT_STATEMENT] =
ConnectionType.PREVIOUS_STATEMENT;
OPPOSITE_TYPE[ConnectionType.PREVIOUS_STATEMENT] =
ConnectionType.NEXT_STATEMENT;
/**
* String for use in the dropdown created in field_variable.
* This string indicates that this option in the dropdown is 'Rename
* variable...' and if selected, should trigger the prompt to rename a variable.
*
* @alias Blockly.internalConstants.RENAME_VARIABLE_ID
* @internal
*/
export const RENAME_VARIABLE_ID = 'RENAME_VARIABLE_ID';
/**
* String for use in the dropdown created in field_variable.
* This string indicates that this option in the dropdown is 'Delete the "%1"
* variable' and if selected, should trigger the prompt to delete a variable.
*
* @alias Blockly.internalConstants.DELETE_VARIABLE_ID
* @internal
*/
export const DELETE_VARIABLE_ID = 'DELETE_VARIABLE_ID';