Skip to content

Commit

Permalink
Fix JSDoc typos in BooleanFromUnknown and split functions for `Sc…
Browse files Browse the repository at this point in the history
…hema` package (#2583)

Signed-off-by: Giovanni Ravalico <15946771+suddenlyGiovanni@users.noreply.github.com>
  • Loading branch information
suddenlyGiovanni committed Apr 21, 2024
1 parent 68a8b5f commit 80271bd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .changeset/four-feet-fix.md
@@ -0,0 +1,6 @@
---
"@effect/schema": patch
---

- Fixed a typo in the JSDoc comment of the `BooleanFromUnknown` boolean constructors in `Schema.ts`
- Fixed a typo in the JSDoc comment of the `split` string transformations combinator in `Schema.ts`
6 changes: 3 additions & 3 deletions packages/schema/src/Schema.ts
Expand Up @@ -3518,7 +3518,7 @@ export const Trim: Trim = transform(
).annotations({ identifier: "Trim" })

/**
* Returns a achema that allows splitting a string into an array of strings.
* Returns a schema that allows splitting a string into an array of strings.
*
* @category string transformations
* @since 1.0.0
Expand Down Expand Up @@ -7537,8 +7537,8 @@ const schemaFromArbitrary = <A>(value: LazyArbitrary<A>): Schema<A> =>
export interface BooleanFromUnknown extends Annotable<BooleanFromUnknown, boolean, unknown> {}

/**
* Convers an arbitrary value to a `boolean` by testing whether it is truthy.
* Uses `!!val` to convert the value to a `boolean`.
* Converts an arbitrary value to a `boolean` by testing whether it is truthy.
* Uses `!!val` to coerce the value to a `boolean`.
*
* @see https://developer.mozilla.org/docs/Glossary/Truthy
* @category boolean constructors
Expand Down

0 comments on commit 80271bd

Please sign in to comment.