Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ndiing/util

Kumpulan kelas dan fungsi utilitas untuk pengelolaan fungsi asinkron di JavaScript, termasuk mekanisme penguncian, kontrol akses, dan format string.
https://github.com/ndiing/util
async bulkhead circuit-breaker mutex rate-limiter semaphore utility
Last synced: 9 days ago
JSON representation
Kumpulan kelas dan fungsi utilitas untuk pengelolaan fungsi asinkron di JavaScript, termasuk mekanisme penguncian, kontrol akses, dan format string.
Host: GitHub
URL: https://github.com/ndiing/util
Owner: ndiing
License: mit
Created: 2024-10-13T20:22:32.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-10-18T12:31:08.000Z (4 months ago)
Last Synced: 2024-12-01T15:24:56.025Z (2 months ago)
Topics: async, bulkhead, circuit-breaker, mutex, rate-limiter, semaphore, utility
Language: JavaScript
Homepage: https://www.npmjs.com/package/@ndiinginc/util
Size: 33.2 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        ## Modules



string



file



resilience







## string

* [string](#module_string)

    * [.toPascalCase(string)](#module_string.toPascalCase) ⇒ string

    * [.toCamelCase(string)](#module_string.toCamelCase) ⇒ string

    * [.toSnakeCase(string)](#module_string.toSnakeCase) ⇒ string

    * [.toKebabCase(string)](#module_string.toKebabCase) ⇒ string

    * [.toTitleCase(string)](#module_string.toTitleCase) ⇒ string



### string.toPascalCase(string) ⇒ string

Mengubah string menjadi format PascalCase.

**Kind**: static method of [string](#module_string)  

**Returns**: string - - String dalam format PascalCase.  

| Param | Type | Description |

| --- | --- | --- |

| string | string | String input yang akan diubah. |



### string.toCamelCase(string) ⇒ string

Mengubah string menjadi format camelCase.

**Kind**: static method of [string](#module_string)  

**Returns**: string - - String dalam format camelCase.  

| Param | Type | Description |

| --- | --- | --- |

| string | string | String input yang akan diubah. |



### string.toSnakeCase(string) ⇒ string

Mengubah string menjadi format snake_case.

**Kind**: static method of [string](#module_string)  

**Returns**: string - - String dalam format snake_case.  

| Param | Type | Description |

| --- | --- | --- |

| string | string | String input yang akan diubah. |



### string.toKebabCase(string) ⇒ string

Mengubah string menjadi format kebab-case.

**Kind**: static method of [string](#module_string)  

**Returns**: string - - String dalam format kebab-case.  

| Param | Type | Description |

| --- | --- | --- |

| string | string | String input yang akan diubah. |



### string.toTitleCase(string) ⇒ string

Mengubah string menjadi format Title Case.

**Kind**: static method of [string](#module_string)  

**Returns**: string - - String dalam format Title Case.  

| Param | Type | Description |

| --- | --- | --- |

| string | string | String input yang akan diubah. |



## file

* [file](#module_file)

    * [.read(filename)](#module_file.read) ⇒ string \| null

    * [.write(filename, data)](#module_file.write)



### file.read(filename) ⇒ string \| null

Membaca konten dari file dengan nama yang diberikan.

**Kind**: static method of [file](#module_file)  

**Returns**: string \| null - - Mengembalikan konten file dalam bentuk string atau `null` jika terjadi kesalahan.  

| Param | Type | Description |

| --- | --- | --- |

| filename | string | Nama file yang akan dibaca. |



### file.write(filename, data)

Menulis data ke file dengan nama yang diberikan.

Jika direktori tidak ada, direktori akan dibuat.

**Kind**: static method of [file](#module_file)  

| Param | Type | Description |

| --- | --- | --- |

| filename | string | Nama file di mana data akan ditulis. |

| data | string | Konten yang akan ditulis ke file. |



## resilience

* [resilience](#module_resilience)

    * _static_

        * [.retry(fn, [retries], [delay])](#module_resilience.retry) ⇒ Promise.<any>

        * [.timeout(fn, ms)](#module_resilience.timeout) ⇒ Promise.<any>

    * _inner_

        * [~CircuitBreaker](#module_resilience..CircuitBreaker)

            * [new CircuitBreaker([failureThreshold], [resetTimeout])](#new_module_resilience..CircuitBreaker_new)

            * [.execute(fn)](#module_resilience..CircuitBreaker+execute) ⇒ Promise.<any>

            * [.reset()](#module_resilience..CircuitBreaker+reset)

        * [~Bulkhead](#module_resilience..Bulkhead)

            * [new Bulkhead(maxRequests)](#new_module_resilience..Bulkhead_new)

            * [.execute(fn)](#module_resilience..Bulkhead+execute) ⇒ Promise.<any>

            * [.processQueue()](#module_resilience..Bulkhead+processQueue)

        * [~RateLimiter](#module_resilience..RateLimiter)

            * [new RateLimiter(maxRequests, interval)](#new_module_resilience..RateLimiter_new)

            * [.execute(fn)](#module_resilience..RateLimiter+execute) ⇒ Promise.<any>

        * [~Mutex](#module_resilience..Mutex)

            * [.lock()](#module_resilience..Mutex+lock) ⇒ Promise.<void>

            * [.unlock()](#module_resilience..Mutex+unlock)

        * [~Semaphore](#module_resilience..Semaphore)

            * [new Semaphore(max)](#new_module_resilience..Semaphore_new)

            * [.acquire()](#module_resilience..Semaphore+acquire) ⇒ Promise.<void>

            * [.release()](#module_resilience..Semaphore+release)



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

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

**Kind**: static method of [resilience](#module_resilience)  

**Returns**: Promise.<any> - - Mengembalikan hasil dari fungsi yang berhasil.  

**Throws**:

- Error - Melemparkan kesalahan jika semua percobaan gagal.

| Param | Type | Default | Description |

| --- | --- | --- | --- |

| fn | function |  | Fungsi yang akan dicoba. Harus mengembalikan sebuah promise. |

| [retries] | number | 3 | Jumlah maksimum percobaan sebelum melemparkan kesalahan. |

| [delay] | number | 1000 | Waktu dalam milidetik untuk menunggu sebelum mencoba lagi setelah 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](#module_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.

| Param | Type | Description |

| --- | --- | --- |

| fn | function | Fungsi yang akan dijalankan. Harus mengembalikan sebuah promise. |

| ms | number | Waktu maksimum dalam milidetik sebelum timeout. |



### 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](#module_resilience)  

* [~CircuitBreaker](#module_resilience..CircuitBreaker)

    * [new CircuitBreaker([failureThreshold], [resetTimeout])](#new_module_resilience..CircuitBreaker_new)

    * [.execute(fn)](#module_resilience..CircuitBreaker+execute) ⇒ Promise.<any>

    * [.reset()](#module_resilience..CircuitBreaker+reset)



#### new CircuitBreaker([failureThreshold], [resetTimeout])

| Param | Type | Default | Description |

| --- | --- | --- | --- |

| [failureThreshold] | number | 3 | Ambang batas jumlah kesalahan sebelum sirkuit terbuka. |

| [resetTimeout] | number | 5000 | Waktu dalam milidetik sebelum sirkuit setengah terbuka setelah terbuka. |



#### 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](#module_resilience..CircuitBreaker)  

**Returns**: Promise.<any> - - Mengembalikan hasil dari fungsi jika berhasil.  

**Throws**:

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

| Param | Type | Description |

| --- | --- | --- |

| fn | function | Fungsi yang akan dijalankan. Harus mengembalikan sebuah promise. |



#### circuitBreaker.reset()

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

**Kind**: instance method of [CircuitBreaker](#module_resilience..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](#module_resilience)  

* [~Bulkhead](#module_resilience..Bulkhead)

    * [new Bulkhead(maxRequests)](#new_module_resilience..Bulkhead_new)

    * [.execute(fn)](#module_resilience..Bulkhead+execute) ⇒ Promise.<any>

    * [.processQueue()](#module_resilience..Bulkhead+processQueue)



#### new Bulkhead(maxRequests)

| Param | Type | Description |

| --- | --- | --- |

| maxRequests | number | Jumlah maksimum permintaan yang dapat diproses secara bersamaan. |



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

Menjalankan fungsi dan mengatur antrian permintaan jika batas maksimum tercapai.

**Kind**: instance method of [Bulkhead](#module_resilience..Bulkhead)  

**Returns**: Promise.<any> - - Mengembalikan hasil dari fungsi jika berhasil.  

| Param | Type | Description |

| --- | --- | --- |

| fn | function | Fungsi yang akan dijalankan. Harus mengembalikan sebuah promise. |



#### bulkhead.processQueue()

Memproses antrian permintaan yang menunggu jika ada kapasitas yang tersedia.

**Kind**: instance method of [Bulkhead](#module_resilience..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](#module_resilience)  

* [~RateLimiter](#module_resilience..RateLimiter)

    * [new RateLimiter(maxRequests, interval)](#new_module_resilience..RateLimiter_new)

    * [.execute(fn)](#module_resilience..RateLimiter+execute) ⇒ Promise.<any>



#### new RateLimiter(maxRequests, interval)

| Param | Type | Description |

| --- | --- | --- |

| maxRequests | number | Jumlah maksimum permintaan yang diizinkan dalam interval waktu. |

| interval | number | Interval waktu dalam milidetik untuk membatasi permintaan. |



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

Menjalankan fungsi jika batas permintaan belum terlampaui.

**Kind**: instance method of [RateLimiter](#module_resilience..RateLimiter)  

**Returns**: Promise.<any> - - Mengembalikan hasil dari fungsi jika batas permintaan belum terlampaui.  

**Throws**:

- Error - Melempar error jika batas permintaan telah terlampaui.

| Param | Type | Description |

| --- | --- | --- |

| fn | function | Fungsi yang akan dijalankan. Harus mengembalikan sebuah promise. |



### resilience~Mutex

Kelas yang mengimplementasikan mekanisme mutex untuk penguncian sumber daya.

**Kind**: inner class of [resilience](#module_resilience)  

* [~Mutex](#module_resilience..Mutex)

    * [.lock()](#module_resilience..Mutex+lock) ⇒ Promise.<void>

    * [.unlock()](#module_resilience..Mutex+unlock)



#### mutex.lock() ⇒ Promise.<void>

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

**Kind**: instance method of [Mutex](#module_resilience..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](#module_resilience..Mutex)  



### resilience~Semaphore

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

**Kind**: inner class of [resilience](#module_resilience)  

* [~Semaphore](#module_resilience..Semaphore)

    * [new Semaphore(max)](#new_module_resilience..Semaphore_new)

    * [.acquire()](#module_resilience..Semaphore+acquire) ⇒ Promise.<void>

    * [.release()](#module_resilience..Semaphore+release)



#### new Semaphore(max)

| Param | Type | Description |

| --- | --- | --- |

| max | number | Jumlah maksimum akses yang diizinkan pada satu waktu. |



#### semaphore.acquire() ⇒ Promise.<void>

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

**Kind**: instance method of [Semaphore](#module_resilience..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](#module_resilience..Semaphore)