summaryrefslogtreecommitdiffstats
path: root/man/formatted_cep.Rd
blob: 7f77b4e6165bda294b9baaa1ba7c429bf22039fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/models.R
\name{formatted_cep}
\alias{formatted_cep}
\title{Add the mask to a CEP}
\usage{
formatted_cep(x)
}
\arguments{
\item{x}{A \link{cepis_address} or a character vector of CEPs.}
}
\value{
A character vector of masked CEPs. A value that is not 8 digits is
returned unchanged, because this is a formatting helper and not a
validator — \code{\link[=normalize_cep]{normalize_cep()}} is the validator.
}
\description{
\code{"01001000"} becomes \code{"01001-000"}. The API always answers unmasked;
formatting is presentation, and it lives here so it does not become a
repeated \code{paste0()} in every project that uses this package.
}
\examples{
formatted_cep("01001000")

}