From 298c9f53a4025ee075752ec64c340a4d38c207fc Mon Sep 17 00:00:00 2001 From: zoeyTM Date: Tue, 19 Sep 2023 21:25:10 -0400 Subject: [PATCH] fix lint --- packages/core/src/errors-list.ts | 6 ++++++ packages/core/src/errors.ts | 6 ++++-- packages/core/src/index.ts | 1 + 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/packages/core/src/errors-list.ts b/packages/core/src/errors-list.ts index 622e86c31..e55aa74cb 100644 --- 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 index 410885f18..66ef944fe 100644 --- 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 index db4dbfeb5..f205abb16 100644 --- 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";