Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/security / / SecretRefParseError

Class: SecretRefParseError

Defined in: packages/security/src/secrets/errors.ts:55

Raised when parseSecretRef(...) rejects an input. The parser is strict-by-default and never silently falls through to a default resolver — typos in *Ref config fields surface here at bootstrap.

Stable

Extends

Constructors

Constructor

ts
new SecretRefParseError(
   kind, 
   message, 
   input, 
   position?, 
   options?): SecretRefParseError;

Defined in: packages/security/src/secrets/errors.ts:62

Parameters

ParameterType
kindSecretRefParseErrorKind
messagestring
inputstring
position?number
options?{ cause?: unknown; hint?: string; }
options.cause?unknown
options.hint?string

Returns

SecretRefParseError

Overrides

GraphorinSecretsError.constructor

Properties

PropertyModifierTypeDescriptionOverridesInherited fromDefined in
cause?publicunknown--GraphorinSecretsError.causenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?readonlystringOptional remediation hint (CLI command or doc link).-GraphorinSecretsError.hintpackages/security/src/secrets/errors.ts:21
inputreadonlystringOriginal input string. Safe to log — never carries a secret value.--packages/security/src/secrets/errors.ts:58
kindreadonlySecretRefParseErrorKindStable lowercase discriminator. Subclasses fix this to a literal.GraphorinSecretsError.kind-packages/security/src/secrets/errors.ts:56
messagepublicstring--GraphorinSecretsError.messagenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring--GraphorinSecretsError.namenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
position?readonlynumberOptional offset into input where the parser stopped.--packages/security/src/secrets/errors.ts:60
stack?publicstring--GraphorinSecretsError.stacknode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimitstaticnumberThe Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.-GraphorinSecretsError.stackTraceLimitnode_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

GraphorinSecretsError.captureStackTrace


prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:56

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

GraphorinSecretsError.prepareStackTrace