@types/yup - npm Package Compare versions

Comparing version 0.26.16 to 0.26.17

yup/index.d.ts

@@ -75,6 +75,2 @@ // Type definitions for yup 0.26
     default(): T;
-    nullable(isNullable?: true): Schema<T | null>;
-    nullable(isNullable: false): Schema<Exclude<T, null>>;
-    required(message?: TestOptionsMessage): this;
-    notRequired(): this;
     typeError(message?: TestOptionsMessage): this;
@@ -104,4 +100,9 @@ oneOf(arrayOfValues: any[], message?: TestOptionsMessage): this;
 
-// tslint:disable-next-line:no-empty-interface
-export interface MixedSchema extends Schema<any> {}
+export interface MixedSchema<T = any> extends Schema<T> {
+    nullable(isNullable?: true): MixedSchema<T | null>;
+    nullable(isNullable: false): MixedSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): MixedSchema<T>;
+    required(message?: TestOptionsMessage): MixedSchema<Exclude<T, undefined>>;
+    notRequired(): MixedSchema<T | undefined>;
+}
 
@@ -113,3 +114,3 @@ export interface StringSchemaConstructor {
 
-export interface StringSchema<T extends string | null = string>
+export interface StringSchema<T extends string | null | undefined = string>
     extends Schema<T> {
@@ -133,2 +134,5 @@ length(limit: number | Ref, message?: TestOptionsMessage): StringSchema<T>;
     nullable(isNullable: false): StringSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): StringSchema<T>;
+    required(message?: TestOptionsMessage): StringSchema<Exclude<T, undefined>>;
+    notRequired(): StringSchema<T | undefined>;
 }
@@ -141,3 +145,3 @@
 
-export interface NumberSchema<T extends number | null = number>
+export interface NumberSchema<T extends number | null | undefined = number>
     extends Schema<T> {
@@ -161,2 +165,5 @@ min(limit: number | Ref, message?: TestOptionsMessage): NumberSchema<T>;
     nullable(isNullable: false): NumberSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): NumberSchema<T>;
+    required(message?: TestOptionsMessage): NumberSchema<Exclude<T, undefined>>;
+    notRequired(): NumberSchema<T | undefined>;
 }
@@ -169,7 +176,11 @@
 
-// tslint:disable-next-line:no-empty-interface
-export interface BooleanSchema<T extends boolean | null = boolean>
+export interface BooleanSchema<T extends boolean | null | undefined = boolean>
     extends Schema<T> {
     nullable(isNullable?: true): BooleanSchema<T | null>;
     nullable(isNullable: false): BooleanSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): BooleanSchema<T>;
+    required(
+        message?: TestOptionsMessage
+    ): BooleanSchema<Exclude<T, undefined>>;
+    notRequired(): BooleanSchema<T | undefined>;
 }
@@ -182,3 +193,4 @@
 
