c3-areas-db v1.2.0

C3 Areas

Get a list of areas for c3 apps

Install it

NPM

$ npm install c3-areas-db --save

Yarn

$ yarn add c3-areas-db

Add it

var c3areas = require('c3-areas-db');

Usage

Get areas

// Get all areas
var areas = c3areas.getAreas();

// OR
// Get all areas by passing the state slug.
var areas = c3areas.getAreas('nigeria_lagos');

//Sample response
console.log(areas);

[ { name: 'Iganmu/Costain',
    slug: 'nigeria_lagos_apapa_iganmu-costain',
    areaSlug: 'iganmu-costain',
    city: 'nigeria_lagos_apapa',
    state: 'nigeria_lagos',
    country: 'nigeria' },
  { name: 'Ijora',
    slug: 'nigeria_lagos_apapa_ijora',
    areaSlug: 'ijora',
    city: 'nigeria_lagos_apapa',
    state: 'nigeria_lagos',
    country: 'nigeria' },
  { name: 'Epe',
    slug: 'nigeria_lagos_epe_epe',
    areaSlug: 'epe',
    city: 'nigeria_lagos_epe',
    state: 'nigeria_lagos',
    country: 'nigeria' },
  { name: 'Outside Lagos',
    slug: 'nigeria_lagos_apapa_outside-lagos',
    areaSlug: 'outside-lagos',
    city: 'nigeria_lagos_apapa',
    state: 'nigeria_lagos',
    country: 'nigeria' } ]

// Filter areas
// Get all areas in lagos, nigeria that contain the string 'ab'.
var filteredStates = c3areas.getAreas('nigeria_lagos', 'Suru');

//Sample response
console.log(filteredStates);

[ { name: 'Surulere/Iponri',
    slug: 'nigeria_lagos_surulere_surulere-iponri',
    areaSlug: 'surulere-iponri',
    city: 'nigeria_lagos_surulere',
    state: 'nigeria_lagos',
    country: 'nigeria' } ]

Note: You can get the state slug from the state-cities-db npm module getStates() method.

Get item by slug

// Get by slug
var area = c3areas.getBySlug("nigeria_lagos_surulere_surulere-iponri"); 

//Sample response
console.log(area);

{ name: 'Surulere/Iponri',
  slug: 'nigeria_lagos_surulere_surulere-iponri',
  areaSlug: 'surulere-iponri',
  city: 'nigeria_lagos_surulere',
  state: 'nigeria_lagos',
  country: 'nigeria' }