@types/yup - npm Package Compare versions

Comparing version 0.26.14 to 0.26.15

yup/index.d.ts

@@ -13,2 +13,3 @@ // Type definitions for yup 0.26
 //                 Desmond Koh <https://github.com/deskoh>
+//                 Maurice de Beijer <https://github.com/mauricedb>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -75,3 +76,4 @@ // TypeScript Version: 2.8
     default(): T;
-    nullable(isNullable?: boolean): this;
+    nullable(isNullable?: true): Schema<T | null>;
+    nullable(isNullable: false): Schema<Exclude<T, null>>;
     required(message?: TestOptionsMessage): this;
@@ -111,6 +113,7 @@ notRequired(): this;
 
-export interface StringSchema extends Schema<string> {
-    length(limit: number | Ref, message?: TestOptionsMessage): StringSchema;
-    min(limit: number | Ref, message?: TestOptionsMessage): StringSchema;
-    max(limit: number | Ref, message?: TestOptionsMessage): StringSchema;
+export interface StringSchema<T extends string | null = string>
+    extends Schema<T> {
+    length(limit: number | Ref, message?: TestOptionsMessage): StringSchema<T>;
+    min(limit: number | Ref, message?: TestOptionsMessage): StringSchema<T>;
+    max(limit: number | Ref, message?: TestOptionsMessage): StringSchema<T>;
     matches(
@@ -121,9 +124,11 @@ regex: RegExp,
             | { message?: TestOptionsMessage; excludeEmptyString?: boolean }
-    ): StringSchema;
-    email(message?: TestOptionsMessage): StringSchema;
-    url(message?: TestOptionsMessage): StringSchema;
-    ensure(): StringSchema;
-    trim(message?: TestOptionsMessage): StringSchema;
-    lowercase(message?: TestOptionsMessage): StringSchema;
-    uppercase(message?: TestOptionsMessage): StringSchema;
+    ): StringSchema<T>;
+    email(message?: TestOptionsMessage): StringSchema<T>;
+    url(message?: TestOptionsMessage): StringSchema<T>;
+    ensure(): StringSchema<T>;
+    trim(message?: TestOptionsMessage): StringSchema<T>;
+    lowercase(message?: TestOptionsMessage): StringSchema<T>;
+    uppercase(message?: TestOptionsMessage): StringSchema<T>;
+    nullable(isNullable?: true): StringSchema<T | null>;
+    nullable(isNullable: false): StringSchema<Exclude<T, null>>;
 }
@@ -136,12 +141,21 @@
 
