Skip to main content

Hexa Client Base (core)

Classes​

HexaPipeValidationError​

import { HexaPipeValidationError } from '@hexajs-dev/core';
class HexaPipeValidationError extends Error { ... }

Properties​

  • code
  • details

Types & Interfaces​

HexaPipeInput​

import { HexaPipeInput } from '@hexajs-dev/core';
interface HexaPipeInput {
    route: string;
    payload: unknown;
    sender: unknown;
    context: HexaPipeContextName;
}

HexaPipeValidationResult​

import { HexaPipeValidationResult } from '@hexajs-dev/core';
interface HexaPipeValidationResult {
    valid: boolean;
    error?: string;
    code?: string;
    details?: unknown;
}

HexaPipeContextName​

import { HexaPipeContextName } from '@hexajs-dev/core';
type HexaPipeContextName = 'background' | 'content';

HexaPipeFn​

import { HexaPipeFn } from '@hexajs-dev/core';
type HexaPipeFn = (input: HexaPipeInput) => unknown | HexaPipeValidationResult | Promise<unknown | HexaPipeValidationResult>;