core/errors

Interfaces

ErrorInfo

Defined in: venpm/src/core/errors.ts:1

Properties

candidates?

optional candidates?: string[];

Defined in: venpm/src/core/errors.ts:5

code

code: string;

Defined in: venpm/src/core/errors.ts:2

docsUrl?

optional docsUrl?: string;

Defined in: venpm/src/core/errors.ts:6

message

message: string;

Defined in: venpm/src/core/errors.ts:3

suggestion?

optional suggestion?: string;

Defined in: venpm/src/core/errors.ts:4

Type Aliases

ErrorCodeValue

type ErrorCodeValue = typeof ErrorCode[keyof typeof ErrorCode];

Defined in: venpm/src/core/errors.ts:25

Variables

ErrorCode

const ErrorCode: {
  BUILD_FAILED: "BUILD_FAILED";
  CIRCULAR_DEPENDENCY: "CIRCULAR_DEPENDENCY";
  DISCORD_NOT_FOUND: "DISCORD_NOT_FOUND";
  GIT_NOT_AVAILABLE: "GIT_NOT_AVAILABLE";
  NON_INTERACTIVE: "NON_INTERACTIVE";
  PLUGIN_AMBIGUOUS: "PLUGIN_AMBIGUOUS";
  PLUGIN_NOT_FOUND: "PLUGIN_NOT_FOUND";
  PLUGIN_NOT_INSTALLED: "PLUGIN_NOT_INSTALLED";
  PNPM_NOT_AVAILABLE: "PNPM_NOT_AVAILABLE";
  REPO_FETCH_FAILED: "REPO_FETCH_FAILED";
  SCHEMA_INVALID: "SCHEMA_INVALID";
  VENCORD_NOT_FOUND: "VENCORD_NOT_FOUND";
  VERSION_NOT_FOUND: "VERSION_NOT_FOUND";
};

Defined in: venpm/src/core/errors.ts:9

Type Declaration

BUILD_FAILED

readonly BUILD_FAILED: "BUILD_FAILED" = "BUILD_FAILED";

CIRCULAR_DEPENDENCY

readonly CIRCULAR_DEPENDENCY: "CIRCULAR_DEPENDENCY" = "CIRCULAR_DEPENDENCY";

DISCORD_NOT_FOUND

readonly DISCORD_NOT_FOUND: "DISCORD_NOT_FOUND" = "DISCORD_NOT_FOUND";

GIT_NOT_AVAILABLE

readonly GIT_NOT_AVAILABLE: "GIT_NOT_AVAILABLE" = "GIT_NOT_AVAILABLE";

NON_INTERACTIVE

readonly NON_INTERACTIVE: "NON_INTERACTIVE" = "NON_INTERACTIVE";

PLUGIN_AMBIGUOUS

readonly PLUGIN_AMBIGUOUS: "PLUGIN_AMBIGUOUS" = "PLUGIN_AMBIGUOUS";

PLUGIN_NOT_FOUND

readonly PLUGIN_NOT_FOUND: "PLUGIN_NOT_FOUND" = "PLUGIN_NOT_FOUND";

PLUGIN_NOT_INSTALLED

readonly PLUGIN_NOT_INSTALLED: "PLUGIN_NOT_INSTALLED" = "PLUGIN_NOT_INSTALLED";

PNPM_NOT_AVAILABLE

readonly PNPM_NOT_AVAILABLE: "PNPM_NOT_AVAILABLE" = "PNPM_NOT_AVAILABLE";

REPO_FETCH_FAILED

readonly REPO_FETCH_FAILED: "REPO_FETCH_FAILED" = "REPO_FETCH_FAILED";

SCHEMA_INVALID

readonly SCHEMA_INVALID: "SCHEMA_INVALID" = "SCHEMA_INVALID";

VENCORD_NOT_FOUND

readonly VENCORD_NOT_FOUND: "VENCORD_NOT_FOUND" = "VENCORD_NOT_FOUND";

VERSION_NOT_FOUND

readonly VERSION_NOT_FOUND: "VERSION_NOT_FOUND" = "VERSION_NOT_FOUND";

---

ExitCode

const ExitCode: {
  COMMAND_ERROR: 1;
  ENV_ERROR: 3;
  SUCCESS: 0;
  USAGE_ERROR: 2;
};

Defined in: venpm/src/core/errors.ts:43

Type Declaration

COMMAND_ERROR

readonly COMMAND_ERROR: 1 = 1;

ENV_ERROR

readonly ENV_ERROR: 3 = 3;

SUCCESS

readonly SUCCESS: 0 = 0;

USAGE_ERROR

readonly USAGE_ERROR: 2 = 2;

Functions

exitCodeForError()

function exitCodeForError(code): number;

Defined in: venpm/src/core/errors.ts:50

Parameters

Parameter	Type
code	ErrorCodeValue

Returns

number

---

makeError()

function makeError(
   code, 
   message, 
   options?): ErrorInfo;

Defined in: venpm/src/core/errors.ts:63

Parameters

Parameter	Type
code	ErrorCodeValue
message	string
options?	{ candidates?: string[]; docsUrl?: string; suggestion?: string; }
options.candidates?	string[]
options.docsUrl?	string
options.suggestion?	string

Returns

ErrorInfo