36 lines
960 B
TypeScript
36 lines
960 B
TypeScript
/**
|
|
Terminal string styling with [tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates)
|
|
|
|
@example
|
|
```
|
|
import chalkTemplate from 'chalk-template';
|
|
|
|
log(chalkTemplate`
|
|
CPU: {red ${cpu.totalPercent}%}
|
|
RAM: {green ${ram.used / ram.total * 100}%}
|
|
DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
|
|
`);
|
|
```
|
|
|
|
@example
|
|
```
|
|
import chalkTemplate from 'chalk-template';
|
|
import chalk from 'chalk';
|
|
|
|
log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
|
|
```
|
|
*/
|
|
export default function chalkTemplate(text: TemplateStringsArray, ...placeholders: unknown[]): string;
|
|
|
|
/**
|
|
Terminal string styling. It is preferred that you use the template tag (default export) but this function is useful if you'd like to wrap the color template function.
|
|
|
|
@example
|
|
```
|
|
import { template } from 'chalk-template';
|
|
|
|
log(template('Today is {red hot}')
|
|
```
|
|
*/
|
|
export function template(text: string): string;
|