src/vs/base/common/assert.ts
91 LOC · 75 covered · 16 uncovered · 22 ranges · 20961 concepts · 10 introducers · 12741 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
map.ts ×97
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { BugIndicatingError, onUnexpectedError } from './errors.js';
/**
* Throws an error with the provided message if the provided value does not evaluate to a true Javascript value.
*
* @deprecated Use `assert(...)` instead.
* This method is usually used like this:
* ```ts
* import * as assert from 'vs/base/common/assert';
* assert.ok(...);
* ```
*
* However, `assert` in that example is a user chosen name.
* There is no tooling for generating such an import statement.
* Thus, the `assert(...)` function should be used instead.
*/
export function ok(value?: unknown, message?: string) {
}
export function assertNever(value: never, message = 'Unreachable'): never {
throw new Error(message);
}
export function softAssertNever(value: never): void {
// no-op
}
/**
* Asserts that a condition is `truthy`.
*
* @throws provided {@linkcode messageOrError} if the {@linkcode condition} is `falsy`.
*
* @param condition The condition to assert.
* @param messageOrError An error message or error object to throw if condition is `falsy`.
*/
export function assert(
messageOrError: string | Error = 'unexpected state',
): asserts condition {
if (!condition) {
const errorToThrow = typeof messageOrError === 'string'
throw errorToThrow;
}
/**
* Like assert, but doesn't throw.
*/
export function softAssert(condition: boolean, message = 'Soft Assertion Failed'): void {
if (!condition) {
onUnexpectedError(new BugIndicatingError(message));
}
}
/**
* condition must be side-effect free!
*/
export function assertFn(condition: () => boolean): void {
// eslint-disable-next-line no-debugger
debugger;
// Reevaluate `condition` again to make debugging easier
condition();
onUnexpectedError(new BugIndicatingError('Assertion Failed'));
}
export function checkAdjacentItems<T>(items: readonly T[], predicate: (item1: T, item2: T) => boolean): boolean {
while (i < items.length - 1) {
const b = items[i + 1];
if (!predicate(a, b)) {
return false;
}
}
}