@avonjs/avonjs/dist/helpers.d.ts

A fluent Node.js API generator.

import type { NextFunction, Request, Response } from 'express';
import type { OpenAPIV3 } from 'openapi-types';
import type { AnyValue, EvaluatorCallback, ResourceEvaluatorCallback } from './Contracts';
import type { AvonResponse } from './Http/Responses';
/**
 * Convert given string in to slugify version.
 */
export declare const slugify: (string: string, separator?: string) => string;
/**
 * Make evaluator callback for given callback.
 */
export declare const makeEvaluatorCallback: (callback: EvaluatorCallback | boolean) => EvaluatorCallback | ResourceEvaluatorCallback;
/**
 * Make evaluator callback to approve.
 */
export declare const approveCallback: () => ResourceEvaluatorCallback | EvaluatorCallback;
/**
 * Make reverse callback for given evaluator callback.
 */
export declare const reverseEvaluatorCallback: (callback: EvaluatorCallback | boolean) => EvaluatorCallback | ResourceEvaluatorCallback;
/**
 * Checks if the input value is nullish, which includes empty string, undefined, NaN, or null.
 */
export declare const isNullish: (value: AnyValue) => boolean;
/**
 * Send Avon response by node response service.
 */
export declare const send: (res: Response, response: AvonResponse) => void;
/**
 * Handle JWT authentication error.
 */
export declare const handleAuthenticationError: (err: Error, req: Request, res: Response, next: NextFunction) => void;
/**
 * Get authorization responses schema.
 */
export declare const authorizationResponses: () => OpenAPIV3.ResponsesObject;
/**
 * Get erros responses schema.
 */
export declare const errorsResponses: () => OpenAPIV3.ResponsesObject;
/**
 * Get validation responses schema.
 */
export declare const validationResponses: () => OpenAPIV3.ResponsesObject;