Permalink
Cannot retrieve contributors at this time
50 lines (42 sloc)
1.21 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/@aashutoshrathi/word-wrap/index.d.ts
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Wrap words to a specified length. | |
*/ | |
export = wrap; | |
declare function wrap(str: string, options?: wrap.IOptions): string; | |
declare namespace wrap { | |
export interface IOptions { | |
/** | |
* The width of the text before wrapping to a new line. | |
* @default ´50´ | |
*/ | |
width?: number; | |
/** | |
* The string to use at the beginning of each line. | |
* @default ´´ (none) | |
*/ | |
indent?: string; | |
/** | |
* The string to use at the end of each line. | |
* @default ´\n´ | |
*/ | |
newline?: string; | |
/** | |
* An escape function to run on each line after splitting them. | |
* @default (str: string) => string; | |
*/ | |
escape?: (str: string) => string; | |
/** | |
* Trim trailing whitespace from the returned string. | |
* This option is included since .trim() would also strip | |
* the leading indentation from the first line. | |
* @default true | |
*/ | |
trim?: boolean; | |
/** | |
* Break a word between any two letters when the word is longer | |
* than the specified width. | |
* @default false | |
*/ | |
cut?: boolean; | |
} | |
} |