@type-ddd/phone

The @type-ddd/phone library provides TypeScript type definitions for handling phone (Brazilian) in Domain-Driven Design contexts. It facilitates the validation and manipulation of phone numbers, ensuring they adhere to the Brazilian legal standards.

---

Installation

Install rich-domain and @type-ddd/phone with your favorite package manager

1
2npm i rich-domain @type-ddd/phone
3
4# OR
5
6yarn add rich-domain @type-ddd/phone
7

Usage

Don't worry about removing special characters; they are automatically stripped from all instances.

1
2import { Phone } from '@type-ddd/phone'
3
4// Instance of phone or throws an error if provide an invalid value
5const phone = Phone.init('11994882021');
6
7// OR
8
9// Result of phone (Check Result pattern docs)
10const result = Phone.create('11994882021');
11
12result.isOk(); // true
13
14// phone instance or null if provide an invalid value
15const phone = result.value();
16

Check phone type

Method to verify instance type.

1
2// value as string 
3const isMobile = Phone.isMobile('11994882021');
4// Output: true
5
6// OR
7
8// value as string 
9const isMobile = Phone.isHome('11994882021');
10// Output: false
11

Special Chars

Don't worry about removing special characters; they are automatically stripped from all instances.

1
2const result = Phone.isValid('(11) 99488-2021');
3// Output: true
4

Special chars

If you need the value with the mask, you can use the toPattern method:

1
2phone.toPattern();
3
4// Output: '(11) 99488-2021'
5

Or if you need to apply mask from a string value you may use addMask method

1
2Phone.addMask('11994882021');
3
4// Output: (11) 99488-2021
5

Or if you need to remove mask from a string value you may use removeSpecialChars method

1
2Phone.removeSpecialChars('(11) 99488-2021');
3
4// Output: 11994882021
5

If you need to identify uf from a phone number

1
2const phone = Phone.init('(11) 99488-2021');
3
4phone.uf();
5// Output: "São Paulo"
6
7phone.code();
8// 11
9
10phone.number();
11// 994882021
12
13phone.toCall();
14// 011994882021
15