Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rename phone.phoneFormats() to formats() #710

Closed
wants to merge 2 commits into from

Conversation

kumar-kalyan
Copy link

renamed phoneFormats() to formats
Ref : #694

renamed `phoneFormats()` to `formats`
@kumar-kalyan kumar-kalyan requested a review from a team as a code owner March 28, 2022 19:55
@kumar-kalyan kumar-kalyan deleted the patch-1 branch March 28, 2022 19:56
@kumar-kalyan kumar-kalyan restored the patch-1 branch March 28, 2022 19:56
@kumar-kalyan kumar-kalyan reopened this Mar 28, 2022
src/phone.ts Outdated
@@ -55,7 +55,7 @@ export class Phone {
* faker.phone.phoneFormats() // '!##.!##.####'
*/
// TODO @pkuczynski 2022-02-01: simplify name to `format()`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this comment.

@@ -55,7 +55,7 @@ export class Phone {
* faker.phone.phoneFormats() // '!##.!##.####'
*/
// TODO @pkuczynski 2022-02-01: simplify name to `format()`
phoneFormats(): string {
formats(): string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please format this correctly by running pnpm run format.
Please create an alias with a deprecation warning that points to this method to ease migration.

@ST-DDT ST-DDT added this to the v6.2 - New small features milestone Mar 28, 2022
@ST-DDT ST-DDT added s: on hold Blocked by something or frozen to avoid conflicts p: 1-normal Nothing urgent labels Mar 28, 2022
@ST-DDT
Copy link
Member

ST-DDT commented Mar 28, 2022

We haven't decided whether we actually want to expose the method in general. So putting this on hold.

@ST-DDT ST-DDT linked an issue Mar 28, 2022 that may be closed by this pull request
@ST-DDT ST-DDT changed the title Update phone.ts chore: rename phone.phoneFormats() to formats() Mar 28, 2022
src/phone.ts Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member

ST-DDT commented Mar 29, 2022

Superseded by #724

@ST-DDT ST-DDT closed this Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p: 1-normal Nothing urgent s: on hold Blocked by something or frozen to avoid conflicts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

deprecate phone.phoneFormat
3 participants