-export interface NumberSchema extends Schema<number> {
-    min(limit: number | Ref, message?: TestOptionsMessage): NumberSchema;
-    max(limit: number | Ref, message?: TestOptionsMessage): NumberSchema;
-    lessThan(limit: number | Ref, message?: TestOptionsMessage): NumberSchema;
-    moreThan(limit: number | Ref, message?: TestOptionsMessage): NumberSchema;
-    positive(message?: TestOptionsMessage): NumberSchema;
-    negative(message?: TestOptionsMessage): NumberSchema;
-    integer(message?: TestOptionsMessage): NumberSchema;
-    truncate(): NumberSchema;
-    round(type: "floor" | "ceil" | "trunc" | "round"): NumberSchema;
+export interface NumberSchema<T extends number | null = number>
+    extends Schema<T> {
+    min(limit: number | Ref, message?: TestOptionsMessage): NumberSchema<T>;
+    max(limit: number | Ref, message?: TestOptionsMessage): NumberSchema<T>;
+    lessThan(
+        limit: number | Ref,
+        message?: TestOptionsMessage
+    ): NumberSchema<T>;
+    moreThan(
+        limit: number | Ref,
+        message?: TestOptionsMessage
+    ): NumberSchema<T>;
+    positive(message?: TestOptionsMessage): NumberSchema<T>;
+    negative(message?: TestOptionsMessage): NumberSchema<T>;
+    integer(message?: TestOptionsMessage): NumberSchema<T>;
+    truncate(): NumberSchema<T>;
+    round(type: "floor" | "ceil" | "trunc" | "round"): NumberSchema<T>;
+    nullable(isNullable?: true): NumberSchema<T | null>;
+    nullable(isNullable: false): NumberSchema<Exclude<T, null>>;
 }
@@ -155,3 +169,7 @@
 // tslint:disable-next-line:no-empty-interface
-export interface BooleanSchema extends Schema<boolean> {}
+export interface BooleanSchema<T extends boolean | null = boolean>
+    extends Schema<T> {
+    nullable(isNullable?: true): BooleanSchema<T | null>;
+    nullable(isNullable: false): BooleanSchema<Exclude<T, null>>;
+}
 
@@ -163,5 +181,13 @@ export interface DateSchemaConstructor {
 
-export interface DateSchema extends Schema<Date> {
-    min(limit: Date | string | Ref, message?: TestOptionsMessage): DateSchema;
-    max(limit: Date | string | Ref, message?: TestOptionsMessage): DateSchema;
+export interface DateSchema<T extends Date | null = Date> extends Schema<T> {
+    min(
+        limit: Date | string | Ref,
+        message?: TestOptionsMessage
+    ): DateSchema<T>;
+    max(
+        limit: Date | string | Ref,
+        message?: TestOptionsMessage
+    ): DateSchema<T>;
+    nullable(isNullable?: true): DateSchema<T | null>;
+    nullable(isNullable: false): DateSchema<Exclude<T, null>>;
 }
@@ -179,3 +205,5 @@
     ensure(): ArraySchema<T>;
-    compact(rejector?: (value: T, index: number, array: T[]) => boolean): ArraySchema<T>;
+    compact(
+        rejector?: (value: T, index: number, array: T[]) => boolean
+    ): ArraySchema<T>;
 }
@@ -217,7 +245,7 @@
 
-export type TransformFunction<T> = ((
+export type TransformFunction<T> = (
     this: T,
     value: any,
     originalValue: any
-) => any);
+) => any;
 
@@ -233,3 +261,7 @@ export interface WhenOptionsBuilder<T> {
     | WhenOptionsBuilder<T>
-    | { is: boolean | ((...values: any[]) => boolean); then: any; otherwise: any }
+    | {
+          is: boolean | ((...values: any[]) => boolean);
+          then: any;
+          otherwise: any;
+      }
     | object;
@@ -243,3 +275,6 @@
     resolve: (value: any) => any;
-    createError: (params?: { path?: string; message?: string }) => ValidationError;
+    createError: (params?: {
+        path?: string;
+        message?: string;
+    }) => ValidationError;
 }
@@ -311,3 +346,3 @@
     meta: object;
-    tests: Array<{ name: string, params: object }>;
+    tests: Array<{ name: string; params: object }>;
     fields: object;
@@ -386,14 +421,12 @@ }
 export interface FormatErrorParams {
-  path: string;
-  type: string;
-  value?: any;
-  originalValue?: any;
+    path: string;
+    type: string;
+    value?: any;
+    originalValue?: any;
 }
 
-export type LocaleValue =
-    | string
-    | ((params: FormatErrorParams) => string);
+export type LocaleValue = string | ((params: FormatErrorParams) => string);
 
 export interface LocaleObject {
-    mixed?: { [key in keyof MixedSchema]?: string; } & { notType?: LocaleValue };
+    mixed?: { [key in keyof MixedSchema]?: string } & { notType?: LocaleValue };
     string?: { [key in keyof StringSchema]?: string };
@@ -400,0 +433,0 @@ number?: { [key in keyof NumberSchema]?: string };

yup/package.json

 {
     "name": "@types/yup",
-    "version": "0.26.14",
+    "version": "0.26.15",
     "description": "TypeScript definitions for yup",
@@ -56,2 +56,7 @@ "license": "MIT",
             "githubUsername": "deskoh"
+        },
+        {
+            "name": "Maurice de Beijer",
+            "url": "https://github.com/mauricedb",
+            "githubUsername": "mauricedb"
         }
@@ -68,4 +73,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "2babe9a8fa8a89b3d114ebbd31f1d381a707f899ec7d3231b4e9f39cde9a0c27",
+    "typesPublisherContentHash": "3dfb76dc75843f2c5d72980410c179af885694726339f0cce6630750dff4e0c6",
     "typeScriptVersion": "2.8"
 }

yup/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Tue, 04 Jun 2019 18:34:29 GMT
+ * Last updated: Mon, 10 Jun 2019 17:20:21 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Dominik Hardtke <https://github.com/dhardtke>, Vladyslav Tserman <https://github.com/vtserman>, Moreton Bay Regional Council <https://github.com/MoretonBayRC>, Sindre Seppola <https://github.com/sseppola>, Yash Kulshrestha <https://github.com/YashdalfTheGray>, Vincent Pizzo <https://github.com/vincentjames501>, Robert Bullen <https://github.com/robertbullen>, Yusuke Sato <https://github.com/sat0yu>, Dan Rumney <https://github.com/dancrumb>, Desmond Koh <https://github.com/deskoh>.
+These definitions were written by Dominik Hardtke <https://github.com/dhardtke>, Vladyslav Tserman <https://github.com/vtserman>, Moreton Bay Regional Council <https://github.com/MoretonBayRC>, Sindre Seppola <https://github.com/sseppola>, Yash Kulshrestha <https://github.com/YashdalfTheGray>, Vincent Pizzo <https://github.com/vincentjames501>, Robert Bullen <https://github.com/robertbullen>, Yusuke Sato <https://github.com/sat0yu>, Dan Rumney <https://github.com/dancrumb>, Desmond Koh <https://github.com/deskoh>, Maurice de Beijer <https://github.com/mauricedb>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18571

increased by6.74%

Lines of code

383

increased by9.43%

No dependency changes