1 |
|
2 |
|
3 |
|
4 | import {
|
5 | Metadata,
|
6 | PhoneNumber,
|
7 | E164Number,
|
8 | CountryCallingCode,
|
9 | CountryCode,
|
10 | CarrierCode,
|
11 | NationalNumber,
|
12 | Extension,
|
13 | ParseError,
|
14 | NumberFoundLegacy,
|
15 | NumberFound,
|
16 | NumberType,
|
17 | NumberFormat
|
18 | } from './types';
|
19 |
|
20 | import {
|
21 | ParsedNumber,
|
22 | FormatNumberOptions,
|
23 | ParseNumberOptions
|
24 | } from './index';
|
25 |
|
26 | export {
|
27 | Metadata,
|
28 | PhoneNumber,
|
29 | E164Number,
|
30 | CountryCallingCode,
|
31 | CountryCode,
|
32 | CarrierCode,
|
33 | NationalNumber,
|
34 | Extension,
|
35 | FormatNumberOptions,
|
36 | ParsedNumber,
|
37 | ParseNumberOptions,
|
38 | ParseError,
|
39 | NumberFoundLegacy,
|
40 | NumberFound,
|
41 | NumberFormat,
|
42 | NumberType
|
43 | };
|
44 |
|
45 |
|
46 | export function parsePhoneNumber(text: string, metadata: Metadata): PhoneNumber;
|
47 | export function parsePhoneNumber(text: string, defaultCountry: CountryCode, metadata: Metadata): PhoneNumber;
|
48 |
|
49 | export function parsePhoneNumberWithError(text: string, metadata: Metadata): PhoneNumber;
|
50 | export function parsePhoneNumberWithError(text: string, defaultCountry: CountryCode, metadata: Metadata): PhoneNumber;
|
51 |
|
52 |
|
53 |
|
54 | export function parsePhoneNumberFromString(text: string, metadata: Metadata): PhoneNumber;
|
55 | export function parsePhoneNumberFromString(text: string, defaultCountry: CountryCode | { defaultCountry?: CountryCode, defaultCallingCode?: string }, metadata: Metadata): PhoneNumber;
|
56 |
|
57 | export default parsePhoneNumberFromString;
|
58 |
|
59 | export function parse(text: string, metadata: Metadata): ParsedNumber;
|
60 | export function parse(text: string, options: CountryCode | ParseNumberOptions, metadata: Metadata): ParsedNumber;
|
61 |
|
62 | export function parseNumber(text: string, metadata: Metadata): ParsedNumber | {};
|
63 | export function parseNumber(text: string, options: CountryCode | ParseNumberOptions, metadata: Metadata): ParsedNumber | {};
|
64 |
|
65 |
|
66 |
|
67 | export function format(parsedNumber: ParsedNumber, format: NumberFormat, metadata: Metadata): string;
|
68 | export function format(phone: NationalNumber, format: NumberFormat, metadata: Metadata): string;
|
69 | export function format(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: Metadata): string;
|
70 |
|
71 | export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, metadata: Metadata): string;
|
72 | export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
|
73 |
|
74 | export function formatNumber(phone: NationalNumber, format: NumberFormat, metadata: Metadata): string;
|
75 | export function formatNumber(phone: NationalNumber, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
|
76 |
|
77 | export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: Metadata): string;
|
78 | export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
|
79 |
|
80 | export function getNumberType(parsedNumber: ParsedNumber, metadata: Metadata): NumberType;
|
81 | export function getNumberType(phone: NationalNumber, metadata: Metadata): NumberType;
|
82 | export function getNumberType(phone: NationalNumber, country: CountryCode, metadata: Metadata): NumberType;
|
83 |
|
84 | export function getExampleNumber(country: CountryCode, examples: { [country in CountryCode]: NationalNumber }, metadata: Metadata): PhoneNumber | undefined;
|
85 |
|
86 | export function isPossibleNumber(parsedNumber: ParsedNumber, metadata: Metadata): boolean;
|
87 | export function isPossibleNumber(phone: NationalNumber, metadata: Metadata): boolean;
|
88 | export function isPossibleNumber(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
|
89 |
|
90 | export function isValidNumber(parsedNumber: ParsedNumber, metadata: Metadata): boolean;
|
91 | export function isValidNumber(phone: NationalNumber, metadata: Metadata): boolean;
|
92 | export function isValidNumber(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
|
93 |
|
94 | export function isValidNumberForRegion(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
|
95 |
|
96 |
|
97 | export function findParsedNumbers(text: string, metadata: Metadata): NumberFoundLegacy[];
|
98 | export function findParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): NumberFoundLegacy[];
|
99 |
|
100 |
|
101 | export function searchParsedNumbers(text: string, metadata: Metadata): IterableIterator<NumberFoundLegacy>;
|
102 | export function searchParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): IterableIterator<NumberFoundLegacy>;
|
103 |
|
104 |
|
105 | export class ParsedNumberSearch {
|
106 | constructor(text: string, metadata: Metadata);
|
107 | constructor(text: string, options: { defaultCountry?: CountryCode }, metadata: Metadata);
|
108 | hasNext(): boolean;
|
109 | next(): NumberFoundLegacy | undefined;
|
110 | }
|
111 |
|
112 | export function findNumbers(text: string, metadata: Metadata): NumberFoundLegacy[];
|
113 | export function findNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode, v2: true }, metadata: Metadata): NumberFound[];
|
114 |
|
115 | export function searchNumbers(text: string, metadata: Metadata): IterableIterator<NumberFoundLegacy>;
|
116 | export function searchNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode, v2: true }, metadata: Metadata): IterableIterator<NumberFound>;
|
117 |
|
118 | export function findPhoneNumbersInText(text: string, metadata: Metadata): NumberFound[];
|
119 | export function findPhoneNumbersInText(text: string, options: CountryCode | { defaultCountry?: CountryCode, defaultCallingCode?: string }, metadata: Metadata): NumberFound[];
|
120 |
|
121 | export function searchPhoneNumbersInText(text: string, metadata: Metadata): IterableIterator<NumberFound>;
|
122 | export function searchPhoneNumbersInText(text: string, options: CountryCode | { defaultCountry?: CountryCode, defaultCallingCode?: string }, metadata: Metadata): IterableIterator<NumberFound>;
|
123 |
|
124 | export class PhoneNumberMatcher {
|
125 | constructor(text: string, metadata: Metadata);
|
126 | constructor(text: string, options: { defaultCountry?: CountryCode, v2: true }, metadata: Metadata);
|
127 | hasNext(): boolean;
|
128 | next(): NumberFound | undefined;
|
129 | }
|
130 |
|
131 | export function getCountries(metadata: Metadata): CountryCode[];
|
132 | export function getCountryCallingCode(countryCode: CountryCode, metadata: Metadata): CountryCallingCode;
|
133 | // Deprecated
|
134 | export function getPhoneCode(countryCode: CountryCode, metadata: Metadata): CountryCallingCode;
|
135 | export function getExtPrefix(countryCode: CountryCode, metadata: Metadata): string;
|
136 | export function isSupportedCountry(countryCode: CountryCode, metadata: Metadata): boolean;
|
137 |
|
138 | export function formatIncompletePhoneNumber(number: string, metadata: Metadata): string;
|
139 | export function formatIncompletePhoneNumber(number: string, countryCode: CountryCode, metadata: Metadata): string;
|
140 | export function parseIncompletePhoneNumber(text: string): string;
|
141 | export function parsePhoneNumberCharacter(character: string): string;
|
142 | export function parseDigits(character: string): string;
|
143 |
|
144 | export class AsYouType {
|
145 | constructor(defaultCountryCode: CountryCode | { defaultCountry?: CountryCode, defaultCallingCode?: string } | undefined, metadata: Metadata);
|
146 | input(text: string): string;
|
147 | reset(): void;
|
148 | country: CountryCode | undefined;
|
149 | getNumber(): PhoneNumber | undefined;
|
150 | getNationalNumber(): string;
|
151 | getChars(): string;
|
152 | getTemplate(): string;
|
153 | }
|
154 |
|
155 | // The exported `Metadata` name is already used for exporting the "raw" JSON metadata type.
|
156 | // Then, `Metadata` class has become exported, but its name is already taken, so TypeScript users seem to be unable to use the `Metadata` class.
|
157 | // If someone knows a solution then they could propose it in an issue.
|
158 | // export class Metadata {
|
159 | // ...
|
160 | // } |
\ | No newline at end of file |