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

1npm install khoir

Penggunaan

1import { Khoir } from 'khoir'
2
3const api = new Khoir('https://httpbin.org/')
4
5api
6  .get('/get')
7  .then((res) => console.log(res))
8  .catch((err) => console.error(err))

Mengimpor Khoir

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

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

Membuat Instance

Buat instance Khoir dengan base URL untuk API Anda:

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

Menggunakan Promises

Berikut adalah contoh untuk setiap method HTTP:

• GET

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

• POST

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

• PUT

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

• DELETE

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

• PATCH

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

• HEAD

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

• OPTIONS

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

Menggunakan Callbacks

Berikut adalah contoh untuk setiap method HTTP:

• GET

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

• POST

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

• PUT

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

• DELETE

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

• PATCH

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

• HEAD

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

• OPTIONS

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

Menggunakan Async/Await

Berikut adalah contoh untuk setiap method HTTP:

• GET

  1async function getData() {
  2  try {
  3    const res = await api.get('/endpoint')
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• POST

  1async function postData() {
  2  try {
  3    const res = await api.post('/endpoint', { key: 'value' })
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• PUT

  1async function putData() {
  2  try {
  3    const res = await api.put('/endpoint', { key: 'value' })
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• DELETE

  1async function deleteData() {
  2  try {
  3    const res = await api.delete('/endpoint')
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• PATCH

  1async function patchData() {
  2  try {
  3    const res = await api.patch('/endpoint', { key: 'value' })
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• HEAD

  1async function headData() {
  2  try {
  3    const res = await api.head('/endpoint')
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

• OPTIONS

  1async function optionsData() {
  2  try {
  3    const res = await api.options('/endpoint')
  4    console.log(res) // Menangani hasil sukses
  5  } catch (err) {
  6    console.error(err) // Menangani kesalahan
  7  }
  8}

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.