-export interface DateSchema<T extends Date | null = Date> extends Schema<T> {
+export interface DateSchema<T extends Date | null | undefined = Date>
+    extends Schema<T> {
     min(
@@ -194,2 +206,5 @@ limit: Date | string | Ref,
     nullable(isNullable: false): DateSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): DateSchema<T>;
+    required(message?: TestOptionsMessage): DateSchema<Exclude<T, undefined>>;
+    notRequired(): DateSchema<T | undefined>;
 }
@@ -202,13 +217,48 @@
 
-export interface ArraySchema<T> extends Schema<T[]> {
+interface BasicArraySchema<T extends any[] | null | undefined>
+    extends Schema<T> {
+    min(limit: number | Ref, message?: TestOptionsMessage): this;
+    max(limit: number | Ref, message?: TestOptionsMessage): this;
+    ensure(): this;
+    compact(rejector?: (value: T, index: number, array: T[]) => boolean): this;
+}
+
+export interface NotRequiredNullableArraySchema<T>
+    extends BasicArraySchema<T[] | null | undefined> {
+    of<U>(type: Schema<U>): NotRequiredNullableArraySchema<U>;
+    nullable(isNullable?: true): NotRequiredNullableArraySchema<T>;
+    nullable(isNullable: false): NotRequiredArraySchema<T>;
+    nullable(isNullable?: boolean): ArraySchema<T>;
+    required(message?: TestOptionsMessage): NullableArraySchema<T>;
+    notRequired(): NotRequiredNullableArraySchema<T>;
+}
+
+export interface NullableArraySchema<T> extends BasicArraySchema<T[] | null> {
+    of<U>(type: Schema<U>): NullableArraySchema<U>;
+    nullable(isNullable?: true): NullableArraySchema<T>;
+    nullable(isNullable: false): ArraySchema<T>;
+    nullable(isNullable?: boolean): ArraySchema<T>;
+    required(message?: TestOptionsMessage): NullableArraySchema<T>;
+    notRequired(): NotRequiredNullableArraySchema<T>;
+}
+
+export interface NotRequiredArraySchema<T>
+    extends BasicArraySchema<T[] | undefined> {
+    of<U>(type: Schema<U>): NotRequiredArraySchema<U>;
+    nullable(isNullable?: true): NotRequiredNullableArraySchema<T>;
+    nullable(isNullable: false): NotRequiredArraySchema<T>;
+    nullable(isNullable: boolean): ArraySchema<T>;
+    required(message?: TestOptionsMessage): ArraySchema<T>;
+    notRequired(): NotRequiredArraySchema<T>;
+}
+
+export interface ArraySchema<T> extends BasicArraySchema<T[]> {
     of<U>(type: Schema<U>): ArraySchema<U>;
-    min(limit: number | Ref, message?: TestOptionsMessage): ArraySchema<T>;
-    max(limit: number | Ref, message?: TestOptionsMessage): ArraySchema<T>;
-    ensure(): ArraySchema<T>;
-    compact(
-        rejector?: (value: T, index: number, array: T[]) => boolean
-    ): ArraySchema<T>;
+    nullable(isNullable?: true): NullableArraySchema<T>;
+    nullable(isNullable: false | boolean): ArraySchema<T>;
+    required(message?: TestOptionsMessage): ArraySchema<T>;
+    notRequired(): NotRequiredArraySchema<T>;
 }
 
-export type ObjectSchemaDefinition<T extends object> = {
+export type ObjectSchemaDefinition<T extends object | null | undefined> = {
     [field in keyof T]: Schema<T[field]> | Ref
@@ -222,3 +272,3 @@ };
  */
-export type Shape<T extends object, U extends object> = {
+export type Shape<T extends object | null | undefined, U extends object> = {
     [P in keyof T]: P extends keyof U ? U[P] : T[P]
@@ -233,3 +283,4 @@ } &
 
-export interface ObjectSchema<T extends object> extends Schema<T> {
+export interface ObjectSchema<T extends object | null | undefined = object>
+    extends Schema<T> {
     shape<U extends object>(
@@ -247,2 +298,7 @@ fields: ObjectSchemaDefinition<U>,
     constantCase(): ObjectSchema<T>;
+    nullable(isNullable?: true): ObjectSchema<T | null>;
+    nullable(isNullable: false): ObjectSchema<Exclude<T, null>>;
+    nullable(isNullable?: boolean): ObjectSchema<T>;
+    required(message?: TestOptionsMessage): ObjectSchema<Exclude<T, undefined>>;
+    notRequired(): ObjectSchema<T | undefined>;
 }
@@ -273,9 +329,9 @@
     | {
-        is: WhenOptionsBuilderObjectIs;
-        then: any;
-        otherwise: any
+          is: WhenOptionsBuilderObjectIs;
+          then: any;
+          otherwise: any;
       }
     | object;
 
-export type WhenOptions<T> =
+    export type WhenOptions<T> =
     | WhenOptionsBuilderFunction<T>
@@ -452,1 +508,16 @@ | WhenOptionsBuilderObject;
 }
+
+export type InferType<T> = T extends Schema<infer P>
+    ? InnerInferType<P>
+    : never;
+
+// Shut off automatic exporting after this statement
+export {};
+
+type KeyOfUndefined<T> = {
+    [P in keyof T]-?: undefined extends T[P] ? P : never
+}[keyof T];
+
+type RequiredProps<T> = Pick<T, Exclude<keyof T, KeyOfUndefined<T>>>;
+type NotRequiredProps<T> = Partial<Pick<T, KeyOfUndefined<T>>>;
+type InnerInferType<T> = NotRequiredProps<T> & RequiredProps<T>;

yup/package.json

 {
     "name": "@types/yup",
-    "version": "0.26.16",
+    "version": "0.26.17",
     "description": "TypeScript definitions for yup",
@@ -72,4 +72,4 @@ "license": "MIT",
     "dependencies": {},
-    "typesPublisherContentHash": "1e21de8ca592cb894dea00ac44057830b27a7116c961a2fe756769d489fff952",
+    "typesPublisherContentHash": "0e4f659c058060341f8890f6ff8c93893b9914bdea302d3cb3d6ee73f9f1e1cf",
     "typeScriptVersion": "2.8"
 }

yup/README.md

@@ -5,3 +5,3 @@ # Installation
 # Summary
-This package contains type definitions for yup ( https://github.com/jquense/yup ).
+This package contains type definitions for yup (https://github.com/jquense/yup).
 
@@ -12,3 +12,3 @@ # Details
 Additional Details
- * Last updated: Tue, 11 Jun 2019 20:19:55 GMT
+ * Last updated: Fri, 21 Jun 2019 08:00:11 GMT
  * Dependencies: none
@@ -18,2 +18,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>, Maurice de Beijer <https://github.com/mauricedb>.
+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>, and 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

22031

increased by17.3%

Lines of code

455

increased by16.07%

No dependency changes