@ndiinginc/router v2.2.2

Modules

string

• string
  • .toPascalCase(string) ⇒ string
  • .toCamelCase(string) ⇒ string
  • .toSnakeCase(string) ⇒ string
  • .toKebabCase(string) ⇒ string
  • .toTitleCase(string) ⇒ string

string.toPascalCase(string) ⇒ string

Mengubah string menjadi format PascalCase.

Kind: static method of string
Returns: string - - String dalam format PascalCase.

string.toCamelCase(string) ⇒ string

Mengubah string menjadi format camelCase.

Kind: static method of string
Returns: string - - String dalam format camelCase.

string.toSnakeCase(string) ⇒ string

Mengubah string menjadi format snake_case.

Kind: static method of string
Returns: string - - String dalam format snake_case.

string.toKebabCase(string) ⇒ string

Mengubah string menjadi format kebab-case.

Kind: static method of string
Returns: string - - String dalam format kebab-case.

string.toTitleCase(string) ⇒ string

Mengubah string menjadi format Title Case.

Kind: static method of string
Returns: string - - String dalam format Title Case.

file

• file
  • .read(filename) ⇒ string | null
  • .write(filename, data)

file.read(filename) ⇒ string | null

Membaca konten dari file dengan nama yang diberikan.

Kind: static method of file
Returns: string | null - - Mengembalikan konten file dalam bentuk string atau null jika terjadi kesalahan.

file.write(filename, data)

Menulis data ke file dengan nama yang diberikan. Jika direktori tidak ada, direktori akan dibuat.

Kind: static method of file

resilience

• resilience
  • static
    • .retry(fn, [retries], [delay]) ⇒ Promise.<any>
    • .timeout(fn, ms) ⇒ Promise.<any>
  • inner
    • ~CircuitBreaker
      • new CircuitBreaker([failureThreshold], [resetTimeout])
      • .execute(fn) ⇒ Promise.<any>
      • .reset()
    • ~Bulkhead
      • new Bulkhead(maxRequests)
      • .execute(fn) ⇒ Promise.<any>
      • .processQueue()
    • ~RateLimiter
      • new RateLimiter(maxRequests, interval)
      • .execute(fn) ⇒ Promise.<any>
    • ~Mutex
      • .lock() ⇒ Promise.<void>
      • .unlock()
    • ~Semaphore
      • new Semaphore(max)
      • .acquire() ⇒ Promise.<void>
      • .release()

resilience.retry(fn, retries, delay) ⇒ Promise.<any>

Mencoba menjalankan fungsi secara berulang hingga berhasil atau mencapai batas retry.

Kind: static method of resilience
Returns: Promise.<any> - - Mengembalikan hasil dari fungsi yang berhasil.
Throws:

• Error - Melemparkan kesalahan jika semua percobaan gagal.

resilience.timeout(fn, ms) ⇒ Promise.<any>

Menjalankan fungsi dan mengatur batas waktu. Jika fungsi tidak selesai dalam waktu yang ditentukan, akan melemparkan kesalahan "Timeout".

Kind: static method of resilience
Returns: Promise.<any> - - Mengembalikan hasil dari fungsi jika selesai dalam batas waktu.
Throws:

• Error - Melemparkan kesalahan jika fungsi tidak selesai dalam waktu yang ditentukan.

resilience~CircuitBreaker

Kelas CircuitBreaker untuk mengelola dan melindungi fungsi dari kesalahan yang berulang. Circuit Breaker mencegah fungsi dari pemanggilan berulang ketika kesalahan telah mencapai ambang batas.

Kind: inner class of resilience

• ~CircuitBreaker
  • new CircuitBreaker([failureThreshold], [resetTimeout])
  • .execute(fn) ⇒ Promise.<any>
  • .reset()

new CircuitBreaker(failureThreshold, resetTimeout)

circuitBreaker.execute(fn) ⇒ Promise.<any>

Menjalankan fungsi dan menerapkan circuit breaker. Jika sirkuit terbuka, fungsi tidak akan dieksekusi hingga waktu reset berlalu.

Kind: instance method of CircuitBreaker
Returns: Promise.<any> - - Mengembalikan hasil dari fungsi jika berhasil.
Throws:

• Error - Melemparkan kesalahan jika fungsi gagal atau jika sirkuit terbuka.

circuitBreaker.reset()

Mereset status circuit breaker ke keadaan tertutup dan mengatur ulang hitungan kesalahan.

Kind: instance method of CircuitBreaker

resilience~Bulkhead

Kelas Bulkhead untuk mengelola batas maksimum permintaan yang dapat dieksekusi secara bersamaan. Bulkhead membantu mencegah satu bagian dari aplikasi mempengaruhi bagian lainnya dengan membatasi jumlah permintaan yang dapat diproses dalam waktu bersamaan.

Kind: inner class of resilience

• ~Bulkhead
  • new Bulkhead(maxRequests)
  • .execute(fn) ⇒ Promise.<any>
  • .processQueue()

new Bulkhead(maxRequests)

bulkhead.execute(fn) ⇒ Promise.<any>

Menjalankan fungsi dan mengatur antrian permintaan jika batas maksimum tercapai.

Kind: instance method of Bulkhead
Returns: Promise.<any> - - Mengembalikan hasil dari fungsi jika berhasil.

bulkhead.processQueue()

Memproses antrian permintaan yang menunggu jika ada kapasitas yang tersedia.

Kind: instance method of Bulkhead

resilience~RateLimiter

Kelas RateLimiter untuk membatasi jumlah permintaan yang dapat dilakukan dalam jangka waktu tertentu. Berguna untuk menghindari kelebihan beban pada server atau API.

Kind: inner class of resilience

• ~RateLimiter
  • new RateLimiter(maxRequests, interval)
  • .execute(fn) ⇒ Promise.<any>

new RateLimiter(maxRequests, interval)

rateLimiter.execute(fn) ⇒ Promise.<any>

Menjalankan fungsi jika batas permintaan belum terlampaui.

Kind: instance method of RateLimiter
Returns: Promise.<any> - - Mengembalikan hasil dari fungsi jika batas permintaan belum terlampaui.
Throws:

• Error - Melempar error jika batas permintaan telah terlampaui.

resilience~Mutex

Kelas yang mengimplementasikan mekanisme mutex untuk penguncian sumber daya.

Kind: inner class of resilience

• ~Mutex
  • .lock() ⇒ Promise.<void>
  • .unlock()

mutex.lock() ⇒ Promise.<void>

Mengunci mutex. Jika sudah terkunci, menunggu sampai dapat mengunci.

Kind: instance method of Mutex
Returns: Promise.<void> - - Sebuah promise yang diselesaikan saat mutex terkunci.

mutex.unlock()

Membuka kunci mutex dan memberi kesempatan kepada antrean untuk mengunci.

Kind: instance method of Mutex

resilience~Semaphore

Kelas yang mengimplementasikan mekanisme semaphore untuk pengelolaan akses ke sumber daya.

Kind: inner class of resilience

• ~Semaphore
  • new Semaphore(max)
  • .acquire() ⇒ Promise.<void>
  • .release()

new Semaphore(max)

semaphore.acquire() ⇒ Promise.<void>

Mengakuisisi akses semaphore. Jika sudah mencapai maksimum, menunggu sampai ada akses yang dilepaskan.

Kind: instance method of Semaphore
Returns: Promise.<void> - - Sebuah promise yang diselesaikan saat akses diperoleh.

semaphore.release()

Membebaskan akses semaphore, memberi kesempatan kepada antrean untuk mengakuisisi akses.

Kind: instance method of Semaphore