@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
82 lines (81 loc) • 3.36 kB
TypeScript
/**
* @module CircuitBreaker
*/
import { type Kysely } from "kysely";
import { type ICircuitBreakerStorageAdapter, type ICircuitBreakerStorageAdapterTransaction } from "../../../../circuit-breaker/contracts/circuit-breaker-storage-adapter.contract.js";
import { type ISerde } from "../../../../serde/contracts/serde.contract.js";
import { type IDeinitizable, type IInitizable, type InvokableFn } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storage-adapter"`
* @group Adapters
*/
export type KyselyCircuitBreakerStorageTable = {
key: string;
state: string;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storage-adapter"`
* @group Adapters
*/
export type KyselyCircuitBreakerStorageTables = {
circuitBreaker: KyselyCircuitBreakerStorageTable;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storage-adapter"`
* @group Adapters
*/
export type KyselyCircuitBreakerStorageAdapterSettings = {
kysely: Kysely<KyselyCircuitBreakerStorageTables>;
serde: ISerde<string>;
};
/**
* To utilize the `KyselyCircuitBreakerStorageAdapter`, you must install the [`"kysely"`](https://www.npmjs.com/package/kysely) package and configure a `Kysely` class instance.
*
* Note in order to use `KyselyCircuitBreakerStorageAdapter` correctly, you need to use a database that has support for transactions.
* The adapter have been tested with `sqlite`, `postgres` and `mysql` databases.
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storage-adapter"`
* @group Adapters
*/
export declare class KyselyCircuitBreakerStorageAdapter<TType> implements ICircuitBreakerStorageAdapter, IInitizable, IDeinitizable {
private readonly kysely;
private readonly serde;
/**
* @example
* ```ts
* import { KyselyCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storage-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
* import Sqlite from "better-sqlite3";
* import { Kysely, SqliteDialect } from "kysely";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const circuitBreakerStorageAdapter = new KyselyCircuitBreakerStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde
* });
* // You need initialize the adapter once before using it.
* await circuitBreakerStorageAdapter.init();
* ```
*/
constructor(settings: KyselyCircuitBreakerStorageAdapterSettings);
/**
* Removes all related circuit breaker tables and their rows.
* Note all circuit breaker data will be removed.
*/
deInit(): Promise<void>;
/**
* Creates all related tables and indexes.
* Note the `init` method needs to be called once before using the adapter.
*/
init(): Promise<void>;
transaction<TValue>(fn: InvokableFn<[
transaction: ICircuitBreakerStorageAdapterTransaction
], Promise<TValue>>): Promise<TValue>;
find(key: string): Promise<TType | null>;
remove(key: string): Promise<void>;
}