fix: promises where not allowed by type #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jspears
commented
Mar 1, 2023
| @@ -13,7 +13,7 @@ | |||
| "tdd": "mocha --watch", | |||
| "test": "npm run lint && npm run test:once && npm run test:types", | |||
| "test:once": "nyc --reporter=lcovonly --reporter=html mocha", | |||
| "test:types": "dtslint --expectOnly --localTs node_modules/typescript/lib types", | |||
There was a problem hiding this comment.
this didn't work before I made changes, kept returning
> dtslint --expectOnly --localTs node_modules/typescript/lib types
Error: Errors in typescript@local for external dependencies:
../src/Schema.ts(33,37): error TS2345: Argument of type 'DataType' is not assignable to parameter of type 'PlainObject<any>'.
../src/Schema.ts(48,37): error TS2345: Argument of type 'DataType' is not assignable to parameter of type 'PlainObject<any>'.
at /Users/jspears/dev/schema-typed/node_modules/dtslint/bin/index.js:207:19
at Generator.next (<anonymous>)
at fulfilled (/Users/jspears/dev/schema-typed/node_modules/dtslint/bin/index.js:6:58)
There was a problem hiding this comment.
dtslint is a linting tool used by the current library before refactoring through typescript, I think it can be removed, because there is eslint as a type checking tool.
| function isObj(o: unknown): o is Record<PropertyKey, unknown> { | ||
| return o != null && (typeof o === 'object' || typeof o == 'function'); | ||
| } | ||
| function isPromiseLike(v: unknown): v is Promise<unknown> { |
There was a problem hiding this comment.
sometimes people don't use real promises. Its sad, but true.
src/utils/createValidator.ts
Outdated
| @@ -19,6 +24,8 @@ export function createValidator<V, D, E>(data?: D, name?: string | string[]) { | |||
| name: Array.isArray(name) ? name.join('.') : name | |||
| }) | |||
| }; | |||
| } else if (isPromiseLike(checkResult)) { | |||
| throw new Error('synchronous validator had an async result'); | |||
There was a problem hiding this comment.
This seems like the safest thing to do. I would hate for somebody to make an async call that never resolves.
simonguo
requested changes
Mar 1, 2023
| @@ -19,6 +24,8 @@ export function createValidator<V, D, E>(data?: D, name?: string | string[]) { | |||
| name: Array.isArray(name) ? name.join('.') : name | |||
| }) | |||
| }; | |||
| } else if (isPromiseLike(checkResult)) { | |||
There was a problem hiding this comment.
It would be nice to be able to add test cases for the changes here.
There was a problem hiding this comment.
Good point added a test.
simonguo
approved these changes
Mar 1, 2023
|
Fixed in 2.0.4 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds typescript types allowing for promise based validators.
#60