Comments (3)
Thanks a lot for the tip @malcolmkiano! I no longer get type error from the original issue.
Do you have any tips to make the TypeScript types a bit easier to work with?
For example, homePage.heroLogo
comes back as Asset<undefined, string> | { sys: AssetLink; }
which means I have to do these kinds of maneuvers before accessing the data inside:
const heroLogo =
'fields' in homePageEntry.heroLogo
? {
src: homePageEntry.heroLogo.fields.file?.url || '',
width: homePageEntry.heroLogo.fields.file?.details.image?.width || 0,
height: homePageEntry.heroLogo.fields.file?.details.image?.height || 0,
}
: null
Is there a way to simplify this?
I'm getting the homePageEntry like this:
const homePageResult = await contentfulClient.getEntries<TypeHomePageSkeleton>({ content_type: 'homePage', include: 2 })
const homePageEntry = homePageResult.items?.[0]?.fields || null
These are the types generated by the CLI:
import type { ChainModifiers, Entry, EntryFieldTypes, EntrySkeletonType, LocaleCode } from "contentful";
export interface TypeHomePageFields {
heroLogo: EntryFieldTypes.AssetLink;
heroTitle: EntryFieldTypes.Symbol;
heroText: EntryFieldTypes.Text;
descriptionText: EntryFieldTypes.RichText;
descriptionImage?: EntryFieldTypes.AssetLink;
}
export type TypeHomePageSkeleton = EntrySkeletonType<TypeHomePageFields, "homePage">;
export type TypeHomePage<Modifiers extends ChainModifiers, Locales extends LocaleCode> = Entry<TypeHomePageSkeleton, Modifiers, Locales>;
from cf-content-types-generator.
You should provide the -X
flag when running the command to generate types that satisfy the V10 requirements. This will probably end up being the default behavior at some point in the future:
cf-content-types-generator --spaceId $CONTENTFUL_SPACE_ID --token $CONTENTFUL_MANAGEMENT_TOKEN -o src/contentful-types -X
from cf-content-types-generator.
@malcolmkiano thanks for resolving this 🎉
from cf-content-types-generator.
Related Issues (20)
- TypeError: context.getFieldRenderer(...) is not a function HOT 7
- Usage with v10? HOT 3
- Syntax error created from type generation HOT 2
- generated type guards can not be used when imported from index HOT 2
- Missing imports with --v10 and --out HOT 1
- Request for LICENSE file HOT 1
- Property 'fields' does not exist on type 'EntryLink' HOT 3
- Generated fields types does not satisfy the EntrySkeletonType<FieldsType, string> constraint HOT 1
- v10 typing includes EntryFieldTypes, but mismatches actual API response HOT 4
- "Type does not satisfy the constraint 'EntrySkeletonType'." HOT 7
- Type error after Contentful `10.0.0-beta-v10.32` HOT 4
- oclif dependencies are deprecated HOT 2
- How to actually use fields? HOT 13
- Use with Contentful GraphQL endpoint? HOT 1
- 2.12.3 introduces bug HOT 2
- Property does not exist on type {} | {} HOT 2
- Include description and help text in JSDoc comments? HOT 5
- Support a config file
- Support custom prefixes of generics and interfaces HOT 2
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 cf-content-types-generator.