fix lint

NomicFoundation · Sep 20, 2023 · 298c9f5 · 298c9f5
1 parent 4a59576
commit 298c9f5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/packages/core/src/errors-list.ts b/packages/core/src/errors-list.ts
@@ -1,5 +1,11 @@
 export const ERROR_PREFIX = "IGN";
 
+/**
+ * ErrorDescriptor is a type that describes an error.
+ * It's used to generate error codes and messages.
+ *
+ * @beta
+ */
 export interface ErrorDescriptor {
   number: number;
   // Message can use templates. See applyErrorMessageTemplate

diff --git a/packages/core/src/errors.ts b/packages/core/src/errors.ts
@@ -35,8 +35,10 @@ export class IgnitionError extends Error {
  *  - If a variable is not present in the template, but present in the values
  *    object, an error is thrown.
  *
- * @param template The template string.
- * @param values A map of variable names to their values.
+ * @param template - The template string.
+ * @param values - A map of variable names to their values.
+ *
+ * @beta
  */
 export function applyErrorMessageTemplate(
   template: string,

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,6 +1,7 @@
 export { buildModule } from "./build-module";
 export { deploy } from "./deploy";
 export * from "./errors";
+export { ErrorDescriptor } from "./errors-list";
 export { IgnitionModuleSerializer } from "./ignition-module-serializer";
 export { formatSolidityParameter } from "./internal/formatters";
 export * from "./type-guards";