Merge pull request #2982 from felixmosh/array-types

feat: Improve array().items type
hapijs · Oct 4, 2023 · 81277bd · 81277bd
2 parents 725baf8 + 3463cf0
commit 81277bd
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1647,7 +1647,13 @@ declare namespace Joi {
          *
          * @param type - a joi schema object to validate each array item against.
          */
-        items(...types: SchemaLikeWithoutArray[]): this;
+        items<A>(a: SchemaLikeWithoutArray<A>): ArraySchema<A[]>;
+        items<A, B>(a: SchemaLikeWithoutArray<A>, b: SchemaLikeWithoutArray<B>): ArraySchema<(A | B)[]>;
+        items<A, B, C>(a: SchemaLikeWithoutArray<A>, b: SchemaLikeWithoutArray<B>, c: SchemaLikeWithoutArray<C>): ArraySchema<(A | B | C)[]>;
+        items<A, B, C, D>(a: SchemaLikeWithoutArray<A>, b: SchemaLikeWithoutArray<B>, c: SchemaLikeWithoutArray<C>, d: SchemaLikeWithoutArray<D>): ArraySchema<(A | B | C| D)[]>;
+        items<A, B, C, D, E>(a: SchemaLikeWithoutArray<A>, b: SchemaLikeWithoutArray<B>, c: SchemaLikeWithoutArray<C>, d: SchemaLikeWithoutArray<D>, e: SchemaLikeWithoutArray<E>): ArraySchema<(A | B | C| D | E)[]>;
+        items<A, B, C, D, E , F>(a: SchemaLikeWithoutArray<A>, b: SchemaLikeWithoutArray<B>, c: SchemaLikeWithoutArray<C>, d: SchemaLikeWithoutArray<D>, e: SchemaLikeWithoutArray<E>, f: SchemaLikeWithoutArray<F>): ArraySchema<(A | B | C| D | E |F)[]>;
+        items<TItems>(...types: SchemaLikeWithoutArray<TItems>[]): this;
 
         /**
          * Specifies the exact number of items in the array.

diff --git a/test/index.ts b/test/index.ts
@@ -396,6 +396,8 @@ expect.error(arrSchema.items([numSchema, strSchema, schemaLike]));
 arrSchema = arrSchema.items(schemaMap);
 arrSchema = arrSchema.items(schemaMap, schemaMap, schemaLike);
 expect.error(arrSchema.items([schemaMap, schemaMap, schemaLike]));
+let value1 = Joi.array().items(Joi.string(), Joi.boolean(), Joi.number(), Joi.object({key: Joi.string()}));
+expect.type<Joi.ArraySchema<(string | number | boolean | {key: string})[]>>(value1)
 
 // - - - - - - - -