Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/security / / ComposedGuardrailResult

Type Alias: ComposedGuardrailResult<TValue>

ts
type ComposedGuardrailResult<TValue> = 
  | {
  ok: true;
  value: TValue;
}
  | {
  action: GuardrailAction;
  message: string;
  name: string;
  ok: false;
  value: TValue;
  warnings: ReadonlyArray<{
     message: string;
     name: string;
  }>;
};

Defined in: packages/security/src/guardrails/types.ts:111

Result of running a sequence of guardrails through composeGuardrails(...).

Type Parameters

Type ParameterDefault type
TValueunknown

Stable