Skip to content

Commit 9e1df49

Browse files
authored
fix: add optional message to nonNullable schema methods (#2119)
1 parent 5db2b2f commit 9e1df49

8 files changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ const parsedUser = await userSchema.validate(
111111
- [`Schema.withMutation(builder: (current: Schema) => void): void`](#schemawithmutationbuilder-current-schema--void-void)
112112
- [`Schema.default(value: any): Schema`](#schemadefaultvalue-any-schema)
113113
- [`Schema.getDefault(options?: object): Any`](#schemagetdefaultoptions-object-any)
114-
- [`Schema.nullable(): Schema`](#schemanullable-schema)
115-
- [`Schema.nonNullable(): Schema`](#schemanonnullable-schema)
114+
- [`Schema.nullable(message?: string | function): Schema`](#schemanullable-schema)
115+
- [`Schema.nonNullable(message?: string | function): Schema`](#schemanonnullable-schema)
116116
- [`Schema.defined(): Schema`](#schemadefined-schema)
117117
- [`Schema.optional(): Schema`](#schemaoptional-schema)
118118
- [`Schema.required(message?: string | function): Schema`](#schemarequiredmessage-string--function-schema)
@@ -946,7 +946,7 @@ yup.date.default(() => new Date()); // also helpful for defaults that change ove
946946

947947
Retrieve a previously set default value. `getDefault` will resolve any conditions that may alter the default. Optionally pass `options` with `context` (for more info on `context` see `Schema.validate`).
948948

949-
#### `Schema.nullable(): Schema`
949+
#### `Schema.nullable(message?: string | function): Schema`
950950

951951
Indicates that `null` is a valid value for the schema. Without `nullable()`
952952
`null` is treated as a different type and will fail `Schema.isType()` checks.
@@ -959,7 +959,7 @@ schema.cast(null); // null
959959
InferType<typeof schema>; // number | null
960960
```
961961

962-
#### `Schema.nonNullable(): Schema`
962+
#### `Schema.nonNullable(message?: string | function): Schema`
963963

964964
The opposite of `nullable`, removes `null` from valid type values for the schema.
965965
**Schema are non nullable by default**.

src/array.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,9 @@ export default interface ArraySchema<
307307
notRequired(): ArraySchema<Maybe<TIn>, TContext, TDefault, TFlags>;
308308

309309
nullable(msg?: Message): ArraySchema<TIn | null, TContext, TDefault, TFlags>;
310-
nonNullable(): ArraySchema<NotNull<TIn>, TContext, TDefault, TFlags>;
310+
nonNullable(
311+
msg?: Message,
312+
): ArraySchema<NotNull<TIn>, TContext, TDefault, TFlags>;
311313

312314
strip(
313315
enabled: false,

src/date.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,9 @@ export default interface DateSchema<
134134
notRequired(): DateSchema<Maybe<TType>, TContext, TDefault, TFlags>;
135135

136136
nullable(msg?: Message): DateSchema<TType | null, TContext, TDefault, TFlags>;
137-
nonNullable(): DateSchema<NotNull<TType>, TContext, TDefault, TFlags>;
137+
nonNullable(
138+
msg?: Message,
139+
): DateSchema<NotNull<TType>, TContext, TDefault, TFlags>;
138140

139141
strip(
140142
enabled: false,

src/mixed.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ export default interface MixedSchema<
7373
msg?: Message,
7474
): MixedSchema<TType | null, TContext, TDefault, TFlags>;
7575

76-
nonNullable(): MixedSchema<Exclude<TType, null>, TContext, TDefault, TFlags>;
76+
nonNullable(
77+
msg?: Message,
78+
): MixedSchema<Exclude<TType, null>, TContext, TDefault, TFlags>;
7779

7880
strip(
7981
enabled: false,

src/number.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,9 @@ export default interface NumberSchema<
192192
nullable(
193193
msg?: Message,
194194
): NumberSchema<TType | null, TContext, TDefault, TFlags>;
195-
nonNullable(): NumberSchema<NotNull<TType>, TContext, TDefault, TFlags>;
195+
nonNullable(
196+
msg?: Message,
197+
): NumberSchema<NotNull<TType>, TContext, TDefault, TFlags>;
196198

197199
strip(
198200
enabled: false,

src/object.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,9 @@ export default interface ObjectSchema<
112112
notRequired(): ObjectSchema<Maybe<TIn>, TContext, TDefault, TFlags>;
113113

114114
nullable(msg?: Message): ObjectSchema<TIn | null, TContext, TDefault, TFlags>;
115-
nonNullable(): ObjectSchema<NotNull<TIn>, TContext, TDefault, TFlags>;
115+
nonNullable(
116+
msg?: Message,
117+
): ObjectSchema<NotNull<TIn>, TContext, TDefault, TFlags>;
116118

117119
strip(
118120
enabled: false,

src/string.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,11 @@ export default interface StringSchema<
288288
notRequired(): StringSchema<Maybe<TType>, TContext, TDefault, TFlags>;
289289

290290
nullable(
291-
msg?: Message<any>,
291+
msg?: Message,
292292
): StringSchema<TType | null, TContext, TDefault, TFlags>;
293-
nonNullable(): StringSchema<NotNull<TType>, TContext, TDefault, TFlags>;
293+
nonNullable(
294+
msg?: Message
295+
): StringSchema<NotNull<TType>, TContext, TDefault, TFlags>;
294296

295297
strip(
296298
enabled: false,

src/tuple.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ export default interface TupleSchema<
5858
nullable(
5959
msg?: Message,
6060
): TupleSchema<TType | null, TContext, TDefault, TFlags>;
61-
nonNullable(): TupleSchema<NotNull<TType>, TContext, TDefault, TFlags>;
61+
nonNullable(
62+
msg?: Message
63+
): TupleSchema<NotNull<TType>, TContext, TDefault, TFlags>;
6264

6365
strip(
6466
enabled: false,

0 commit comments

Comments
 (0)