# `PhoneNumber`

A phone number in E.164, `+447400123456`, valid by libphonenumber's metadata for its region. Personal data.

[People and contact](types.md#people-and-contact); not ordered; personal data (contact); since Jadpo 0.1.0.

## Make one

Build one from its text, `PhoneNumber("+447400123456")`, which checks it: text that isn't one breaks `format`.

`text.parse(raw, as: PhoneNumber)` reads one from its text; text that isn't one at all fails `malformed`, such as `07400123456`, `+44 7400 123456` or `447400123456`.

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `+447400123456` | `"+447400123456"` |
| `+12015550123` | `"+12015550123"` |
| `+33612345678` | `"+33612345678"` |

It is stored in one column named for the field, of type `text`. `+12015550123` is stored as `'+12015550123'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `+447400123456` | `07400 123456` |
| `+12015550123` | `+1 201-555-0123` |
| `+33612345678` | `+33 6 12 34 56 78` |

## Operations

It has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.