khoir v0.0.3

Khoir

Sederhana dan fleksibel untuk melakukan permintaan HTTP

Daftar Isi

• Pendahuluan
• Instalasi
• Penggunaan
  • Mengimpor Khoir
  • Membuat Instance
  • Menggunakan Promises
  • Menggunakan Callbacks
  • Menggunakan Async/Await
• API
  • Constructor
  • Method
    • get
    • post
    • put
    • delete
    • patch
    • head
    • options

Pendahuluan

Mendukung gaya promises, callbacks, dan async/await, sehingga mudah diintegrasikan ke berbagai project.

Instalasi

npm install khoir

Penggunaan

import { Khoir } from 'khoir'

const api = new Khoir('https://httpbin.org/')

api
  .get('/get')
  .then((res) => console.log(res))
  .catch((err) => console.error(err))

Mengimpor Khoir

Untuk menggunakan Khoir dalam project Anda, impor class Khoir sebagai berikut:

import { Khoir } from 'khoir' // ESM
const { Khoir } = require('khoir') // CommonJS

Membuat Instance

Buat instance Khoir dengan base URL untuk API Anda:

const api = new Khoir('https://httpbin.org/')

Menggunakan Promises

Berikut adalah contoh untuk setiap method HTTP:

• GET

  api
    .get('/endpoint')
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• POST

  api
    .post('/endpoint', { key: 'value' })
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• PUT

  api
    .put('/endpoint', { key: 'value' })
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• DELETE

  api
    .delete('/endpoint')
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• PATCH

  api
    .patch('/endpoint', { key: 'value' })
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• HEAD

  api
    .head('/endpoint')
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

• OPTIONS

  api
    .options('/endpoint')
    .then((res) => console.log(res)) // Menangani hasil sukses
    .catch((err) => console.error(err)) // Menangani kesalahan

Menggunakan Callbacks

Berikut adalah contoh untuk setiap method HTTP:

• GET

  api.get('/endpoint', {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• POST

  api.post('/endpoint', { key: 'value' }, {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• PUT

  api.put('/endpoint', { key: 'value' }, {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• DELETE

  api.delete('/endpoint', {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• PATCH

  api.patch('/endpoint', { key: 'value' }, {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• HEAD

  api.head('/endpoint', {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

• OPTIONS

  api.options('/endpoint', {}, (err, res) => {
    if (err) {
      return console.error(err) // Menangani kesalahan
    }
    console.log(res) // Menangani hasil sukses
  })

Menggunakan Async/Await

Berikut adalah contoh untuk setiap method HTTP:

• GET

  async function getData() {
    try {
      const res = await api.get('/endpoint')
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• POST

  async function postData() {
    try {
      const res = await api.post('/endpoint', { key: 'value' })
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• PUT

  async function putData() {
    try {
      const res = await api.put('/endpoint', { key: 'value' })
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• DELETE

  async function deleteData() {
    try {
      const res = await api.delete('/endpoint')
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• PATCH

  async function patchData() {
    try {
      const res = await api.patch('/endpoint', { key: 'value' })
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• HEAD

  async function headData() {
    try {
      const res = await api.head('/endpoint')
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

• OPTIONS

  async function optionsData() {
    try {
      const res = await api.options('/endpoint')
      console.log(res) // Menangani hasil sukses
    } catch (err) {
      console.error(err) // Menangani kesalahan
    }
  }

API

Constructor

new Khoir(baseURL)

• baseURL (string): URL dasar untuk semua permintaan API.

Method

get

get(endpoint, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

post

post(endpoint, data, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• data (object): Data yang disertakan dalam body permintaan.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

put

put(endpoint, data, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• data (object): Data yang disertakan dalam body permintaan.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

delete

delete (endpoint, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

patch

patch(endpoint, data, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• data (object): Data yang disertakan dalam body permintaan.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

head

head(endpoint, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.

options

options(endpoint, (headers = {}), callback)

• endpoint (string): Endpoint API yang diminta.
• headers (object): Header opsional yang disertakan dalam permintaan.
• callback (function): Fungsi callback opsional untuk menangani respons.