README

Administratif Wilayah Indonesia

Daftar wilayah administratif Indonesia

Install
Usage
API
- Examples
Browser
Source

Install

Install via npm package manager

$ npm install administratif-indonesia

or if you prefer using yarn package manager

$ yarn add administratif-indonesia

Usage

const AdministratifIndonesia = require('administratif-indonesia');
const ai = new AdministratifIndonesia();

console.log(JSON.stringify(ai.all(), null, '\t'));
/*
{
    "11-aceh": "/path/your-project/node_modules/administratif-indonesia/storages/11-aceh.json",
    "12-sumatera-utara": "/path/your-project/node_modules/administratif-indonesia/storages/12-sumatera-utara.json",
    // ...
}
*/

console.log(ai.get('51-bali'));
//=> /path/your-project/node_modules/administratif-indonesia/storages/51-bali.json

API

AdministratifIndonesia

Create a new instance of AdministratifIndonesia.

Instance

.path

Returns a string for full path of source directory.
e.g: /path/your-project/node_modules/administratif-indonesia/storages

.size()

Returns a number of size values.

.all()

Returns an object for all values.

.get(key)

Returns a string for a specifie values of an input key, otherwise will returns null.

.has(key)

Returns a boolean value if key has exists.

key

Type: string
Default: undefined

Examples

NOTE: Jika ukuran (size) data sangat besar, gunakanlah ReadableStreams.

Basic

const ai = new AdministratifIndonesia();

// synchronous output
console.log(fs.readFileSync(ai.get('31-dki-jakarta'), 'utf8'));

// Readable Streams
fs.createReadStream(ai.get('31-dki-jakarta')).pipe(process.stdout);

Server

const ai = new AdministratifIndonesia();

app.get('/api/administratif-indonesia/:identifier', (request, response) => {
    fs.createReadStream(ai.get(request.params.identifier))
        .pipe(response);
});

Browser

Semua file Administratif Indonesia dapat di akses langsung via browser melalui unpkg.com.

👉 https://unpkg.com/administratif-indonesia/storages/

Source

Mempertimbangkan beberapa sumber yang ada, librari ini menggunakan data yang bersumber dari Ditjen PUM Kemendagri (Permendagri No. 137-2017).

Conclusions

Library ini hanyalah kumpulan file-file json yang dapat anda gunakan untuk program web interface anda sehingga dapat dengan mudah membangun RESTful API pada sisi server (backend) dan juga berinovasi pada sisi (client) untuk UI/UX.

Memperhatikan sumber yang digunakan, librari ini juga dapat menjadi sebuah data acuan untuk penilitian lebih lanjut.

Kemendagri - Kementrian Dalam Negeri Republik Indonesia
(MFD Online) Badan Pusat Statistik - Sistem Pemutakhiran MFD dan MBS

administratif-indonesia

Usage no npm install needed!