Skip to content

Commit

Permalink
Fix tick symbol in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ehmicky committed Mar 3, 2024
1 parent b10ba98 commit dda3514
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions index.d.ts
Expand Up @@ -256,12 +256,12 @@ Replace Unicode symbols depending on the terminal.
```
import figures, {replaceSymbols} from 'figures';
console.log(replaceSymbols('✔ check'));
// On terminals with Unicode symbols: ✔ check
console.log(replaceSymbols('✔ check'));
// On terminals with Unicode symbols: ✔ check
// On other terminals: √ check
console.log(figures.tick);
// On terminals with Unicode symbols: ✔
// On terminals with Unicode symbols: ✔
// On other terminals: √
```
*/
Expand Down
2 changes: 1 addition & 1 deletion index.test-d.ts
@@ -1,7 +1,7 @@
import {expectType} from 'tsd';
import figures, {replaceSymbols, mainSymbols, fallbackSymbols} from './index.js';

expectType<string>(replaceSymbols('✔ check'));
expectType<string>(replaceSymbols('✔ check'));
expectType<string>(figures.tick);
expectType<string>(mainSymbols.tick);
expectType<string>(fallbackSymbols.tick);
8 changes: 4 additions & 4 deletions readme.md
Expand Up @@ -20,17 +20,17 @@ npm install figures
import figures, {replaceSymbols, mainSymbols, fallbackSymbols} from 'figures';

console.log(figures.tick);
// On terminals with Unicode symbols: ✔
// On terminals with Unicode symbols: ✔
// On other terminals: √

console.log(mainSymbols.tick);
// On all terminals: ✔
// On all terminals: ✔

console.log(fallbackSymbols.tick);
// On all terminals: √

console.log(replaceSymbols(' check'));
// On terminals with Unicode symbols: ✔ check
console.log(replaceSymbols('✔ check'));
// On terminals with Unicode symbols: ✔ check
// On other terminals: √ check
```

Expand Down

0 comments on commit dda3514

Please sign in to comment.