ts api #1005
Closed
ts api #1005
Conversation
This file contains hidden or 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
enjoylife
reviewed
Jul 24, 2022
| : typeof value === "function" | ||
| ? map(data, value, arrayType) | ||
| : type === "number" || value instanceof Date || type === "boolean" | ||
| : typeof value === "number" || value instanceof Date || typeof value === "boolean" |
There was a problem hiding this comment.
I'm seeing warnings where the union of the type is under specified.
Warning:(41, 7) Invalid 'typeof' check: 'value' cannot have type 'number'
Warning:(41, 36) Invalid 'instanceof' check: 'value' has type that is not related to 'Date'
Warning:(41, 61) Invalid 'typeof' check: 'value' cannot have type 'boolean'
A naive fix.. just append said types to the args list. e.g. value: ... | number | Date | boolean,.
Or maybe instead they should be added to the already defined types, e.g. ChannelOption, if not too broad 🤷 .
Contributor
Author
There was a problem hiding this comment.
Thanks for flagging! I don't get these warnings myself, not in VSCode nor in yarn test:typecheck. How come?
Contributor
Author
There was a problem hiding this comment.
Are you using the --watch option?
Contributor
Author
|
This PR would be monstruous to review. I'm leaving it as a draft to show the context, but I'll submit it separately in digestible pieces. The first piece will be data.ts + options.ts |
This was referenced Jul 26, 2022
Closed
context.ts
src/options
api.ts and options.ts
fix type formatAuto
scales/index
scales/schemes
scales/schemes.ts
src/stats
stats.ts
remove common.ts for now
symbols
symbols.ts
marks/marker
marker.ts; changing the API for marker
the second argument for markers has not been documented yet; changing it from *context* = {document} to *document*
style
style.ts
src/transforms/basic
transform/basic.ts
transform/identity
transforms/identity.ts
transforms/group
transforms/groups.ts
transforms/inset
transforms/inset.ts
transforms/map
transforms/map.ts
transforms/select
transforms/select.ts
transforms/stack
transforms/stack.ts
transforms/interval
transforms/interval.ts
transforms/normalize
transforms/normalize.ts
transforms/window
transforms/window.ts
transforms/bin
transforms/bin.ts
clean-up valueof, map
renames & clean-up on ValueAccessor
valueof cleaner
cleaner defs for data and columns
Add stack error messages when X or Z are missing and the specified order requires them
move data types to src/data.ts
too much typing
README documentation and links for Plot.column, Plot.valueof and Plot.transform (aka basic)
options.ts copied from 6b6aa86
keep in sync with #1008
follow #1008 on pXX
follow #1008
Datum can also be an array of values, with typical accessors being "length", "0", "1"…
more typings
basic.ts is working
transforms: identity, inset, interval, map
window, and a bit of progress on stack
normalize
select
stack
bin
group
markers and symbols
arrayify comes back
difficulty typing Trasnforms vs Initializer, because Plot.sort applies to either
Closed
1 task
Member
|
Probably superseded by #1320 which goes the d.ts route. Close? |
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.
rebooting #1001 with a "typescript as documentation" approach.
Things to watch for:
Plot.valueof(undefined, () => {})crashedPlot.map("foo")crashedPlot.selectMinXpotentially insertedundefinedin the facet indexmid(x1, x2)was wrongly typed (it expected adataargument)