@eik/core 2.1.46 → 2.1.47

package/types/sinks/test.d.ts

@@ -3,31 +3,44 @@
  */
 export default class SinkTest extends Sink {
     constructor({ rootPath }?: {
-        rootPath?: string;
+        rootPath?: string | undefined;
     });
     readDelay: number;
     _rootPath: string;
     _metrics: Metrics;
     _state: Map<any, any>;
     _counter: Metrics.MetricsCounter;
-    _writeDelayResolve: (a: any) => number;
-    _writeDelayChunks: (a: any) => number;
-    set(filePath: any, payload: any): void;
-    get(filePath: any): any;
+    /** @type {(count?: number) => number} */
+    _writeDelayResolve: (count?: number) => number;
+    /** @type {(count?: number) => number} */
+    _writeDelayChunks: (count?: number) => number;
+    /**
+     * @param {string} filePath
+     * @param {any} payload
+     */
+    set(filePath: string, payload: any): void;
+    /**
+     * @param {string} filePath
+     */
+    get(filePath: string): any;
     dump(): [any, any][];
+    /**
+     * @param {any} items
+     */
     load(items: any): void;
     /**
-     * @param {(count: number) => number} fn
+     * @param {(count?: number) => number} fn
+     */
+    set writeDelayResolve(fn: (count?: number) => number);
+    /**
+     * @param {(count?: number) => number} fn
      */
-    set writeDelayResolve(fn: (count: number) => number);
+    set writeDelayChunks(fn: (count?: number) => number);
     /**
-     * @param {(count: number) => number} fn
+     * @param {string} filePath
+     * @param {string} contentType
      */
-    set writeDelayChunks(fn: (count: number) => number);
-    write(filePath: any, contentType: any): Promise<any>;
-    read(filePath: any): Promise<any>;
-    delete(filePath: any): Promise<any>;
-    exist(filePath: any): Promise<any>;
+    write(filePath: string, contentType: string): Promise<any>;
 }
 import Sink from "@eik/sink";
 import Metrics from "@metrics/client";

package/types/utils/healthcheck.d.ts

@@ -1,6 +1,6 @@
 export default HealthCheck;
 export type HealthCheckOptions = {
-    sink?: import("@eik/sink").default;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -10,11 +10,13 @@ export type HealthCheckOptions = {
  */
 declare const HealthCheck: {
     new ({ sink, logger }?: HealthCheckOptions): {
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _name: string;
         _log: abslog.ValidLogger;
-        _write(): Promise<any>;
-        _read(): Promise<any>;
+        /** @returns {Promise<void>} */
+        _write(): Promise<void>;
+        /** @returns {Promise<void>} */
+        _read(): Promise<void>;
         _delete(): Promise<void>;
         _exist(): Promise<void>;
         check(): Promise<boolean>;

package/types/utils/path-builders-fs.d.ts

@@ -1,41 +1,41 @@
 export function createFilePathToPackage({ org, type, name, version, }?: {
-    org?: string;
-    type?: string;
-    name?: string;
-    version?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;
 export function createFilePathToAsset({ org, type, name, version, asset, }?: {
-    org?: string;
-    type?: string;
-    name?: string;
-    version?: string;
-    asset?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
+    asset?: string | undefined;
 }): string;
 export function createFilePathToImportMap({ org, name, version, }?: {
-    org?: string;
-    name?: string;
-    version?: string;
+    org?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;
 export function createFilePathToAlias({ org, type, name, alias, }?: {
-    org?: string;
-    type?: string;
-    name?: string;
-    alias?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
+    alias?: string | undefined;
 }): string;
 export function createFilePathToVersion({ org, type, name }?: {
-    org?: string;
-    type?: string;
-    name?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
 }): string;
 export function createFilePathToAliasOrigin({ org, type, name, version, }?: {
-    org?: string;
-    type?: string;
-    name?: string;
-    version?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;
 export function createFilePathToEikJson({ org, type, name, version, }?: {
-    org?: string;
-    type?: string;
-    name?: string;
-    version?: string;
+    org?: string | undefined;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;

package/types/utils/path-builders-uri.d.ts

@@ -1,26 +1,26 @@
 export function createURIPathToPkgLog({ type, name, version }?: {
-    type?: string;
-    name?: string;
-    version?: string;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;
 export function createURIPathToAsset({ type, name, version, asset, }?: {
-    type?: string;
-    name?: string;
-    version?: string;
-    asset?: string;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
+    asset?: string | undefined;
 }): string;
 export function createURIPathToImportMap({ name, version }?: {
-    name?: string;
-    version?: string;
+    name?: string | undefined;
+    version?: string | undefined;
 }): string;
 export function createURIToAlias({ type, name, alias }?: {
-    type?: string;
-    name?: string;
-    alias?: string;
+    type?: string | undefined;
+    name?: string | undefined;
+    alias?: string | undefined;
 }): string;
 export function createURIToTargetOfAlias({ type, name, version, extra, }?: {
-    type?: string;
-    name?: string;
-    version?: string;
-    extra?: string;
+    type?: string | undefined;
+    name?: string | undefined;
+    version?: string | undefined;
+    extra?: string | undefined;
 }): string;

package/types/utils/utils.d.ts

@@ -1,6 +1,29 @@
-export function readJSON(sink: any, path: any): Promise<any>;
-export function writeJSON(sink: any, path: any, obj: any, contentType: any): Promise<any>;
+/**
+ * @param {any} sink
+ * @param {string} path
+ */
+export function readJSON(sink: any, path: string): Promise<any>;
+/**
+ * @param {any} sink
+ * @param {string} path
+ * @param {any} obj
+ * @param {string} contentType
+ */
+export function writeJSON(sink: any, path: string, obj: any, contentType: string): Promise<any>;
+/**
+ * @param {any} from
+ */
 export function streamCollector(from: any): Promise<any>;
+/**
+ * @param {any} stat
+ */
 export function etagFromFsStat(stat: any): string;
+/**
+ * @param {any} value
+ */
 export function decodeUriComponent(value: any): any;
-export function readEikJson(sink: any, path: any): any;
+/**
+ * @param {any} sink
+ * @param {string} path
+ */
+export function readEikJson(sink: any, path: string): any;