JSPM

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

TypeScript definitions for wrap-ansi

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/wrap-ansi) 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/wrap-ansi

    Summary

    This package contains type definitions for wrap-ansi (https://www.npmjs.com/package/wrap-ansi).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wrap-ansi.

    index.d.ts

    /**
     * Wrap words to the specified column width.
     *
     * @param input   String with ANSI escape codes. Like one styled by chalk.
     * @param columns Number of columns to wrap the text to.
     * @param options By default the wrap is soft, meaning long words may extend past the column width. Setting
     *                this to true will make it hard wrap at the column width.
     */
    declare function wrapAnsi(input: string, columns: number, options?: wrapAnsi.Options): string;
    
    declare namespace wrapAnsi {
        interface Options {
            /** @default false */
            hard?: boolean | undefined;
            /** @default true */
            trim?: boolean | undefined;
            /** @default true */
            wordWrap?: boolean | undefined;
        }
    }
    
    export default wrapAnsi;
    

    Additional Details

    • Last updated: Wed, 18 Oct 2023 18:04:04 GMT
    • Dependencies: none

    Credits

    These definitions were written by Klaus Reimer, and Piotr Błażejewicz.