generateNeighborhood function exported ✓ 100.0%

Last updated: 2026-02-25T14:02:03.591Z

Location

src/lib/generators/address.ts:40-46

Metrics

LOC: 7 Complexity: 2 Params: 1 Coverage: 100.0% (4/4 lines, 2x executed)

Signature

generateNeighborhood(onlyLetters = false): : string

Summary

Generates a random Brazilian neighborhood name.

Tags

#@param onlyLetters - Strip numeric characters from the result (default: `false`)

Source Code

export function generateNeighborhood(onlyLetters = false): string {
  const value = faker.location.county();
  if (onlyLetters) {
    return value.replace(/[0-9]/g, "").trim();
  }
  return value;
}

No outgoing dependencies.

Impact (Incoming)

graph LR generateNeighborhood["generateNeighborhood"] GeneratorFn["GeneratorFn"] GeneratorFn -->|calls| generateNeighborhood style generateNeighborhood fill:#dbeafe,stroke:#2563eb,stroke-width:2px click generateNeighborhood "87a1d58aea7e0b86.html" click GeneratorFn "07e2c388ba1ac3f3.html"
SourceType
GeneratorFn calls