Comments (6)
It types the response as strict as it possibly can without knowing anything about it other than that it's JSON. For example, json.a
could be null
, in which case, json.a.b
would not exist.
from type-fest.
I think we should document in the type that it's not meant as a response type, but rather to make certain input strict.
It could maybe also be useful as a super-type for response types. So you do CustomResponseType extends JsonObject { … }
to ensure you don't accidentally use non-JSON compatible types. Thoughts?
from type-fest.
json.a
could benull
, in which case,json.a.b
would not exist
GraphQL guarantees that already, if you check for json.errors
first.
How am I gonna type this without // @ts-ignore
and node: any
? 😰
let authors: Author[] = json.repository.pullRequest.commits.nodes
.map(node => node.commit.author); // from Refined GitHub
from type-fest.
I think this type is useful for APIs that want to accept only JSON-like structures, it is not really useful as a response type. There you usually have an idea of how a response is structured.
For your specific example, how should TS know something about the semantics of GraphQL? If you already know the shape of your response, why do you want to use JSONObject
?
from type-fest.
It seemed to make sense that a fetchApi
would return a JsonObject
, but it's hard to even cast that as something else (see as UserInfo
in the commit above) because each level "could be string or null", so in most cases you'd have to cast as unknown as UserInfo
at best, which means JsonObject
is lost instantly.
In the specific case I'm ok with the code throwing if a level isn't there, so the error isn't swallowed by some if levelX !== undefined
, hence the as any
.
I understand why TS throws, but I don't know how/if it can be used in this case.
from type-fest.
I think it just doesn't meant to be used like this. This is only useful for APIs like JSON.stringify
and the like.
from type-fest.
Related Issues (20)
- `IsStringLiteral` should be `false` for branded and tagged types
- `CamelCasedPropertiesDeep` doesn't handle `Tagged` type correctly HOT 1
- `IfxxxLiteral` (eg `IfBooleanLiteral`) are missing (only the `IsxxxLiteral` is present
- `PartialDeep` doesn't work with arrays HOT 3
- Document `IntRange` `Start` param must be `>=0`
- `Exact` does not work as expected with type involving `Date` and union HOT 2
- Web-specific version of `StructuredCloneable` type HOT 10
- Add `IsNullable` and `IsOptional`
- `LiteralList<Union>` HOT 2
- Exact not function correctly with Dates since last commit HOT 8
- Type `{}` is not assignable to type `PartialDeep<T>` HOT 1
- Expose Max Recursion Depth of Paths HOT 2
- Issues with `Paths` type HOT 4
- 4.23.0 introduced a breaking change in `Paths` type HOT 6
- Feat: Include types to remove null/undefined/optionals from a tuple
- `ArraySlice` resolves to `never` when passing `number` HOT 2
- `EmptyArray` type HOT 2
- Suggestion to include documetation on `Awaited` Type in README
- `OmitDeep` with multiple properties to omit HOT 1
- MergeDeep takes type of property of source instead of using the destination type in case of undefined value
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from type-fest.