Installation
npm install --save @types/wrap-text
Summary
This package contains type definitions for wrap-text (https://github.com/IonicaBizau/wrap-text#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wrap-text.
index.d.ts
export = wrapText;
/**
* Wrap text by a given width.
*
* @param input The input text.
* @param [width=80] The wrapping width.
*
* @example
* import wrapText = require("wrap-text");
*
* // Default width (80 chars)
* console.log(wrapText("Amet ad minima expedita dicta itaque cum debitis odio cupiditate, animi. Libero maiores quisquam consequuntur maiores nihil nobis. Cumque suscipit asperiores"));
* // =>
* // Amet ad minima expedita dicta itaque cum debitis odio cupiditate, animi. Libero
* // maiores quisquam consequuntur maiores nihil nobis. Cumque suscipit asperiores
*
* // 20 width
* console.log(wrapText(
* "Lorem vitae quasi quaerat et consectetur quis ea! Eos unde repellendus soluta eaque accusamus deserunt maiores? Facere nihil architecto facilis fuga quidem?"
* , 20
* ));
* // =>
* // Lorem vitae quasi
* // quaerat et
* // consectetur quis ea!
* // Eos unde repellendus
* // soluta eaque
* // accusamus deserunt
* // maiores? Facere nihil
* // architecto facilis
* // fuga quidem?
*
* // Multiline text
* console.log(wrapText(
* `Elit voluptate magni exercitationem voluptatem consequatur inventore. Incidunt reiciendis laudantium vero a voluptas quam! Quod officia consectetur eaque perspiciatis modi.
*
* Amet reprehenderit nesciunt eius magnam doloribus porro voluptatum. Repudiandae voluptatum neque neque quos adipisci accusamus. Sunt esse incidunt aperiam voluptate id unde quasi.
* Lorem eius ullam vero sequi exercitationem maiores nam possimus. Perspiciatis tempore magnam nostrum expedita blanditiis quas laboriosam ipsam corporis.`
* , 50
* ));
* // =>
* // Elit voluptate magni exercitationem voluptatem
* // consequatur inventore. Incidunt reiciendis
* // laudantium vero a voluptas quam! Quod officia
* // consectetur eaque perspiciatis modi.
* //
* // Amet reprehenderit nesciunt
* // eius magnam doloribus porro voluptatum. Repudiandae
* // voluptatum neque neque quos adipisci accusamus.
* // Sunt esse incidunt aperiam voluptate id unde quasi.
* // Lorem eius ullam vero sequi exercitationem
* // maiores nam possimus. Perspiciatis tempore magnam
* // nostrum expedita blanditiis quas laboriosam ipsam
* // corporis.
*/
declare function wrapText(input: string, width?: number): string;
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: none
Credits
These definitions were written by BendingBender.