Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve nullable/nullish type definitions #1008

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −8
Open

docs: improve nullable/nullish type definitions #1008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfc2c2b
docs: improve nullable/nullish type definitions
frenzzy Jan 8, 2025
30e1df5
Drop "Type: T" comments
frenzzy Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions library/src/schemas/nullable/nullable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface NullableSchema<
}

/**
* Creates a nullable schema.
* Creates a nullable schema that allows null values.
*
* @param wrapped The wrapped schema.
*
Expand All @@ -55,7 +55,7 @@ export function nullable<
>(wrapped: TWrapped): NullableSchema<TWrapped, undefined>;

/**
* Creates a nullable schema.
* Creates a nullable schema that allows null values.
*
* @param wrapped The wrapped schema.
* @param default_ The default value.
Expand Down
4 changes: 2 additions & 2 deletions library/src/schemas/nullable/nullableAsync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface NullableSchemaAsync<
}

/**
* Creates a nullable schema.
* Creates a nullable schema that allows null values.
*
* @param wrapped The wrapped schema.
*
Expand All @@ -60,7 +60,7 @@ export function nullableAsync<
>(wrapped: TWrapped): NullableSchemaAsync<TWrapped, undefined>;

/**
* Creates a nullable schema.
* Creates a nullable schema that allows null values.
*
* @param wrapped The wrapped schema.
* @param default_ The default value.
Expand Down
4 changes: 2 additions & 2 deletions library/src/schemas/nullish/nullish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface NullishSchema<
}

/**
* Creates a nullish schema.
* Creates a nullish schema that allows null and undefined values.
*
* @param wrapped The wrapped schema.
*
Expand All @@ -55,7 +55,7 @@ export function nullish<
>(wrapped: TWrapped): NullishSchema<TWrapped, undefined>;

/**
* Creates a nullish schema.
* Creates a nullish schema that allows null and undefined values.
*
* @param wrapped The wrapped schema.
* @param default_ The default value.
Expand Down
4 changes: 2 additions & 2 deletions library/src/schemas/nullish/nullishAsync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface NullishSchemaAsync<
}

/**
* Creates a nullish schema.
* Creates a nullish schema that allows null and undefined values.
*
* @param wrapped The wrapped schema.
*
Expand All @@ -60,7 +60,7 @@ export function nullishAsync<
>(wrapped: TWrapped): NullishSchemaAsync<TWrapped, undefined>;

/**
* Creates a nullish schema.
* Creates a nullish schema that allows null and undefined values.
*
* @param wrapped The wrapped schema.
* @param default_ The default value.
Expand Down