Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

favelas

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

favelas

**The most complete list of all favelas of brazil by states**

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

FAVELAS

The most complete list of all favelas of brazil by states

USAGE

import Favelas from "favelas";

// the constructor is set to default to state ='rj' (Rio de Janeiro)
const favelas = new Favelas();

favelas.getAll();
/**
[
    {
    id: 1,
    name: 'Metral',
    complex: 'Vila Kennedy',
    zone: 'oeste',
    neighborhoods: 'Bangu'
    },
    {...}
]
**/

API

getAll(): Favela[]

Returns all favelas - full info

getById(favelaId: number): Favela

Returns a favela by the favelaId

getByName(name: string): Favela[]

A list of all favelas that match the name.

getAllNames(): string[]

The Name of all favelas

getFavelasByComplex(complex: string): Favela[]

Returns all favelas that are part of the complex matched.

getFavelasByZone(zone: Zone): Favela[]

Returns all favelas by the zone.

getByNeighborhood(neighborhood: string): Favela[]

Returns all favelas from the neighborhood passed.

total(): number

Return the amount of favelas in that state.

FAQs

Package last updated on 09 Jan 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc