# analyzeNumber

Source: https://pakdatakit.dev/api/typescript/numbers/functions/analyzenumber/

```ts
function analyzeNumber(phone): NumberInfo | null;
```

Defined in: [numbers.ts:99](https://github.com/chmuzamil/pakdatakit/blob/a6eeaa47381308c4e4fcda45b29642fe4fbfb1fc/src/numbers.ts#L99)

Identifies and formats any Pakistani telephone number: mobile, landline,
UAN (`111`), toll-free (`0800`), premium-rate (`0900`) or personal (`0122`).

## Parameters

| Parameter | Type | Description |
| :------ | :------ | :------ |
| `phone` | `string` | Number in local or international format |

## Returns

[`NumberInfo`](https://pakdatakit.dev/api/typescript/numbers/interfaces/numberinfo/) \| `null`

Number details, or `null` if it is not a valid Pakistani number

## Example

```ts
analyzeNumber('021-111-825-888');
// { type: 'uan', formatted: '021-111-825-888', e164: '+9221111825888',
//   areaCode: '021', cities: ['Karachi'] }
analyzeNumber('042 35761234');
// { type: 'landline', formatted: '042-35761234', e164: '+924235761234',
//   areaCode: '042', cities: ['Lahore'] }
```
