Graphorin API reference v0.4.0

---

Graphorin API reference / @graphorin/security / / WeakPepperError

Class: WeakPepperError

Defined in: packages/security/src/auth/errors.ts:132

Raised when createToken / rotatePepper / rekeyTokens are invoked with a pepper value that fails the strength check — either below the 32-byte minimum, or a low-entropy / placeholder value (e.g. a long run of identical bytes). See assessSecretStrength.

Stable

Extends

• GraphorinSecretsError

Constructors

Constructor

new WeakPepperError(providedBytes, reason?): WeakPepperError;

Defined in: packages/security/src/auth/errors.ts:136

Parameters

Parameter	Type
providedBytes	number
reason?	string

Returns

WeakPepperError

Overrides

GraphorinSecretsError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
cause?	public	unknown	undefined	-	-	GraphorinSecretsError.cause	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?	readonly	string	undefined	Optional remediation hint (CLI command or doc link).	-	GraphorinSecretsError.hint	packages/security/src/secrets/errors.ts:21
kind	readonly	"weak-pepper"	'weak-pepper'	Stable lowercase discriminator. Subclasses fix this to a literal.	GraphorinSecretsError.kind	-	packages/security/src/auth/errors.ts:133
message	public	string	undefined	-	-	GraphorinSecretsError.message	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	undefined	-	-	GraphorinSecretsError.name	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
providedBytes	readonly	number	undefined	-	-	-	packages/security/src/auth/errors.ts:134
stack?	public	string	undefined	-	-	GraphorinSecretsError.stack	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	undefined	The 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.stackTraceLimit	node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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.

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:

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

GraphorinSecretsError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GraphorinSecretsError.prepareStackTrace