@daiso-tech/core 0.10.0 → 0.11.0

package/dist/types/event-bus/contracts/event-bus.contract.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module EventBus
  */
-import type { LazyPromise } from "../../_module";
+import type { LazyPromise } from "../../utilities/_module";
 import type { OneOrMore } from "../../_shared/types";
 import type { IBaseEvent, Listener } from "../../event-bus/contracts/_shared";
 export type SelectEvent<TEvents extends IBaseEvent, TEventType extends TEvents["type"]> = Extract<TEvents, {
@@ -49,32 +49,38 @@ export type IListenable<TEvents extends IBaseEvent = IBaseEvent> = {
     subscribeMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<Unsubscribe>;
 };
 /**
- * The <i>IEventBus</i> contract defines a way for dispatching and listening to events independent of underlying technology.
- * It commes with more convient methods compared to <i>IEventBusAdapter</i>.
+ * The <i>IDispatcher</i> contract defines a way for dispatching to events independent of underlying technology.
  * @group Contracts
  */
-export type IEventBus<TEvents extends IBaseEvent = IBaseEvent> = IListenable<TEvents> & {
+export type IDispatcher<TEvents extends IBaseEvent = IBaseEvent> = {
     /**
      * The <i>dispatch</i> method is used for dispatching one or multiple <i>events</i>.
 
      * @throws {DispatchEventBusError} {@link DispatchEventBusError}
      */
     dispatch(events: OneOrMore<TEvents>): LazyPromise<void>;
+};
+/**
+ * The <i>IEventBus</i> contract defines a way for dispatching and listening to events independent of underlying technology.
+ * It commes with more convient methods compared to <i>IEventBusAdapter</i>.
+ * @group Contracts
+ */
+export type IEventBus<TEvents extends IBaseEvent = IBaseEvent> = IListenable<TEvents> & IDispatcher<TEvents> & {
     /**
-     * The <i>getNamespace</i> method return the complete namespace.
+     * The <i>getNamespace</i> method returns the complete namespace.
      * @example
      * ```ts
-     *   const eventBus = new EventBus(new MemoryEventBusAdapter(), {
-     *     rootNamespace: "@root/"
-     *   });
+     * import { type IEventBus } from "@daiso-tech/core";
      *
-     *   // Will be "@root/"
+     * async function main(eventBus: IEventBus): Promise<void> {
+     *   // Will be "@root"
      *   console.log(eventBus.getNamespace())
      *
-     *   const eventBusA = eventBus.withNamespace("a/");
+     *   const eventBusA = eventBus.withNamespace("a");
      *
-     *   // Will be "@root/a/"
+     *   // Will be "@root/a"
      *   console.log(eventBusA.getNamespace())
+     * }
      * ```
      */
     getNamespace(): string;
@@ -90,11 +96,9 @@ export type INamespacedEventBus<TEvents extends IBaseEvent = IBaseEvent> = IEven
      * This useful for multitennat applications.
      * @example
      * ```ts
-     * import { EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
-     *
-     * (async () => {
-     *   const eventBus = new EventBus(new MemoryEventBusAdapter());
+     * import { type IEventBus } from "@daiso-tech/core";
      *
+     * async function main(eventBus: IEventBus): Promise<void> {
      *   const eventBusA = eventBus.withNamespace("a");
      *   await eventBusA.subscribe("add", (event) => {
      *     // This will be logged
@@ -112,9 +116,8 @@ export type INamespacedEventBus<TEvents extends IBaseEvent = IBaseEvent> = IEven
      *     a: 1,
      *     b: 2
      *   })
-     * })();
-     *
+     * }
      * ```
      */
-    withNamespace(namespace: string): IEventBus<TEvents>;
+    withNamespace(namespace: OneOrMore<string>): IEventBus<TEvents>;
 };

package/dist/types/event-bus/contracts/event-bus.errors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @module EventBus
+ */
+/**
+ * @group Errors
+ */
+export declare class EventBusError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class UnexpectedEventBusError extends EventBusError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class RemoveListenerEventBusError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class AddListenerEventBusError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class DispatchEventBusError extends Error {
+    constructor(message: string, cause?: unknown);
+}

package/dist/types/event-bus/implementations/_module.d.ts

@@ -1,5 +1,3 @@
 export * from "../../event-bus/implementations/_shared/test-utilities/_module";
-export * from "../../event-bus/implementations/event-bus/_module";
-export * from "../../event-bus/implementations/memory-event-bus-adapter/_module";
-export * from "../../event-bus/implementations/redis-event-bus-adapter/_module";
-export * from "../../event-bus/implementations/no-op-event-bus-adapter/_module";
+export * from "../../event-bus/implementations/derivables/_module";
+export * from "../../event-bus/implementations/adapters/_module";

package/dist/types/event-bus/implementations/adapters/_module.d.ts

@@ -0,0 +1,3 @@
+export * from "../../../event-bus/implementations/adapters/memory-event-bus-adapter/_module";
+export * from "../../../event-bus/implementations/adapters/no-op-event-bus-adapter/_module";
+export * from "../../../event-bus/implementations/adapters/redis-event-bus-adapter/_module";

package/dist/types/event-bus/implementations/adapters/memory-event-bus-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../event-bus/implementations/adapters/memory-event-bus-adapter/_module";

package/dist/types/event-bus/implementations/{memory-event-bus-adapter → adapters/memory-event-bus-adapter}/memory-event-bus-adapter.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module EventBus
  */
-import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../event-bus/contracts/_module";
+import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../../event-bus/contracts/_module";
 import { EventEmitter } from "node:events";
 /**
  * @group Adapters

package/dist/types/event-bus/implementations/adapters/no-op-event-bus-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../event-bus/implementations/adapters/no-op-event-bus-adapter/no-op-event-bus-adapter";

package/dist/types/event-bus/implementations/{no-op-event-bus-adapter → adapters/no-op-event-bus-adapter}/no-op-event-bus-adapter.d.ts

@@ -1,10 +1,10 @@
 /**
  * @module EventBus
  */
-import type { Listener, IBaseEvent } from "../../../_module";
-import type { IEventBusAdapter } from "../../../event-bus/contracts/event-bus-adapter.contract";
+import type { Listener, IBaseEvent } from "../../../../event-bus/contracts/_module";
+import type { IEventBusAdapter } from "../../../../event-bus/contracts/_module";
 /**
- * This <i>NoOpEventBusAdapter</i> will do nothing and is used for easily mocking IEventBus for testing.
+ * This <i>NoOpEventBusAdapter</i> will do nothing and is used for easily mocking {@link IEventBus} for testing.
  * @group Adapters
  */
 export declare class NoOpEventBusAdapter implements IEventBusAdapter {

package/dist/types/event-bus/implementations/adapters/redis-event-bus-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../event-bus/implementations/adapters/memory-event-bus-adapter/_module";

package/dist/types/event-bus/implementations/{redis-event-bus-adapter → adapters/redis-event-bus-adapter}/redis-event-bus-adapter.d.ts

@@ -1,8 +1,8 @@
 /**
  * @module EventBus
  */
-import { type ISerializer } from "../../../serializer/contracts/_module";
-import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../event-bus/contracts/_module";
+import { type ISerializer } from "../../../../serializer/contracts/_module";
+import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../../event-bus/contracts/_module";
 import type Redis from "ioredis";
 /**
  * @group Adapters

package/dist/types/event-bus/implementations/derivables/_module.d.ts

@@ -0,0 +1,2 @@
+export * from "../../../event-bus/implementations/derivables/event-bus";
+export * from "../../../event-bus/implementations/derivables/event-bus-factory";

package/dist/types/event-bus/implementations/derivables/event-bus-factory.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @module EventBus
+ */
+import type { Validator } from "../../../utilities/_module";
+import type { INamespacedEventBus, IEventBusAdapter, IBaseEvent, IEventBusFactory } from "../../../event-bus/contracts/_module";
+/**
+ * @group Derivables
+ */
+export type EventBusDrivers<TAdapters extends string = string> = Partial<Record<TAdapters, IEventBusAdapter>>;
+/**
+ * @group Derivables
+ */
+export type EventBusFactorySettings<TAdapters extends string = string> = {
+    drivers: EventBusDrivers<TAdapters>;
+    defaultDriver?: NoInfer<TAdapters>;
+    rootNamespace?: string;
+};
+/**
+ * @group Derivables
+ * @example
+ * ```ts
+ * import { EventBusFactory } from "@daiso-tech/core";
+ * import Redis from "ioredis"
+ *
+ * const eventBusFactory = new EventBusFactory({
+ *   drivers: {
+ *     memory: new MemoryEventBusAdapter(),
+ *     redis: new RedisEventBusAdapter({
+ *       dispatcherClient: new Redis(),
+ *       listenerClient: new Redis(),
+ *     }),
+ *   },
+ *   defaultDriver: "memory",
+ *   rootNamespace: "@events"
+ * });
+ * ```
+ */
+export declare class EventBusFactory<TAdapters extends string = string, TEvent extends IBaseEvent = IBaseEvent> implements IEventBusFactory<TAdapters> {
+    private readonly drivers;
+    private readonly defaultDriver?;
+    private readonly rootNamespace?;
+    private validator;
+    constructor(settings: EventBusFactorySettings<TAdapters>);
+    use(driverName?: TAdapters | undefined): INamespacedEventBus<TEvent>;
+    withValidation<TOutput extends IBaseEvent = IBaseEvent>(validator: Validator<TOutput>): IEventBusFactory<TAdapters, TOutput>;
+    withType<TOutput extends IBaseEvent = IBaseEvent>(): IEventBusFactory<TAdapters, TOutput>;
+}

package/dist/types/event-bus/implementations/{event-bus → derivables}/event-bus.d.ts

@@ -18,11 +18,12 @@ export type EventBusSettings<TEvents extends IBaseEvent> = {
      * ```ts
      * import { EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
      *
-     * const eventBusA = new EventBus(new MemoryEventBusAdapter(), {
-     *   rootNamespace: "@a/"
+     * const memoryEventBusAdapter = new MemoryEventBusAdapter();
+     * const eventBusA = new EventBus(memoryEventBusAdapter, {
+     *   rootNamespace: "@a"
      * });
-     * const eventBusB = new EventBus(new MemoryEventBusAdapter(), {
-     *   rootNamespace: "@b/"
+     * const eventBusB = new EventBus(memoryEventBusAdapter, {
+     *   rootNamespace: "@b"
      * });
      *
      * (async () => {
@@ -42,7 +43,7 @@ export type EventBusSettings<TEvents extends IBaseEvent> = {
      * })();
      * ```
      */
-    rootNamespace?: string;
+    rootNamespace?: OneOrMore<string>;
     /**
      * You can pass a custom <i>{@link Validator}</i> to validate, transform and sanitize your data.
      * You could also use <i>{@link zodValidator}</i> which enables you to use zod for validating, transforming, and sanitizing.
@@ -87,10 +88,10 @@ export type EventBusSettings<TEvents extends IBaseEvent> = {
  */
 export declare class EventBus<TEvents extends IBaseEvent = IBaseEvent> implements INamespacedEventBus<TEvents> {
     private readonly eventBusAdapter;
-    private readonly namespace_;
+    private readonly namespace;
     private readonly validator;
     constructor(eventBusAdapter: IEventBusAdapter, settings?: EventBusSettings<TEvents>);
-    withNamespace(namespace: string): IEventBus<TEvents>;
+    withNamespace(namespace: OneOrMore<string>): IEventBus<TEvents>;
     getNamespace(): string;
     addListener<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
     addListenerMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;

package/dist/types/serializer/contracts/_module.d.ts

@@ -1 +1,2 @@
 export * from "../../serializer/contracts/serializer.contract";
+export * from "../../serializer/contracts/serializer.errors";

package/dist/types/serializer/contracts/serializer.contract.d.ts

@@ -1,24 +1,6 @@
 /**
  * @module Serializer
  */
-/**
- * @group Errors
- */
-export declare class SerializerError extends Error {
-    constructor(message: string, cause?: unknown);
-}
-/**
- * @group Errors
- */
-export declare class SerializationError extends SerializerError {
-    constructor(message: string, cause?: unknown);
-}
-/**
- * @group Errors
- */
-export declare class DeserializationError extends SerializerError {
-    constructor(message: string, cause?: unknown);
-}
 /**
  * @group Contracts
  */

package/dist/types/serializer/contracts/serializer.errors.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @module Serializer
+ */
+/**
+ * @group Errors
+ */
+export declare class SerializerError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class SerializationError extends SerializerError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class DeserializationError extends SerializerError {
+    constructor(message: string, cause?: unknown);
+}

package/dist/types/storage/contracts/_module.d.ts

@@ -1,5 +1,5 @@
-export * from "../../storage/contracts/_shared";
-export * from "../../storage/contracts/storage.contract";
 export * from "../../storage/contracts/storage-adapter.contract";
-export * from "../../storage/contracts/storage-events.contract";
-export * from "../../storage/contracts/storage-manager.contract";
+export * from "../../storage/contracts/storage-factory.contract";
+export * from "../../storage/contracts/storage.contract";
+export * from "../../storage/contracts/storage.errors";
+export * from "../../storage/contracts/storage.events";

package/dist/types/storage/contracts/storage-adapter.contract.d.ts

@@ -8,28 +8,28 @@
  */
 export type IStorageAdapter<TType = unknown> = {
     /**
-     * The <i>getMany</i> returns the value for the <i>keys</i> that are found otherwise null will be returned.
+     * The <i>get</i> returns the value of <i>keys</i> that are found otherwise null will be returned.
      */
-    getMany<TKeys extends string>(keys: TKeys[]): PromiseLike<Record<TKeys, TType | null>>;
+    get(key: string): PromiseLike<TType | null>;
     /**
-     * The <i>addMany</i> method adds the keys that doesn't exists. Returns true for the keys that doesn't exists otherwise false will be returned.
+     * The <i>add</i> method add a new <i>key</i>. Returns true if the <i>key</i> where added otherwise false will be returned.
      */
-    addMany<TKeys extends string>(values: Record<TKeys, TType>): PromiseLike<Record<TKeys, boolean>>;
+    add(key: string, value: TType): PromiseLike<boolean>;
     /**
-     * The <i>updateMany</i> method updates the given keys. Returns true for the keys that exists otherwise false will be returned.
+     * The <i>update</i> method updates a <i>key</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
      */
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): PromiseLike<Record<TKeys, boolean>>;
+    update(key: string, value: TType): PromiseLike<boolean>;
     /**
-     * The <i>putMany</i> method replaces the keys that are found. Adds keys that are not found. Returns true for all the keys that are found otherwise false is returned.
+     * The <i>put</i> method replaces a <i>key</i> that exists or adds <i>key</i> that do not exists. Return true if the <i>key</i> where updated otherwise false is returned.
      */
-    putMany<TKeys extends string>(values: Record<TKeys, TType>): PromiseLike<Record<TKeys, boolean>>;
+    put(key: string, value: TType): PromiseLike<boolean>;
     /**
-     * The <i>removesMany</i> method removes the keys that are found. Returns true for the keys that are found otherwise false is returned.
+     * The <i>remove</i> method removes a <i>key</i>. Returns true if the <i>key</i> is removed otherwise false is returned.
      */
-    removeMany<TKeys extends string>(keys: TKeys[]): PromiseLike<Record<TKeys, boolean>>;
+    remove(key: string): PromiseLike<boolean>;
     /**
      * The <i>increment</i> method will increment the given <i>key</i> if found otherwise nonthing will occur.
-     * Returns true if key exists otherwise false will be returned.
+     * Returns true if key is incremented otherwise false will be returned.
      * An error will thrown if the key is not a number.
      * @throws {TypeStorageError} {@link TypeStorageError}
      */

package/dist/types/storage/contracts/storage-factory.contract.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @module Storage
+ */
+import type { Validator } from "../../utilities/_module";
+import type { INamespacedStorage } from "../../storage/contracts/storage.contract";
+/**
+ * The <i>IStorageFactory</i> contract makes it easy to configure and switch between different <i>{@link INamespacedStorage}</i> dynamically.
+ * @group Contracts
+ */
+export type IStorageFactory<TDrivers extends string = string, TType = unknown> = {
+    /**
+     * The <i>use</i> method will throw an error if you provide it unregisted driver.
+     * If no default driver is defined an error will be thrown by <i>use</i> method.
+     * @throws {UnregisteredDriverError} {@link UnregisteredDriverError}
+     * @throws {DefaultDriverNotDefinedError} {@link DefaultDriverNotDefinedError}
+     * @example
+     * ```ts
+     * import { type IStorageFactory } from "@daiso-tech/core";
+     *
+     * async function main(storageFactory: IStorageFactory): Promise<void> {
+     *   // Will add key using the default driver which is the memory addapter
+     *   await storageFactory
+     *     .use()
+     *     .add("a", 1);
+     *   // Will add key using the redis addapter
+     *   await storageFactory
+     *     .use("redis")
+     *     .add("a", 1);
+     * }
+     * ```
+     */
+    use(driverName?: TDrivers): INamespacedStorage<TType>;
+    /**
+     * The <i>withValidation</i> method is used to set a <i>validator</i>, which validates the storage values during runtime.
+     * The type is inferred from the provided <i>validator</i>.
+     * @example
+     * ```ts
+     * import { type IStorageFactory, zodValidator } from "@daiso-tech/core";
+     * import { z } from "zod"
+     *
+     * async function main(storageFactory: IStorageFactory): Promise<void> {
+     *   await storageFactory
+     *     .withValidation(zodValidator(z.string()))
+     *     .use()
+     *     // You will se an typescript error and get runtime erorr
+     *     .add("a", 1);
+     * }
+     * ```
+     */
+    withValidation<TOutput extends TType = TType>(validator: Validator<TOutput>): IStorageFactory<TDrivers, TOutput>;
+    /**
+     * The <i>withTypes</i> method is used to set the value types of the storage.
+     * @example
+     * ```ts
+     * import { type IStorageFactory zodValidator } from "@daiso-tech/core";
+     *
+     * async function main(storageFactory: IStorageFactory): Promise<void> {
+     *   await storageFactory
+     *     .withTypes<string>()
+     *     .use()
+     *     // You will se an typescript error
+     *     .add("a", 1)
+     * }
+     * ```
+     */
+    withType<TOutput extends TType = TType>(): IStorageFactory<TDrivers, TOutput>;
+};

package/dist/types/storage/contracts/storage.contract.d.ts

@@ -2,10 +2,10 @@
  * @module Storage
  */
 import type { IListenable } from "../../event-bus/contracts/_module";
-import { type AnyFunction, type AsyncLazyable, type GetOrAddValue } from "../../_shared/types";
+import type { OneOrMore } from "../../_shared/types";
+import { type AsyncLazyable, type GetOrAddValue } from "../../_shared/types";
 import type { AllStorageEvents } from "../../storage/contracts/_module";
-import type { LazyPromise } from "../../_module";
-export type StorageValue<T> = Exclude<T, AnyFunction | undefined | null>;
+import type { LazyPromise } from "../../utilities/_module";
 /**
  * The <i>IStorageListenable</i> contract defines a way for listening <i>{@link IStorage}</i> crud operations.
  */
@@ -66,19 +66,19 @@ export type IStorage<TType = unknown> = IStorageListenable & {
      * The <i>add</i> method adds a <i>key</i> with given <i>value</i> when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
-    add(key: string, value: StorageValue<TType>): LazyPromise<boolean>;
+    add(key: string, value: TType): LazyPromise<boolean>;
     /**
-     * The <i>addMany</i> method adds the keys that doesn't exists. Returns true for the keys that doesn't exists otherwise false will be returned.
+     * The <i>addMany</i> method adds new keys. Returns true for the keys that where added otherwise false will be returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
-    addMany<TKeys extends string>(values: Record<TKeys, StorageValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
+    addMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, boolean>>;
     /**
      * The <i>update</i> method updates the given <i>key</i> with given <i>value</i>. Returns true when key otherwise false will be returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
     update(key: string, value: TType): LazyPromise<boolean>;
     /**
-     * The <i>updateMany</i> method updates the given keys. Returns true for the keys that exists otherwise false will be returned.
+     * The <i>updateMany</i> method updates the given keys. Returns true for the keys that where updated otherwise false will be returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
     updateMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, boolean>>;
@@ -86,19 +86,19 @@ export type IStorage<TType = unknown> = IStorageListenable & {
      * The <i>put</i> method replaces the key with given <i>value</i> if found. If the <i>key</i> is not found it will just be added. True is returned if the key is found otherwise false will be returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
-    put(key: string, value: StorageValue<TType>): LazyPromise<boolean>;
+    put(key: string, value: TType): LazyPromise<boolean>;
     /**
-     * The <i>putMany</i> method replaces the keys that are found. Adds keys that are not found. Returns true for all the keys that are found otherwise false is returned.
+     * The <i>putMany</i> method replaces the keys that exists. Adds keys that do not exists. Return true for all the keys that where updated otherwise false is returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
-    putMany<TKeys extends string>(values: Record<TKeys, StorageValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
+    putMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, boolean>>;
     /**
      * The <i>remove</i> method removes the given <i>key</i> when found. Returns true if the key is found otherwise false is returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
     remove(key: string): LazyPromise<boolean>;
     /**
-     * The <i>removesMany</i> method removes the keys that are found. Returns true for the keys that are found otherwise false is returned.
+     * The <i>removeMany</i> method removes keys. Returns true for the keys that are removed otherwise false is returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
     removeMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
@@ -111,10 +111,10 @@ export type IStorage<TType = unknown> = IStorageListenable & {
      * The <i>getOrAdd</i> method will retrieve the given <i>key</i> if found otherwise <i>valueToAdd</i> will be added and returned.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      */
-    getOrAdd(key: string, valueToAdd: AsyncLazyable<StorageValue<GetOrAddValue<TType>>>): LazyPromise<TType>;
+    getOrAdd(key: string, valueToAdd: AsyncLazyable<GetOrAddValue<TType>>): LazyPromise<TType>;
     /**
      * The <i>increment</i> method will increment the given <i>key</i> if found otherwise nonthing will occur.
-     * Returns true if key exists otherwise false will be returned.
+     * Returns true if key is incremented otherwise false will be returned.
      * An error will thrown if the key is not a number.
      * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
      * @throws {TypeStorageError} {@link TypeStorageError}
@@ -135,20 +135,20 @@ export type IStorage<TType = unknown> = IStorageListenable & {
      */
     clear(): LazyPromise<void>;
     /**
-     * The <i>getNamespace</i> method return the complete namespace.
+     * The <i>getNamespace</i> method returns the complete namespace.
      * @example
      * ```ts
-     *   const storage = new Storage(new MemoryStorageAdapter(), {
-     *     rootNamespace: "@root/"
-     *   });
+     * import type { IStorage } from "@daiso-tech/core";
      *
-     *   // Will be "@root/"
+     * async function main(storage: IStorage) {
+     *   // Will be "@root"
      *   console.log(storage.getNamespace())
      *
-     *   const storageA = storage.withNamespace("a/");
+     *   const storageA = storage.withNamespace("a");
      *
-     *   // Will be "@root/a/"
+     *   // Will be "@root/a"
      *   console.log(storageA.getNamespace())
+     * }
      * ```
      */
     getNamespace(): string;
@@ -164,11 +164,9 @@ export type INamespacedStorage<TType = unknown> = IStorage<TType> & {
      * This useful for multitennat applications.
      * @example
      * ```ts
-     * import { Storage, MemoryStorageAdapter } from "@daiso-tech/core";
-     *
-     * (async () => {
-     *   const storage = new Storage(new MemoryStorageAdapter());
+     * import { type IStorage } from "@daiso-tech/core";
      *
+     * async function main(storage: IStorage): Promise<void> {
      *   const storageA = storage.withNamespace("a");
      *   await storageA.add("a", 1);
      *
@@ -177,9 +175,8 @@ export type INamespacedStorage<TType = unknown> = IStorage<TType> & {
      *
      *   // Will print { a: 1, b: null }
      *   console.log(await storageA.getMany(["a", "b"]));
-     * })();
-     *
+     * }
      * ```
      */
-    withNamespace(namespace: string): IStorage<TType>;
+    withNamespace(namespace: OneOrMore<string>): IStorage<TType>;
 };