git.iko.soy/typeable/libphonenumber
on main help sign in
Add haddocks for PhoneNumber selectors
c84e1famniip
src/Data/PhoneNumber/Number.hs+65
compare with main
unifiedsplit
@@ -79,3 +79,68 @@ pattern PhoneNumber
79 = fromCPhoneNumber $ CPhoneNumber{..}
79 = fromCPhoneNumber $ CPhoneNumber{..}
80
80
81{-# COMPLETE PhoneNumber #-}
81{-# COMPLETE PhoneNumber #-}
82+
83+-- | E.g.:
84+--
85+-- @
86+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.Canonicalize' 'Nothing' "+1 800-234-5678 ext. 1234"
87+-- = 'Right' v'PhoneNumber' { 'extension' = 'Just' "1234", .. }
88+-- @
89+extension :: PhoneNumber -> Maybe ByteString
90+
91+-- | E.g.:
92+--
93+-- @
94+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.KeepRawInput' 'Nothing' " + 1(2-3~4*5.6 "
95+-- = 'Right' v'PhoneNumber' { 'rawInput' = 'Just' " + 1(2-3~4*5.6 ", .. }
96+-- @
97+rawInput :: PhoneNumber -> Maybe ByteString
98+
99+-- | E.g.:
100+--
101+-- @
102+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.KeepRawInput' ('Just' \"BR\") "0 41 (21) 2345-6789"
103+-- = 'Right' v'PhoneNumber' { 'preferredDomesticCarrierCode' = 'Just' "41", .. }
104+-- @
105+preferredDomesticCarrierCode :: PhoneNumber -> Maybe ByteString
106+
107+-- | You probably want to use 'Data.PhoneNumber.Util.nationalSignificantNumber'
108+-- instead. E.g.:
109+--
110+-- @
111+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.Canonicalize' 'Nothing' "+800 0001 2345"
112+-- = 'Right' v'PhoneNumber' { 'nationalNumber' = 12345, 'numberOfLeadingZeros' = Just 3, .. }
113+-- @
114+nationalNumber :: PhoneNumber -> Word
115+
116+-- | E.g.:
117+--
118+-- @
119+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.Canonicalize' ('Just' \"US\") "800-234-5678"
120+-- = 'Right' v'PhoneNumber' { 'countryCode' = 1, .. }
121+-- @
122+countryCode :: PhoneNumber -> CountryCode
123+
124+-- | E.g.:
125+--
126+-- @
127+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.Canonicalize' 'Nothing' "+39 06 1234 5678"
128+-- = 'Right' v'PhoneNumber' { 'italianLeadingZero' = 'Just' 'True', .. }
129+-- @
130+italianLeadingZero :: PhoneNumber -> Maybe Bool
131+
132+-- | E.g.:
133+--
134+-- @
135+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.KeepRawInput' ('Just' \"US\") "011 800 1234 5678"
136+-- = 'Right' v'PhoneNumber' { 'countryCodeSource' = 'Just' 'FromNumberWithIdd', .. }
137+-- @
138+countryCodeSource :: PhoneNumber -> Maybe CountryCodeSource
139+
140+-- | E.g.:
141+--
142+-- @
143+-- 'Data.PhoneNumber.Util.parseNumber' 'Data.PhoneNumber.Util.Canonicalize' 'Nothing' "+800 0001 2345"
144+-- = 'Right' v'PhoneNumber' { 'numberOfLeadingZeros' = Just 3, 'nationalNumber' = 12345, .. }
145+-- @
146+numberOfLeadingZeros :: PhoneNumber -> Maybe Int