Skip to content

Commit 041441c

Browse files
VitorLuizCVitorLuizC
committed
🚚 rename formatToHidden to formatToHiddenDigits
1 parent 7544b8b commit 041441c

File tree

5 files changed

+40
-40
lines changed

5 files changed

+40
-40
lines changed

‎README.en.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const document = formatToCNPJ(value);
7777
- [`formatToNumber`](#formatToNumber)
7878
- [`formatToPhone`](#formatToPhone)
7979
- [`formatToRG`](#formatToRG)
80-
- [`formatToHidden`](#formatToHidden)
80+
- [`formatToHiddenDigits`](#formatToHiddenDigits)
8181
</details>
8282

8383
<details>
@@ -310,25 +310,25 @@ formatToRG('MG-14.808.688', 'MG')
310310
//=> 'MG-14.808.688'
311311
```
312312

313-
#### `formatToHidden`
313+
#### `formatToHiddenDigits`
314314

315315
Formats a `string` with digits by replacing digits within the range by the hider
316316
character.
317317

318318
```js
319-
formatToHidden('00.000-000')
319+
formatToHiddenDigits('00.000-000')
320320
//=> '**.*00-000'
321321

322-
formatToHidden('03/04/2002', { hider: '-' })
322+
formatToHiddenDigits('03/04/2002', { hider: '-' })
323323
//=> '--/-4/2002'
324324

325-
formatToHidden('111.111.111-11', { range: [4, 9] })
325+
formatToHiddenDigits('111.111.111-11', { range: [4, 9] })
326326
//=> '111.***.***-11'
327327

328-
formatToHidden('12.345.678-9', { hider: '#', range: 5 })
328+
formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 })
329329
//=> '##.###.678-9'
330330

331-
formatToHidden('52.715.348/0001-69', { hider: '@', range: -9 })
331+
formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 })
332332
//=> '52.715.@@@/@@@@-@@'
333333
```
334334

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ const document = formatToCNPJ(value);
7676
- [`formatToNumber`](#formatToNumber)
7777
- [`formatToPhone`](#formatToPhone)
7878
- [`formatToRG`](#formatToRG)
79-
- [`formatToHidden`](#formatToHidden)
79+
- [`formatToHiddenDigits`](#formatToHiddenDigits)
8080
</details>
8181

8282
<details>
@@ -309,7 +309,7 @@ formatToRG('MG-14.808.688', 'MG')
309309
//=> 'MG-14.808.688'
310310
```
311311

312-
#### `formatToHidden`
312+
#### `formatToHiddenDigits`
313313

314314
Formata uma `string` contendo dígitos substituindo os dígitos dentro do
315315
intervalo pelo caractere oculto (`hider`).
@@ -322,19 +322,19 @@ intervalo pelo caractere oculto (`hider`).
322322
> é o "*" (asterísco).
323323
324324
```js
325-
formatToHidden('00.000-000')
325+
formatToHiddenDigits('00.000-000')
326326
//=> '**.*00-000'
327327

328-
formatToHidden('03/04/2002', { hider: '-' })
328+
formatToHiddenDigits('03/04/2002', { hider: '-' })
329329
//=> '--/-4/2002'
330330

331-
formatToHidden('111.111.111-11', { range: [4, 9] })
331+
formatToHiddenDigits('111.111.111-11', { range: [4, 9] })
332332
//=> '111.***.***-11'
333333

334-
formatToHidden('12.345.678-9', { hider: '#', range: 5 })
334+
formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 })
335335
//=> '##.###.678-9'
336336

337-
formatToHidden('52.715.348/0001-69', { hider: '@', range: -9 })
337+
formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 })
338338
//=> '52.715.@@@/@@@@-@@'
339339
```
340340

‎src/formatters/formatToHidden.ts renamed to ‎src/formatters/formatToHiddenDigits.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import { Range, normalizeRange, within } from "../models/Range";
22
import parseToCharacters from "../parsers/parseToCharacters";
33

4-
/** Options object for {@link formatToHidden} function. */
5-
export type FormatToHiddenOptions = {
4+
/** Options object for {@link formatToHiddenDigits} function. */
5+
export type FormatToHiddenDigitsOptions = {
66
/**
7-
* The range of digits replaced by {@link FormatToHiddenOptions.hider}
7+
* The range of digits replaced by {@link FormatToHiddenDigitsOptions.hider}
88
* character. It can be both a tuple of numbers or a single number.
99
*
1010
* @example ```js
11-
* formatToHidden("00.000-00", { range: 2 });
11+
* formatToHiddenDigits("00.000-00", { range: 2 });
1212
* //=> "**.000-00"
1313
*
14-
* formatToHidden("00.000-00", { range: -2 });
14+
* formatToHiddenDigits("00.000-00", { range: -2 });
1515
* //=> "00.000-**"
1616
*
17-
* formatToHidden("00.000-00", { range: [1, 4] });
17+
* formatToHiddenDigits("00.000-00", { range: [1, 4] });
1818
* //=> "0*.***-00"
1919
* ```
2020
*
@@ -24,16 +24,16 @@ export type FormatToHiddenOptions = {
2424

2525
/**
2626
* The character used as replacement for digits in within
27-
* {@link FormatToHiddenOptions.range}.
27+
* {@link FormatToHiddenDigitsOptions.range}.
2828
*
2929
* @example ```js
30-
* formatToHidden("00.000-00", { hider: "-" });
30+
* formatToHiddenDigits("00.000-00", { hider: "-" });
3131
* //=> "--.-00-00"
3232
*
33-
* formatToHidden("00.000-00", { hider: " " });
33+
* formatToHiddenDigits("00.000-00", { hider: " " });
3434
* //=> " . 00-00"
3535
*
36-
* formatToHidden("00.000-00", { hider: "#" });
36+
* formatToHiddenDigits("00.000-00", { hider: "#" });
3737
* //=> "##.#00-00"
3838
* ```js
3939
*
@@ -47,28 +47,28 @@ export type FormatToHiddenOptions = {
4747
* range using the hider character as replacement.
4848
*
4949
* @example ```js
50-
* formatToHidden('00.000-000')
50+
* formatToHiddenDigits('00.000-000')
5151
* //=> '**.*00-000'
5252
*
53-
* formatToHidden('03/04/2002', { hider: '-' })
53+
* formatToHiddenDigits('03/04/2002', { hider: '-' })
5454
* //=> '--/-4/2002'
5555
*
56-
* formatToHidden('111.111.111-11', { range: [4, 9] })
56+
* formatToHiddenDigits('111.111.111-11', { range: [4, 9] })
5757
* //=> '111.***.***-11'
5858
*
59-
* formatToHidden('12.345.678-9', { hider: '#', range: 5 })
59+
* formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 })
6060
* //=> '##.###.678-9'
6161
*
62-
* formatToHidden('52.715.348/0001-69', { hider: '@', range: -9 })
62+
* formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 })
6363
* //=> '52.715.@@@/@@@@-@@'
6464
* ```
6565
*
6666
* @param value - A `string` with digits, with or without a mask.
6767
* @param options - The options object.
6868
*/
69-
const formatToHidden = (
69+
const formatToHiddenDigits = (
7070
value: string,
71-
options: FormatToHiddenOptions = {},
71+
options: FormatToHiddenDigitsOptions = {},
7272
): string => {
7373
const characters = parseToCharacters(value);
7474
const range = normalizeRange(options.range ?? 3, characters.digits);
@@ -81,4 +81,4 @@ const formatToHidden = (
8181
.join("");
8282
};
8383

84-
export default formatToHidden;
84+
export default formatToHiddenDigits;

‎src/formatters/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export { default as formatToCapitalized } from './formatToCapitalized';
88
export { default as formatToDate } from './formatToDate';
99
export { default as formatToDateTime } from './formatToDateTime';
1010
export { default as formatToGenericPhone } from './formatToGenericPhone';
11-
export { default as formatToHidden } from './formatToHidden';
11+
export { default as formatToHiddenDigits, FormatToHiddenDigitsOptions } from './formatToHiddenDigits';
1212
export { default as formatToList } from './formatToList';
1313
export { default as formatToNumber } from './formatToNumber';
1414
export { default as formatToPhone } from './formatToPhone';

‎test/formatters.test.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
formatToDate,
1111
formatToDateTime,
1212
formatToGenericPhone,
13-
formatToHidden,
13+
formatToHiddenDigits,
1414
formatToList,
1515
formatToNumber,
1616
formatToPhone,
@@ -145,10 +145,10 @@ test('formatToCAEPF', (context) => {
145145
context.is(formatToCAEPF('123.456.789/001-99'), '123.456.789/001-99')
146146
})
147147

148-
test('formatToHidden', (context) => {
149-
context.is(formatToHidden('00.000-000'), '**.*00-000');
150-
context.is(formatToHidden('03/04/2002', { hider: '-' }), '--/-4/2002');
151-
context.is(formatToHidden('111.111.111-11', { range: [4, 9] }), '111.***.***-11');
152-
context.is(formatToHidden('12.345.678-9', { hider: '#', range: 5 }), '##.###.678-9');
153-
context.is(formatToHidden('52.715.348/0001-69', { hider: '@', range: -9 }), '52.715.@@@/@@@@-@@');
148+
test('formatToHiddenDigits', (context) => {
149+
context.is(formatToHiddenDigits('00.000-000'), '**.*00-000');
150+
context.is(formatToHiddenDigits('03/04/2002', { hider: '-' }), '--/-4/2002');
151+
context.is(formatToHiddenDigits('111.111.111-11', { range: [4, 9] }), '111.***.***-11');
152+
context.is(formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 }), '##.###.678-9');
153+
context.is(formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 }), '52.715.@@@/@@@@-@@');
154154
});

0 commit comments

Comments
 (0)