Refine format type in schema

2026-07-01 15:50:13 +00:00 · 2016-01-13 17:59:59 +00:00
parent 981c9d1112
commit 592d0403d1
1 changed files with 10 additions and 1 deletions
--- a/convict/convict.d.ts
+++ b/convict/convict.d.ts
@@ -16,7 +16,16 @@ declare module "convict" {
            [name: string]: convict.Schema | {
                default: any;
                doc?: string;
-                format?: any;
+                /**
+                 * From the implementation:
+                 *
+                 *  format can be a:
+                 *   - predefine type, as seen below
+                 *   - an array of enumerated values, e.g. ["production", "development", "testing"]
+                 *   - built-in JavaScript type, i.e. Object, Array, String, Number, Boolean
+                 *   - or if omitted, the Object.prototype.toString.call of the default value
+                 */
+                format?: string | Array<any> | Function;
                env?: string;
                arg?: string;
            };