JSPM

@types/babel__code-frame

7.0.6
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 351648
  • Score
    100M100P100Q194018F
  • License MIT

TypeScript definitions for @babel/code-frame

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/babel__code-frame) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/babel__code-frame

    Summary

    This package contains type definitions for @babel/code-frame (https://github.com/babel/babel/tree/master/packages/babel-code-frame).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/babel__code-frame.

    index.d.ts

    export interface SourceLocation {
        start: { line: number; column?: number | undefined };
        end?: { line: number; column?: number | undefined } | undefined;
    }
    export function codeFrameColumns(
        rawLines: string,
        location: SourceLocation,
        options?: BabelCodeFrameOptions,
    ): string;
    
    export interface BabelCodeFrameOptions {
        /** Syntax highlight the code as JavaScript for terminals. default: false */
        highlightCode?: boolean | undefined;
        /**  The number of lines to show above the error. default: 2 */
        linesAbove?: number | undefined;
        /**  The number of lines to show below the error. default: 3 */
        linesBelow?: number | undefined;
        /**
         * Forcibly syntax highlight the code as JavaScript (for non-terminals);
         * overrides highlightCode.
         * default: false
         */
        forceColor?: boolean | undefined;
        /**
         * Pass in a string to be displayed inline (if possible) next to the
         * highlighted location in the code. If it can't be positioned inline,
         * it will be placed above the code frame.
         * default: nothing
         */
        message?: string | undefined;
    }
    
    /**
     * Generate errors that contain a code frame that point to source locations.
     *
     * @param rawLines Raw lines to frame
     * @param lineNumber Line number (1 indexed)
     * @param colNumber Column number
     * @param options Additional options
     *
     * @returns Framed code
     */
    export default function codeFrame(
        rawLines: string,
        lineNumber: number,
        colNumber: number,
        options?: BabelCodeFrameOptions,
    ): string;
    

    Additional Details

    • Last updated: Mon, 06 Nov 2023 22:41:04 GMT
    • Dependencies: none

    Credits

    These definitions were written by Mohsen Azimi, and Forbes Lindesay.