Skip to content

Commit

Permalink
Export joi namespace along with const (#245)
Browse files Browse the repository at this point in the history
Allows using the `import { Joi } from 'celebrate' to reference Joi types without importing Joi manually
  • Loading branch information
GerkinDev committed Nov 2, 2023
1 parent c8bab13 commit 1978ab7
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions lib/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import { ErrorRequestHandler, RequestHandler } from 'express';
import { ParamsDictionary, Query } from 'express-serve-static-core';
import {
Root as joi,
ValidationOptions,
ValidationError,
} from 'joi';
import * as Joi from 'joi';


export declare enum Segments {
Expand All @@ -22,8 +18,8 @@ export declare enum Modes {
}

interface Celebrator1<P=ParamsDictionary, ResBody=any, ReqBody=any, ReqQuery=Query> {
(joiOpts: ValidationOptions): Celebrator2;
(joiOpts: ValidationOptions, requestRules: SchemaOptions): RequestHandler<P, ResBody, ReqBody, ReqQuery>;
(joiOpts: Joi.ValidationOptions): Celebrator2;
(joiOpts: Joi.ValidationOptions, requestRules: SchemaOptions): RequestHandler<P, ResBody, ReqBody, ReqQuery>;
}

interface Celebrator2 {
Expand All @@ -32,10 +28,10 @@ interface Celebrator2 {

interface Celebrator<P=ParamsDictionary, ResBody=any, ReqBody=any, ReqQuery=Query> {
(opts: CelebrateOptions): Celebrator1;
(opts: CelebrateOptions, joiOpts: ValidationOptions): Celebrator2;
(opts: CelebrateOptions, joiOpts: Joi.ValidationOptions): Celebrator2;
(
opts: CelebrateOptions,
joiOpts: ValidationOptions,
joiOpts: Joi.ValidationOptions,
requestRules: SchemaOptions
): RequestHandler<P, ResBody, ReqBody, ReqQuery>;
}
Expand Down Expand Up @@ -81,7 +77,7 @@ export interface SchemaOptions {
/**
* Creates a celebrate middleware function.
*/
export declare function celebrate<P=ParamsDictionary, ResBody=any, ReqBody=any, ReqQuery=Query>(requestRules: SchemaOptions, joiOpts?: ValidationOptions, opts?: CelebrateOptions): RequestHandler<P, ResBody, ReqBody, ReqQuery>;
export declare function celebrate<P=ParamsDictionary, ResBody=any, ReqBody=any, ReqQuery=Query>(requestRules: SchemaOptions, joiOpts?: Joi.ValidationOptions, opts?: CelebrateOptions): RequestHandler<P, ResBody, ReqBody, ReqQuery>;

/**
* Curried version of `celebrate`.
Expand All @@ -96,7 +92,7 @@ export declare function errors<P=ParamsDictionary, ResBody=any, ReqBody=any, Req
/**
* The Joi version Celebrate uses internally.
*/
export declare const Joi: joi;
export { Joi };

/**
* Examines an error object to determine if it originated from the celebrate middleware.
Expand All @@ -107,6 +103,6 @@ export declare function isCelebrateError(err: any): err is CelebrateError;
* The standard error used by Celebrate
*/
export declare class CelebrateError extends Error {
details: Map<string, ValidationError>;
details: Map<string, Joi.ValidationError>;
constructor(message?:string, opts?: { celebrated?: boolean });
}

0 comments on commit 1978ab7

Please sign in to comment.